Jump to content

Template:FunctionInfo: Difference between revisions

From CMM Wiki
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__


[[CMM]]
{| class="wikitable" style="width:80%; border:none; margin-top:0;"
|+ style="caption-side:top; text-align:left; padding:0;" | [[CMM]]


{| class="wikitable" style="width:80%; border:none"
|-
|-
! width="15%" | <font size="3">Environment:</font>
! width="15%" | <font size="3">Environment:</font>
! colspan="2" style="text-align:left";" | '''<font size="3">Mission Scripting</font>'''
| colspan="2" style="text-align:left;" | '''<font size="3">Mission Scripting</font>'''
 
|-
|-
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| colspan="3" style="height:10px; background-color:#5C7A4A; border:none;" |
|-style="border-style:hidden"
 
|-
|-
! width="15%" | <font size="3">Function:</font>
! width="15%" | <font size="3">Function:</font>
! colspan="2" style="text-align:left";" | '''<font size="4">{{{fName}}}</font>'''
| colspan="2" style="text-align:left;" | '''<font size="4">{{{fName|}}}</font>'''
 
|-
|-
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| colspan="3" style="height:10px; background-color:#5C7A4A; border:none;" |
|-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>
! colspan="2" style="text-align:left";" | {{{parentFile}}}
| colspan="2" style="text-align:left;" | {{{parentFile|}}}
 
|-
|-
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| colspan="3" style="height:10px; background-color:#5C7A4A; border:none;" |
|-style="border-style:hidden"
 
|-
|-
! style="text-align:right; vertical-align:top" |<font size="3"> Syntax:
! style="text-align:right; vertical-align:top;" | <font size="3">Syntax:</font>
! 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}}}'' }} </span> <span style="color:green"> {{#if:{{{optType1|}}}|'''{{{optType1}}}''' ''{{{optName1}}}'' }} {{#if:{{{optType2|}}}|''', {{{optType2}}}''' ''{{{optName2}}}'' }} {{#if:{{{optType3|}}}|''', {{{optType3}}}''' ''{{{optName3}}}'' }} {{#if:{{{optType4|}}}|''', {{{optType4}}}''' ''{{{optName4}}}'' }} {{#if:{{{optType5|}}}|''', {{{optType5}}}''' ''{{{optName5}}}'' }} {{#if:{{{optType6|}}}|''', {{{optType6}}}''' ''{{{optName6}}}'' }} {{#if:{{{optType7|}}}|''',{{{optType7}}}''' ''{{{optName7}}}''}} {{#if:{{{optType8|}}}|''', {{{optType8}}}''' ''{{{optName8}}}''}} {{#if:{{{optType9|}}}|''', {{{optType9}}}''' ''{{{optName9}}}'' }} {{#if:{{{optType10|}}}|''', {{{optType10}}}''' ''{{{optName10}}}'' }} {{#if:{{{optType11|}}}|''', {{{optType11}}}''' ''{{{optName11}}}'' }} </span> ''')''' </font>
| colspan="2" style="text-align:left;" | <font size="3">
  {{#if: {{{syntax|}}} |
    {{{syntax}}} |
    <span style="color:orange"> {{{envType|}}}</span>.{{{fName|}}} <span style="color:blue">'''(''')'''</span>
  }}
</font>
 
|-
|-
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| colspan="3" style="height:10px; background-color:#5C7A4A; border:none;" |
|-style="border-style:hidden"
 
|-
|-
! style="text-align:right; vertical-align:top" |<font size="3">Return Value: </font>
! style="text-align:right; vertical-align:top;" | <font size="3">Return Value:</font>
! colspan="2" style="text-align:left" | {{{return}}}
| colspan="2" style="text-align:left;" | {{{return|}}}{{#if:{{{returnDesc|}}}| — {{{returnDesc}}}}}
 
|-
|-
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| colspan="3" style="height:10px; background-color:#5C7A4A; border:none;" |
|-style="border-style:hidden; text-align:right; vertical-align:top"
 
<!-- Parameters -->
|-
|-
! style="text-align:right; vertical-align:top;" | <font size="3">Parameters:</font>
! Name
! Description


<!-- Parameters table -->
<!-- Required params (1..12) -->
{{#if: {{{reqName1|}}} |
|-
|
| '''{{{reqName1}}}''' <span style="color:#888">({{{reqType1|}}})</span>
| {{{desc1|}}}
}}
{{#if: {{{reqName2|}}} |
|-
|
| '''{{{reqName2}}}''' <span style="color:#888">({{{reqType2|}}})</span>
| {{{desc2|}}}
}}
{{#if: {{{reqName3|}}} |
|-
|
| '''{{{reqName3}}}''' <span style="color:#888">({{{reqType3|}}})</span>
| {{{desc3|}}}
}}
{{#if: {{{reqName4|}}} |
|-
|
| '''{{{reqName4}}}''' <span style="color:#888">({{{reqType4|}}})</span>
| {{{desc4|}}}
}}
{{#if: {{{reqName5|}}} |
|-
|
| '''{{{reqName5}}}''' <span style="color:#888">({{{reqType5|}}})</span>
| {{{desc5|}}}
}}
{{#if: {{{reqName6|}}} |
|-
|
| '''{{{reqName6}}}''' <span style="color:#888">({{{reqType6|}}})</span>
| {{{desc6|}}}
}}
{{#if: {{{reqName7|}}} |
|-
|
| '''{{{reqName7}}}''' <span style="color:#888">({{{reqType7|}}})</span>
| {{{desc7|}}}
}}
{{#if: {{{reqName8|}}} |
|-
|
| '''{{{reqName8}}}''' <span style="color:#888">({{{reqType8|}}})</span>
| {{{desc8|}}}
}}
{{#if: {{{reqName9|}}} |
|-
|
| '''{{{reqName9}}}''' <span style="color:#888">({{{reqType9|}}})</span>
| {{{desc9|}}}
}}
{{#if: {{{reqName10|}}} |
|-
|
| '''{{{reqName10}}}''' <span style="color:#888">({{{reqType10|}}})</span>
| {{{desc10|}}}
}}
{{#if: {{{reqName11|}}} |
|-
|
| '''{{{reqName11}}}''' <span style="color:#888">({{{reqType11|}}})</span>
| {{{desc11|}}}
}}
{{#if: {{{reqName12|}}} |
|-
|
| '''{{{reqName12}}}''' <span style="color:#888">({{{reqType12|}}})</span>
| {{{desc12|}}}
}}


<!-- Row Headings -->
<!-- Optional params (1..12) -->
! rowspan="0" style="text-align:right; vertical-align:top; | <font size="3">Parameters: </font></span>
{{#if: {{{optName1|}}} |
! Name </span>
|-
! Description
|
| '''{{{optName1}}}''' <span style="color:#888">({{{optType1|}}})</span>
| {{{desc1|}}}
}}
{{#if: {{{optName2|}}} |
|-
|
| '''{{{optName2}}}''' <span style="color:#888">({{{optType2|}}})</span>
| {{{desc2|}}}
}}
{{#if: {{{optName3|}}} |
|-
|
| '''{{{optName3}}}''' <span style="color:#888">({{{optType3|}}})</span>
| {{{desc3|}}}
}}
{{#if: {{{optName4|}}} |
|-
|
| '''{{{optName4}}}''' <span style="color:#888">({{{optType4|}}})</span>
| {{{desc4|}}}
}}
{{#if: {{{optName5|}}} |
|-
|
| '''{{{optName5}}}''' <span style="color:#888">({{{optType5|}}})</span>
| {{{desc5|}}}
}}
{{#if: {{{optName6|}}} |
|-
|
| '''{{{optName6}}}''' <span style="color:#888">({{{optType6|}}})</span>
| {{{desc6|}}}
}}
{{#if: {{{optName7|}}} |
|-
|
| '''{{{optName7}}}''' <span style="color:#888">({{{optType7|}}})</span>
| {{{desc7|}}}
}}
{{#if: {{{optName8|}}} |
|-
|
| '''{{{optName8}}}''' <span style="color:#888">({{{optType8|}}})</span>
| {{{desc8|}}}
}}
{{#if: {{{optName9|}}} |
|-
|
| '''{{{optName9}}}''' <span style="color:#888">({{{optType9|}}})</span>
| {{{desc9|}}}
}}
{{#if: {{{optName10|}}} |
|-
|-
<!-- Row 1 -->
|
 
| '''{{{optName10}}}''' <span style="color:#888">({{{optType10|}}})</span>
{{#if: {{{reqName1|}}} <tr><td>'''{{{reqName1|}}}'''</td><td>{{{desc1|}}}</td></tr> }}
| {{{desc10|}}}
{{#if: {{{reqName2|}}} <tr><td>'''{{{reqName2|}}}'''</td><td>{{{desc2|}}}</td></tr> }}
}}
{{#if: {{{reqName3|}}} <tr><td>'''{{{reqName3|}}}'''</td><td>{{{desc3|}}}</td></tr> }}
{{#if: {{{optName11|}}} |
{{#if: {{{reqName4|}}} <tr><td>'''{{{reqName4|}}}'''</td><td>{{{desc4|}}}</td></tr> }}
{{#if: {{{reqName5|}}} <tr><td>'''{{{reqName5|}}}'''</td><td>{{{desc5|}}}</td></tr> }}
{{#if: {{{reqName6|}}} <tr><td>'''{{{reqName6|}}}'''</td><td>{{{desc6|}}}</td></tr> }}
{{#if: {{{reqName7|}}} <tr><td>'''{{{reqName7|}}}'''</td><td>{{{desc7|}}}</td></tr> }}
{{#if: {{{reqName8|}}} <tr><td>'''{{{reqName8|}}}'''</td><td>{{{desc8|}}}</td></tr> }}
{{#if: {{{reqName9|}}} <tr><td>'''{{{reqName9|}}}'''</td><td>{{{desc9|}}}</td></tr> }}
{{#if: {{{reqName10|}}} <tr><td>'''{{{reqName10|}}}'''</td><td>{{{desc10|}}}</td></tr> }}
{{#if: {{{reqName11|}}} <tr><td>'''{{{reqName11|}}}'''</td><td>{{{desc11|}}}</td></tr> }}
{{#if: {{{reqName12|}}} <tr><td>'''{{{reqName12|}}}'''</td><td>{{{desc12|}}}</td></tr> }}
{{#if: {{{optName1|}}} <tr><td>'''{{{optName1|}}}'''</td><td>{{{desc1|}}}</td></tr> }}
{{#if: {{{optName2|}}} <tr><td>'''{{{optName2|}}}'''</td><td>{{{desc2|}}}</td></tr> }}
{{#if: {{{optName3|}}} <tr><td>'''{{{optName3|}}}'''</td><td>{{{desc3|}}}</td></tr> }}
{{#if: {{{optName4|}}} <tr><td>'''{{{optName4|}}}'''</td><td>{{{desc4|}}}</td></tr> }}
{{#if: {{{optName5|}}} <tr><td>'''{{{optName5|}}}'''</td><td>{{{desc5|}}}</td></tr> }}
{{#if: {{{optName6|}}} <tr><td>'''{{{optName6|}}}'''</td><td>{{{desc6|}}}</td></tr> }}
{{#if: {{{optName7|}}} <tr><td>'''{{{optName7|}}}'''</td><td>{{{desc7|}}}</td></tr> }}
{{#if: {{{optName8|}}} <tr><td>'''{{{optName8|}}}'''</td><td>{{{desc8|}}}</td></tr> }}
{{#if: {{{optName9|}}} <tr><td>'''{{{optName9|}}}'''</td><td>{{{desc9|}}}</td></tr> }}
{{#if: {{{optName10|}}} <tr><td>'''{{{optName10|}}}'''</td><td>{{{desc10|}}}</td></tr> }}
{{#if: {{{optName11|}}} <tr><td>'''{{{optName11|}}}'''</td><td>{{{desc11|}}}</td></tr> }}
{{#if: {{{optName12|}}} <tr><td>'''{{{optName12|}}}'''</td><td>{{{desc12|}}}</td></tr> }}
|-
|-
<!-- end parameter table -->
|
| '''{{{optName11}}}''' <span style="color:#888">({{{optType11|}}})</span>
| {{{desc11|}}}
}}
{{#if: {{{optName12|}}} |
|-
|-
|
| '''{{{optName12}}}''' <span style="color:#888">({{{optType12|}}})</span>
| {{{desc12|}}}
}}
|-
|-
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| colspan="3" style="height:10px; background-color:#5C7A4A; border:none;" |
|-style="border-style:hidden"
 
|-
|-
! style="text-align:right; vertical-align:top" |<font size="3">Example:</font>
! style="text-align:right; vertical-align:top;" | <font size="3">Example:</font>
! colspan="2" style="text-align:left; | {{{example}}}
| colspan="2" style="text-align:left;" | {{{example|}}}
 
|-
|-
! style="text-align:right; vertical-align:top" |<font size="3"> Example Description: </font>
! style="text-align:right; vertical-align:top;" | <font size="3">Example Description:</font>
! colspan="2" style="text-align:left;| {{{exampleDesc}}}
| colspan="2" style="text-align:left;" | {{{exampleDesc|}}}
 
|-
|-
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| colspan="3" style="height:10px; background-color:#5C7A4A; border:none;" |
|-style="border-style:hidden"
 
|-
|-
! style="text-align:right; vertical-align:top" |<font size="3">Related Functions: </font>
! style="text-align:right; vertical-align:top;" | <font size="3">Related Functions:</font>
! colspan="2" style="text-align:left; | {{{related}}}
| colspan="2" style="text-align:left;" | {{{related|}}}
 
|-
|-
! style="text-align:right; vertical-align:top" |<font size="3">Notes: </font>
! style="text-align:right; vertical-align:top;" | <font size="3">Notes:</font>
! colspan="2" style="text-align:left; | {{{notes}}}
| colspan="2" style="text-align:left;" | {{{notes|}}}
 
|}
|}
<includeonly>[[Category:LUA|{{{fName}}}]]</includeonly>
 
<includeonly>[[Category:CMM|{{{fName}}}]]</includeonly>
<includeonly>[[Category:LUA|{{{fName|}}}]]</includeonly>
<includeonly>[[Category:CMM|{{{fName|}}}]]</includeonly>

Revision as of 13:24, 23 September 2025


CMM
Environment: Mission Scripting
Function:
Member Of:
Syntax:
  . ()

Return Value:
Parameters: Name Description

- - - - - - - - - - - -

- - - - - - - - - - - -

Example:
Example Description:
Related Functions:
Notes: