Template:FunctionInfo: Difference between revisions
Ozdeadmeat (talk | contribs) No edit summary |
Ozdeadmeat (talk | contribs) No edit summary |
||
| Line 6: | Line 6: | ||
! 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=" | |height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| | ||
|- | |- | ||
! 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> | ||
| Line 14: | Line 14: | ||
! colspan="2" style="text-align:left";" | <font size="2>{{{fDescription}}}</font> | ! colspan="2" style="text-align:left";" | <font size="2>{{{fDescription}}}</font> | ||
|- | |- | ||
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor=" | |height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| | ||
|- | |- | ||
! 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=" | |height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| | ||
|- | |- | ||
! style="text-align:right; vertical-align:top" |<font size="3"> Syntax: | ! 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: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"><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> | ||
|- | |- | ||
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor=" | |height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| | ||
|- | |- | ||
! 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}}} | ||
|- | |- | ||
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor=" | |height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| | ||
|- | |- | ||
<!-- Parameters table --> | <!-- Parameters table --> | ||
| Line 36: | Line 36: | ||
! style="text-align:left" | <font size="3">Description</font> | ! style="text-align:left" | <font size="3">Description</font> | ||
|- | |- | ||
{{#if: {{{reqName1|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{reqName1|}}}'''</td><td>{{{desc1|}}}</td></tr>}} | {{#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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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:{{{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>}} | {{#if:{{{optName12|}}}|<tr><th style="border-style:hidden"></th><td>'''{{{optName12|}}}'''</td><td>{{{desc12|}}}</td></tr>}} | ||
<!-- end parameter table --> | <!-- end parameter table --> | ||
|- | |- | ||
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor=" | |height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| | ||
|- | |- | ||
! style="text-align:right; vertical-align:top" |<font size="3">Example:</font> | ! style="text-align:right; vertical-align:top" |<font size="3">Example:</font> | ||
| Line 70: | Line 70: | ||
! colspan="2" style="text-align:left;|<font size="2"> {{{exampleDesc}}} </font> | ! colspan="2" style="text-align:left;|<font size="2"> {{{exampleDesc}}} </font> | ||
|- | |- | ||
|height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor=" | |height="10" width="80%" style="border-style:hidden" colspan="3" bgcolor="#5C7A4A"| | ||
|- | |- | ||
! 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> | ||
Revision as of 09:29, 24 September 2025
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | {{{fName}}} | |
| Function Description: | {{{fDescription}}} | |
| Member Of: | {{{parentFile}}} | |
| Syntax: | {{{envType}}}.{{{fName}}} ( ) | |
| Return Value: | {{{return}}} | |
| Parameters: | Name | Description |
| Example: | {{{example}}} | |
| Example Description: | {{{exampleDesc}}} | |
| Related Functions: | {{{related}}} | |
| Notes: | {{{notes}}} | |