Jump to content

Template:FunctionInfo: Difference between revisions

From CMM Wiki
No edit summary
No edit summary
Line 3: Line 3:
[[CMM]]
[[CMM]]


{| class="wikitable" style="width:900px; border:none"
{| class="wikitable" style="width:80%; border:none"
 
|-
|-
! width="125" | <font size="4">Environment:</font>
! width="15%" | <font size="3">Environment:</font>
! colspan="2" | '''<font size="4">Mission Scripting</font>'''
! colspan="2" style="text-align:left";" | '''<font size="3">Mission Scripting</font>'''
|-
|-
<!-- |height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| -->
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|-style="border-style:hidden"
|-style="border-style:hidden"
|-
|-
! width="125" | <font size="4">Function:</font>
! width="15%" | <font size="3">Function:</font>
! colspan="2" | '''<font size="4">{{{fName}}}</font>'''
! colspan="2" style="text-align:left";" | '''<font size="4">{{{fName}}}</font>'''
|-
|-
<!-- |height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| -->
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|-style="border-style:hidden"
|-style="border-style:hidden"
|-
|-
! style="text-align:right; vertical-align:top" | <font size="3">Member Of:</font>
! style="text-align:right; vertical-align:top" | <font size="3">Member Of:</font>
| {{{parentFile}}}  
! colspan="2" style="text-align:left";" | {{{parentFile}}}
|-
|-
<!-- |height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| -->
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|-style="border-style:hidden"
|-style="border-style:hidden"
|-
|-
! style="text-align:right; vertical-align:top" | Syntax:
! style="text-align:right; vertical-align:top" |<font size="3"> Syntax:
| colspan="2" |{{{syntax}}}
! colspan="2" style="text-align:left" |<font size="3"><span style="color:orange"> {{{envType}}}</span>.{{{fName}}}<font size="3"><span style="color:blue">'''(''' {{#if:{{{reqType1|}}}|'''{{{reqType1}}}''' ''{{{reqName1}}}'' }} {{#if:{{{reqType2|}}}|''', {{{reqType2}}}''' ''{{{reqName2}}}'' }} {{#if:{{{reqType3|}}}|''', {{{reqType3}}}''' ''{{{reqName3}}}'' }} {{#if:{{{reqType4|}}}|''', {{{reqType4}}}''' ''{{{reqName4}}}'' }} {{#if:{{{reqType5|}}}|''', {{{reqType5}}}''' ''{{{reqName5}}}'' }} {{#if:{{{reqType6|}}}|''', {{{reqType6}}}''' ''{{{reqName6}}}'' }} {{#if:{{{reqType7|}}}|''',{{{reqType7}}}''' ''{{{reqName7}}}''}} {{#if:{{{reqType8|}}}|''', {{{reqType8}}}''' ''{{{reqName8}}}''}} {{#if:{{{reqType9|}}}|''', {{{reqType9}}}''' ''{{{reqName9}}}'' }} {{#if:{{{reqType10|}}}|''', {{{reqType10}}}''' ''{{{reqName10}}}'' }} {{#if:{{{reqType11|}}}|''', {{{reqType11}}}''' ''{{{reqName11}}}'' }} ''')'''</font>
<font size="3"><span style="color:orange">{{{envType}}}</span> .{{{fName}}} <font size="3"><span style="color:blue">'''(''' {{#if:{{{reqType1|}}}|'''{{{reqType1}}}''' ''{{{reqName1}}}'',}} {{#if:{{{reqType2|}}}|'''{{{reqType2}}}''' ''{{{reqName2}}}'',}} {{#if:{{{reqType3|}}}|'''{{{reqType3}}}''' ''{{{reqName3}}}'',}} {{#if:{{{reqType4|}}}|'''{{{reqType4}}}''' ''{{{reqName4}}}'',}} {{#if:{{{reqType5|}}}|'''{{{reqType5}}}''' ''{{{reqName5}}}'',}} {{#if:{{{reqType6|}}}|'''{{{reqType6}}}''' ''{{{reqName6}}}'',}} {{#if:{{{reqType7|}}}|'''{{{reqType7}}}''' ''{{{reqName7}}}'',}} {{#if:{{{reqType8|}}}|'''{{{reqType8}}}''' ''{{{reqName8}}}'',}} {{#if:{{{reqType9|}}}|'''{{{reqType9}}}''' ''{{{reqName9}}}'',}} {{#if:{{{reqType10|}}}|'''{{{reqType10}}}''' ''{{{reqName10}}}'',}} {{#if:{{{reqType11|}}}|'''{{{reqType11}}}''' ''{{{reqName11}}}'',}} ''')'''
|-
|-
<!-- |height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| -->
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|-style="border-style:hidden"
|-style="border-style:hidden"
|-
|-
! style="text-align:right; vertical-align:top" | Return Value:
! style="text-align:right; vertical-align:top" |<font size="3">Return Value: </font>
| colspan="2" | {{{return}}}
! colspan="2" style="text-align:left" | {{{return}}}
|-
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|-style="border-style:hidden; text-align:right; vertical-align:top"
|-
 
<!-- Parameters table -->
 
<!-- Row Headings -->
! rowspan="12" style="text-align:right; vertical-align:top; | <span style="color:green"> <font size="3">Parameters: </font></span>
! width="15%"<span style="color:green"> | Name </span>
! style="color:green"> | Description </span>
|-
<!-- Row 1 -->
|{{#if:{{{reqName1|}}}|''{{{reqName1}}}'' }}
|{{#if:{{{reqName1|}}}| {{{desc1}}} }}
|-
<!-- Row 2 -->
|{{#if:{{{reqName2|}}}|''{{{reqName2}}}'' }}
|{{#if:{{{reqName2|}}}| {{{desc2}}} }}
|-
<!-- Row 3 -->
|{{#if:{{{reqName3|}}}|''{{{reqName3}}}'' }}
|{{#if:{{{reqName3|}}}|{{{desc3}}} }}
|-
<!-- Row 4 -->
|{{#if:{{{reqName4|}}}|''{{{reqName4}}}'' }}
|{{#if:{{{reqName4|}}}|{{{desc4}}} }}
|-
<!-- Row 5 -->
|{{#if:{{{reqName5|}}}|''{{{reqName5}}}'' }}
|{{#if:{{{reqName5|}}}|{{{desc5}}} }}
|-
<!-- Row 6 -->
|{{#if:{{{reqName6|}}}|''{{{reqName6}}}'' }}
|{{#if:{{{reqName6|}}}|{{{desc6}}} }}
|-
<!-- Row 7 -->
|{{#if:{{{reqName7|}}}|''{{{reqName7}}}'' }}
|{{#if:{{{reqName7|}}}|{{{desc7}}} }}
|-
<!-- Row 8 -->
|{{#if:{{{reqName8|}}}|''{{{reqName8}}}'' }}
|{{#if:{{{reqName8|}}}|{{{desc8}}}  }}
|-
<!-- Row9 -->
|{{#if:{{{reqName9|}}}|''{{{reqName9}}}'' }}
|{{#if:{{{reqName9|}}}|{{{desc9}}} }}
|-
<!-- Row 10 -->
|{{#if:{{{reqName10|}}}|''{{{reqName10}}}'' }}
|{{#if:{{{reqName10|}}}|{{{desc10}}} }}
|-
<!-- Row 11 -->
|{{#if:{{{reqName11|}}}|''{{{reqName11}}}'' }}
|{{#if:{{{reqName11|}}}|{{{desc11}}}  }}
|-
<!-- end parameter table -->
|-
|-
! style="text-align:right; vertical-align:top" | Return Example:
| colspan="2" | {{{returnDesc}}}
|-
|-
<!-- |height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| -->
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|-style="border-style:hidden"
|-style="border-style:hidden"
|-
|-
! style="text-align:right; vertical-align:top" | Example:
! style="text-align:right; vertical-align:top" |<font size="3">Example:</font>
| colspan="3" | <font>'''<span style="color:green">'''{{{example}}} </span> </font>
! colspan="2" style="text-align:left; | {{{example}}}
|-
|-
! style="text-align:right; vertical-align:top" | Example Description:
! style="text-align:right; vertical-align:top" |<font size="3"> Example Description: </font>
| colspan="3" | <font>'''<span style="color:green">'''{{{exampleDesc}}} </span> </font>
! colspan="2" style="text-align:left;| {{{exampleDesc}}}
|-
|-
<!-- |height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| -->
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|height="10" width="900" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|-style="border-style:hidden"
|-style="border-style:hidden"
|-
|-
! style="text-align:right; vertical-align:top" | Related Functions:
! style="text-align:right; vertical-align:top" |<font size="3">Related Functions: </font>
| colspan="2" | {{{related}}}
! colspan="2" style="text-align:left; | {{{related}}}
|-
|-
! style="text-align:right; vertical-align:top" | Notes:
! style="text-align:right; vertical-align:top" |<font size="3">Notes: </font>
| colspan="2" | {{{notes}}}
! colspan="2" style="text-align:left; | {{{notes}}}
|}
|}
<includeonly>[[Category:LUA|{{{fName}}}]]</includeonly>
<includeonly>[[Category:LUA|{{{fName}}}]]</includeonly>
<includeonly>[[Category:CMM|{{{fName}}}]]</includeonly>
<includeonly>[[Category:CMM|{{{fName}}}]]</includeonly>

Revision as of 10:37, 17 September 2025


CMM

Environment: Mission Scripting
Function: {{{fName}}}
Member Of: {{{parentFile}}}
Syntax: {{{envType}}}.{{{fName}}}( )
Return Value: {{{return}}}
Parameters: Name Description
Example: {{{example}}}
Example Description: {{{exampleDesc}}}
Related Functions: {{{related}}}
Notes: {{{notes}}}