Jump to content

Template:FunctionInfo: Difference between revisions

From CMM Wiki
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{| class="wikitable" style="width:80%; border:none; margin-top:0;"
 
{| class="wikitable" style="width:80%; border:none"
|+ style="caption-side:top; text-align:left; padding:0;" | [[CMM]]
|+ style="caption-side:top; text-align:left; padding:0;" | [[CMM]]
|-
|-
! width="15%" style="text-align:right; vertical-align:top;" | <font size="3">Environment:</font>
! width="15%" style="text-align:right; vertical-align:top" | <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>'''
 
|-
|-
| colspan="3" style="height:10px; background-color:lightGreen; border:none;" |
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
 
|-style="border-style:hidden"
|-
|-
! width="15%" style="text-align:right; vertical-align:top;" | <font size="3">Function:</font>
! width="15%" style="text-align:right; vertical-align:top"| <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>'''
 
|-
|-
| colspan="3" style="height:10px; background-color:lightGreen; border:none;" |
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
 
|-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}}}
 
|-
|-
| colspan="3" style="height:10px; background-color:lightGreen; border:none;" |
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
 
|-style="border-style:hidden"
|-
|-
! style="text-align:right; vertical-align:top;" | <font size="3">Syntax:</font>
! style="text-align:right; vertical-align:top" |<font size="3"> Syntax:
| colspan="2" style="text-align:left;" | <font size="3">
! 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>
  <span style="color:orange">{{{envType|}}}</span>.{{{fName|}}}
  <span style="color:blue">'''('''</span>
  <span>
    {{#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 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>
  </span>
  <span style="color:blue">''')'''</span>
</font>
 
|-
|-
| colspan="3" style="height:10px; background-color:lightGreen; border:none;" |
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
 
|-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}}}
 
|-
|-
| colspan="3" style="height:10px; background-color:lightGreen; border:none;" |
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
 
|-style="border-style:hidden; text-align:right; vertical-align:top"
<!-- Parameters -->
|-
|-
! style="text-align:right; vertical-align:top;" | <font size="3">Parameters:</font>
<!-- Parameters table -->
! style="text-align:left;" | <font size="3">Name</font>
! style="text-align:right" |<font size="3">Parameters:</font>
! style="text-align:left;" | <font size="3">Description</font>
! style="text-align:left" | <font size="3">Name</font>
 
! style="text-align:left" | <font size="3">Description</font>
<!-- 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|}}}|
|-
|-
|
{{#if: {{{reqName1|}}} <tr><td>'''{{{reqName1|}}}'''</td><td>{{{desc1|}}}</td></tr> }}
| '''{{{reqName4}}}''' <span style="color:#888">({{{reqType4|}}})</span>
{{#if: {{{reqName2|}}} <tr><td>'''{{{reqName2|}}}'''</td><td>{{{desc2|}}}</td></tr> }}
| {{{desc4|}}}
{{#if: {{{reqName3|}}} <tr><td>'''{{{reqName3|}}}'''</td><td>{{{desc3|}}}</td></tr> }}
}}
{{#if: {{{reqName4|}}} <tr><td>'''{{{reqName4|}}}'''</td><td>{{{desc4|}}}</td></tr> }}
{{#if:{{{reqName5|}}}|
{{#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 -->
| '''{{{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|}}}
}}
<!-- Optional params (1..12) -->
{{#if:{{{optName1|}}}|
|-
|-
|
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| '''{{{optName1}}}''' <span style="color:#888">({{{optType1|}}})</span>
|-style="border-style:hidden"
| {{{desc1|}}}
}}
{{#if:{{{optName2|}}}|
|-
|-
|
! style="text-align:right; vertical-align:top" |<font size="3">Example:</font>
| '''{{{optName2}}}''' <span style="color:#888">({{{optType2|}}})</span>
! colspan="2" style="text-align:left; |<font size="2"> {{{example}}} </font>
| {{{desc2|}}}
}}
{{#if:{{{optName3|}}}|
|-
|-
|
! style="text-align:right; vertical-align:top" |<font size="3"> Example Description: </font>
| '''{{{optName3}}}''' <span style="color:#888">({{{optType3|}}})</span>
! colspan="2" style="text-align:left;|<font size="2"> {{{exampleDesc}}} </font>
| {{{desc3|}}}
}}
{{#if:{{{optName4|}}}|
|-
|-
|
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| '''{{{optName4}}}''' <span style="color:#888">({{{optType4|}}})</span>
|-style="border-style:hidden"
| {{{desc4|}}}
}}
{{#if:{{{optName5|}}}|
|-
|-
|
! style="text-align:right; vertical-align:top" |<font size="3">Related Functions: </font>
| '''{{{optName5}}}''' <span style="color:#888">({{{optType5|}}})</span>
! colspan="2" style="text-align:left; |<font size="2"> {{{related}}}</font>
| {{{desc5|}}}
}}
{{#if:{{{optName6|}}}|
|-
|-
|
! style="text-align:right; vertical-align:top" |<font size="3">Notes: </font>
| '''{{{optName6}}}''' <span style=
! colspan="2" style="text-align:left; | <font size="2"> {{{notes}}} </font>
|}
<includeonly>[[Category:LUA|{{{fName}}}]]</includeonly>
<includeonly>[[Category:CMM|{{{fName}}}]]</includeonly>

Revision as of 13:46, 23 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}}}