Jump to content

Template:FunctionInfo: Difference between revisions

From CMM Wiki
← Older edit
Ozdeadmeat (talk | contribs)
Bureaucrats, Interface administrators, Administrators
5,575 edits
No edit summary
No edit summary
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{| class="wikitable" style="width:80%; border:none"
{| class="wikitable" style="width:100%; border:none"
|+ style="caption-side:top; text-align:left; padding:0;" | [[CMM]]
|+ style="caption-side:top; text-align:left; padding:0;" | [[Special:AllPages|Return to CMM Command Reference]]
|-
|-
! width="15%" style="text-align:right; vertical-align:top" | <span style="font-size:1.1em;">Environment:</span>
! width="15%" style="text-align:right; vertical-align:top" | <font size="3">Environment:</font>
| colspan="2" style="text-align:left" | '''<span style="font-size:1.1em;">Mission Scripting</span>'''
! colspan="2" style="text-align:left";" | '''<font size="3">Mission Scripting</font>'''
|-
|-
| height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A" |
|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>
! colspan="2" style="text-align:left";" | '''<font size="4">{{{fName}}}</font>'''
|-
|-
! width="15%" style="text-align:right; vertical-align:top" | <span style="font-size:1.1em;">Function:</span>
! width="15%" style="text-align:right; vertical-align:top"| <font size="3">Function Description:</font>
| colspan="2" style="text-align:left" | '''<span style="font-size:1.2em;">{{{fName}}}</span>'''
! colspan="2" style="text-align:left";" | <font size="2>{{{fDescription}}}</font>
|-
|-
| height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A" |
|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">File Location:</font>
! colspan="2" style="text-align:left";" | {{{parentFile}}}
|-
|-
! style="text-align:right; vertical-align:top" | <span style="font-size:1.1em;">Member Of:</span>
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
| colspan="2" style="text-align:left" | {{{parentFile|}}}
|-
|-
| height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A" |
! style="text-align:right; vertical-align:top" |<font size="3"> Syntax:
! colspan="2" style="text-align:left" |<font size="3"><span style="color:orange"> {{{envType}}}</span>.{{{fName}}}<font size="3">'''(''' <span style="color:#0b48d6"> {{#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>
|-
|-
|- style="border-style:hidden"
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|-
|-
! style="text-align:right; vertical-align:top" | <span style="font-size:1.1em;">Syntax:</span>
! style="text-align:right; vertical-align:top" |<font size="3">Return Value: </font>
| colspan="2" style="text-align:left" |
! colspan="2" style="text-align:left" | {{{return}}}
<span style="font-size:1.05em;">
  <span style="color:orange;">{{{envType|}}}</span>.{{{fName|}}}'''('''
  <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>''')''
</span>
|-
|-
| height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A" |
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"|
|-
|-
|- style="border-style:hidden"
<!-- Parameters table -->
! style="text-align:right" | <font size="3">Parameters:</font>
! style="text-align:left" | <font size="3">Name</font>
! style="text-align:left" | <font size="3">Description</font>
|-
|-
! style="text-align:right; vertical-align:top" | <span style="font-size:1.1em;">Return Value:</span>
{{#if:{{{reqName1|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName1|}}}'''</td><td>{{{desc1|}}}</td></tr>}}{{#if:{{{reqName2|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName2|}}}'''</td><td>{{{desc2|}}}</td></tr>}}{{#if:{{{reqName3|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName3|}}}'''</td><td>{{{desc3|}}}</td></tr>}}{{#if:{{{reqName4|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName4|}}}'''</td><td>{{{desc4|}}}</td></tr>}}{{#if:{{{reqName5|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName5|}}}'''</td><td>{{{desc5|}}}</td></tr>}}{{#if:{{{reqName6|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName6|}}}'''</td><td>{{{desc6|}}}</td></tr>}}{{#if:{{{reqName7|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName7|}}}'''</td><td>{{{desc7|}}}</td></tr>}}{{#if:{{{reqName8|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName8|}}}'''</td><td>{{{desc8|}}}</td></tr>}}{{#if:{{{reqName9|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName9|}}}'''</td><td>{{{desc9|}}}</td></tr>}}{{#if:{{{reqName10|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName10|}}}'''</td><td>{{{desc10|}}}</td></tr>}}{{#if:{{{reqName11|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName11|}}}'''</td><td>{{{desc11|}}}</td></tr>}}{{#if:{{{reqName12|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName12|}}}'''</td><td>{{{desc12|}}}</td></tr>}}{{#if:{{{optName1|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName1|}}}'''</td><td>{{{desc1|}}}</td></tr>}}{{#if:{{{optName2|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName2|}}}'''</td><td>{{{desc2|}}}</td></tr>}}{{#if:{{{optName3|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName3|}}}'''</td><td>{{{desc3|}}}</td></tr>}}{{#if:{{{optName4|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName4|}}}'''</td><td>{{{desc4|}}}</td></tr>}}{{#if:{{{optName5|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName5|}}}'''</td><td>{{{desc5|}}}</td></tr>}}{{#if:{{{optName6|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName6|}}}'''</td><td>{{{desc6|}}}</td></tr>}}{{#if:{{{optName7|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName7|}}}'''</td><td>{{{desc7|}}}</td></tr>}}{{#if:{{{optName8|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName8|}}}'''</td><td>{{{desc8|}}}</td></tr>}}{{#if:{{{optName9|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName9|}}}'''</td><td>{{{desc9|}}}</td></tr>}}{{#if:{{{optName10|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName10|}}}'''</td><td>{{{desc10|}}}</td></tr>}}{{#if:{{{optName11|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName11|}}}'''</td><td>{{{desc11|}}}</td></tr>}}{{#if:{{{optName12|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName12|}}}'''</td><td>{{{desc12|}}}</td></tr>}}
| colspan="2" style="text-align:left" | {{{return|}}}
<!-- end parameter table -->
|-
|-
| height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A" |
|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">Example:</font>
! colspan="2" style="text-align:left; |<font size="2"> {{{example}}} </font>
|-
|-
! style="text-align:right" | <span style="font-size:1.1em;">Parameters:</span>
! style="text-align:right; vertical-align:top" |<font size="3"> Example Description:</font>
! style="text-align:left" | <span style="font-size:1.1em;">Name</span>
! colspan="2" style="text-align:left;|<font size="2"> {{{exampleDesc}}} </font>
! style="text-align:left" | <span style="font-size:1.1em;">Description</span>
<!-- Required params -->
{{#if:{{{reqName1|}}}| |  || '''{{{reqName1}}}''' || {{{desc1|}}}
}}
{{#if:{{{reqName2|}}}| |  || '''{{{reqName2}}}''' || {{{desc2|}}}
}}
{{#if:{{{reqName3|}}}| |  || '''{{{reqName3}}}''' || {{{desc3|}}}
}}
{{#if:{{{reqName4|}}}| |  || '''{{{reqName4}}}''' || {{{desc4|}}}
}}
{{#if:{{{reqName5|}}}| |  || '''{{{reqName5}}}''' || {{{desc5|}}}
}}
{{#if:{{{reqName6|}}}| |  || '''{{{reqName6}}}''' || {{{desc6|}}}
}}
{{#if:{{{reqName7|}}}| |  || '''{{{reqName7}}}''' || {{{desc7|}}}
}}
{{#if:{{{reqName8|}}}| |  || '''{{{reqName8}}}''' || {{{desc8|}}}
}}
{{#if:{{{reqName9|}}}| |  || '''{{{reqName9}}}''' || {{{desc9|}}}
}}
{{#if:{{{reqName10|}}}| |  || '''{{{reqName10}}}''' || {{{desc10|}}}
}}
{{#if:{{{reqName11|}}}| |  || '''{{{reqName11}}}''' || {{{desc11|}}}
}}
{{#if:{{{reqName12|}}}| |  || '''{{{reqName12}}}''' || {{{desc12|}}}
}}
<!-- Optional params -->
{{#if:{{{optName1|}}}| |  || '''{{{optName1}}}''' || {{{optDesc1|}}}
}}
{{#if:{{{optName2|}}}| |  || '''{{{optName2}}}''' || {{{optDesc2|}}}
}}
{{#if:{{{optName3|}}}| |  || '''{{{optName3}}}''' || {{{optDesc3|}}}
}}
{{#if:{{{optName4|}}}| |  || '''{{{optName4}}}''' || {{{optDesc4|}}}
}}
{{#if:{{{optName5|}}}| |  || '''{{{optName5}}}''' || {{{optDesc5|}}}
}}
{{#if:{{{optName6|}}}| |  || '''{{{optName6}}}''' || {{{optDesc6|}}}
}}
{{#if:{{{optName7|}}}| |  || '''{{{optName7}}}''' || {{{optDesc7|}}}
}}
{{#if:{{{optName8|}}}| |  || '''{{{optName8}}}''' || {{{optDesc8|}}}
}}
{{#if:{{{optName9|}}}| |  || '''{{{optName9}}}''' || {{{optDesc9|}}}
}}
{{#if:{{{optName10|}}}| |  || '''{{{optName10}}}''' || {{{optDesc10|}}}
}}
{{#if:{{{optName11|}}}| |  || '''{{{optName11}}}''' || {{{optDesc11|}}}
}}
{{#if:{{{optName12|}}}| |  || '''{{{optName12}}}''' || {{{optDesc12|}}}
}}
|-
|-
| height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A" |
|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">Related Functions:</font>
! colspan="2" style="text-align:left; |<font size="2">  {{{related|}}} </font>
|-
|-
! style="text-align:right; vertical-align:top" | <span style="font-size:1.1em;">Example:</span>
! style="text-align:right; vertical-align:top" |<font size="3">Notes:</font>
| colspan="2" style="text-align:left" | <span style="font-size:0.95em;">{{{example|}}}</span>
! colspan="2" style="text-align:left; | <font size="2"> {{{note|}}} </font>
|-
! style="text-align:right; vertical-align:top" | <span style="font-size:1.1em;">Example Description:</span>
| colspan="2" style="text-align:left" | <span style="font-size:0.95em;">{{{exampleDesc|}}}</span>
|-
| height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A" |
|-
|- style="border-style:hidden"
|-
! style="text-align:right; vertical-align:top" | <span style="font-size:1.1em;">Related Functions:</span>
| colspan="2" style="text-align:left" | <span style="font-size:0.95em;">{{{related|}}}</span>
|-
! style="text-align:right; vertical-align:top" | <span style="font-size:1.1em;">Notes:</span>
| colspan="2" style="text-align:left" | <span style="font-size:0.95em;">{{{notes|}}}</span>
|}
|}
<includeonly>[[Category:LUA|{{{fName|}}}]]</includeonly>
<includeonly>[[Category:CMM|{{{fName}}}]]</includeonly>
<includeonly>[[Category:CMM|{{{fName|}}}]]</includeonly>

Latest revision as of 09:51, 11 November 2025

Return to CMM Command Reference
Environment: Mission Scripting
Function: {{{fName}}}
Function Description: {{{fDescription}}}
File Location: {{{parentFile}}}
Syntax: {{{envType}}}.{{{fName}}}( )
Return Value: {{{return}}}
Parameters: Name Description
Example: {{{example}}}
Example Description: {{{exampleDesc}}}
Related Functions:
Notes:
Retrieved from "https://cmm.ozdeadmeat.com/index.php?title=Template:FunctionInfo&oldid=5698"