RV – Template
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Fix?) |
Lou Montana (talk | contribs) m (Add HTML anchors + Let CSS deal with messagebox colour now :-) |
||
Line 36: | Line 36: | ||
-->{{#if:{{{mp|}}}| | -->{{#if:{{{mp|}}}| | ||
<dt>Multiplayer:</dt> | <dt id="Multiplayer">Multiplayer:</dt> | ||
<dd>{{{mp}}}</dd>}}<!-- | <dd>{{{mp}}}</dd>}}<!-- | ||
-->{{#if:{{{pr|}}}| | -->{{#if:{{{pr|}}}| | ||
<dt>Problem(s):</dt> | <dt id="Problems">Problem(s):</dt> | ||
<dd>{{{pr}}}</dd>}}<!-- | <dd>{{{pr}}}</dd>}}<!-- | ||
--><h3>Syntax</h3> | --><h3>Syntax</h3> | ||
<dl id="Syntax 1" | <dl> | ||
<dt id="Syntax 1">Syntax:</dt> | |||
<dd>{{{s1|{{{4|'''{{PAGENAMEE}}'''}}}}}}</dd><!-- | <dd>{{{s1|{{{4|'''{{PAGENAMEE}}'''}}}}}}</dd><!-- | ||
-->{{#if:{{{p1|}}}| | -->{{#if:{{{p1|}}}| | ||
<dt>Parameters:</dt> | <dt id="Parameters 1">Parameters:</dt> | ||
<dd>{{{p1}}}</dd> | <dd>{{{p1}}}</dd> | ||
{{#if:{{{p2|}}} | <dd>{{{p2}}}</dd>}} | {{#if:{{{p2|}}} | <dd>{{{p2}}}</dd>}} | ||
Line 73: | Line 73: | ||
-->{{#if:{{{s1|{{{4|}}}}}}| | -->{{#if:{{{s1|{{{4|}}}}}}| | ||
<dt>Return Value:</dt> | <dt id="Return Value 1">Return Value:</dt> | ||
<dd>{{{r1|{{{5|[[Nothing]]}}}}}}</dd> | <dd>{{{r1|{{{5|[[Nothing]]}}}}}}</dd> | ||
</dl>}}<!-- | </dl>}}<!-- | ||
Line 79: | Line 79: | ||
-->{{#if:{{{s2|}}}| | -->{{#if:{{{s2|}}}| | ||
<h3>Alternative Syntax</h3> | <h3>Alternative Syntax</h3> | ||
<dl id="Syntax 2" | <dl> | ||
<dt id="Syntax 2">Syntax:</dt> | |||
<dd>{{{s2}}}</dd><!-- | <dd>{{{s2}}}</dd><!-- | ||
-->{{#if:{{{p21|}}}| | -->{{#if:{{{p21|}}}| | ||
<dt>Parameters:</dt> | <dt id="Parameters 2">Parameters:</dt> | ||
<dd>{{{p21}}}</dd> | <dd>{{{p21}}}</dd> | ||
{{#if:{{{p22|}}} | <dd>{{{p22}}}</dd>}} | {{#if:{{{p22|}}} | <dd>{{{p22}}}</dd>}} | ||
Line 107: | Line 107: | ||
}}<!-- | }}<!-- | ||
--><dt>Return Value:</dt> | --><dt id="Return Value 2">Return Value:</dt> | ||
<dd>{{{r2|[[Nothing]]}}}</dd> | <dd>{{{r2|[[Nothing]]}}}</dd> | ||
</dl>}}<!-- | </dl>}}<!-- | ||
Line 113: | Line 113: | ||
-->{{#if:{{{s3|}}}| | -->{{#if:{{{s3|}}}| | ||
<h3>Alternative Syntax 2</h3> | <h3>Alternative Syntax 2</h3> | ||
<dl id="Syntax 3" | <dl> | ||
<dt id="Syntax 3">Syntax:</dt> | |||
<dd>{{{s3}}}</dd><!-- | <dd>{{{s3}}}</dd><!-- | ||
-->{{#if:{{{p41|}}}| | -->{{#if:{{{p41|}}}| | ||
<dt>Parameters:</dt> | <dt id="Parameters 3">Parameters:</dt> | ||
<dd>{{{p41}}}</dd> | <dd>{{{p41}}}</dd> | ||
{{#if:{{{p42|}}} | <dd>{{{p42}}}</dd>}} | {{#if:{{{p42|}}} | <dd>{{{p42}}}</dd>}} | ||
Line 141: | Line 141: | ||
}}<!-- | }}<!-- | ||
--><dt>Return Value:</dt> | --><dt id="Return Value 3">Return Value:</dt> | ||
<dd>{{{r3|[[Nothing]]}}}</dd> | <dd>{{{r3|[[Nothing]]}}}</dd> | ||
</dl>}}<!-- | </dl>}}<!-- | ||
Line 147: | Line 147: | ||
-->{{#if:{{{s4|}}}| | -->{{#if:{{{s4|}}}| | ||
<h3>Alternative Syntax 3</h3> | <h3>Alternative Syntax 3</h3> | ||
<dl id="Syntax 4" | <dl> | ||
<dt id="Syntax 4">Syntax:</dt> | |||
<dd>{{{s4}}}</dd><!-- | <dd>{{{s4}}}</dd><!-- | ||
-->{{#if:{{{p61|}}}| | -->{{#if:{{{p61|}}}| | ||
<dt>Parameters:</dt> | <dt id="Parameters 4">Parameters:</dt> | ||
<dd>{{{p61}}}</dd> | <dd>{{{p61}}}</dd> | ||
{{#if:{{{p62|}}} | <dd>{{{p62}}}</dd>}} | {{#if:{{{p62|}}} | <dd>{{{p62}}}</dd>}} | ||
Line 175: | Line 175: | ||
}}<!-- | }}<!-- | ||
--><dt>Return Value:</dt> | --><dt id="Return Value 4">Return Value:</dt> | ||
<dd>{{{r4|[[Nothing]]}}}</dd> | <dd>{{{r4|[[Nothing]]}}}</dd> | ||
</dl>}}<!-- | </dl>}}<!-- | ||
Line 181: | Line 181: | ||
-->{{#if:{{{s5|}}}| | -->{{#if:{{{s5|}}}| | ||
<h3>Alternative Syntax 4</h3> | <h3>Alternative Syntax 4</h3> | ||
<dl id="Syntax 5" | <dl> | ||
<dt id="Syntax 5">Syntax:</dt> | |||
<dd>{{{s5}}}</dd><!-- | <dd>{{{s5}}}</dd><!-- | ||
-->{{#if:{{{p81|}}}| | -->{{#if:{{{p81|}}}| | ||
<dt>Parameters:</dt> | <dt id="Parameters 5">Parameters:</dt> | ||
<dd>{{{p81}}}</dd> | <dd>{{{p81}}}</dd> | ||
{{#if:{{{p82|}}} | <dd>{{{p82}}}</dd>}} | {{#if:{{{p82|}}} | <dd>{{{p82}}}</dd>}} | ||
Line 210: | Line 210: | ||
--><dt>Return Value:</dt> | --><dt>Return Value:</dt> | ||
<dd>{{{r5|[[Nothing]]}}}</dd> | <dd id="Return Value 5">{{{r5|[[Nothing]]}}}</dd> | ||
</dl>|}}<!-- | </dl>|}}<!-- | ||
-->{{#if:{{{s6|}}}| | -->{{#if:{{{s6|}}}| | ||
<h3>Alternative Syntax 5</h3> | <h3>Alternative Syntax 5</h3> | ||
<dl id="Syntax 6" | <dl> | ||
<dt id="Syntax 6">Syntax:</dt> | |||
<dd>{{{s6}}}</dd><!-- | <dd>{{{s6}}}</dd><!-- | ||
-->{{#if:{{{p101|}}}| | -->{{#if:{{{p101|}}}| | ||
<dt>Parameters:</dt> | <dt id="Parameters 6">Parameters:</dt> | ||
<dd>{{{p101}}}</dd> | <dd>{{{p101}}}</dd> | ||
{{#if:{{{p102|}}} | <dd>{{{p102}}}</dd>}} | {{#if:{{{p102|}}} | <dd>{{{p102}}}</dd>}} | ||
Line 243: | Line 243: | ||
}}<!-- | }}<!-- | ||
--><dt>Return Value:</dt> | --><dt id="Return Value 6">Return Value:</dt> | ||
<dd>{{{r6|[[Nothing]]}}}</dd> | <dd>{{{r6|[[Nothing]]}}}</dd> | ||
</dl>|}}<!-- | </dl>|}}<!-- | ||
Line 266: | Line 266: | ||
<h3>Additional Information</h3> | <h3>Additional Information</h3> | ||
<dl> | <dl> | ||
<dt>See also:</dt> | <dt id="See Also">See also:</dt> | ||
<dd class="seealso"><!-- | <dd class="seealso"><!-- | ||
-->{{#if:{{{seealso|{{{6|}}}}}} | -->{{#if:{{{seealso|{{{6|}}}}}} | ||
Line 274: | Line 274: | ||
| [[:Category:See also needed|See also needed]] | | [[:Category:See also needed|See also needed]] | ||
}}</dd> | }}</dd> | ||
<dt>Groups:</dt> | <dt id="Groups">Groups:</dt> | ||
<dd class="seealso"><!-- | <dd class="seealso"><!-- | ||
-->{{#if: {{{gr1|}}}{{{gr2|}}}{{{gr3|}}}{{{gr4|}}}{{{gr5|}}} |<!-- | -->{{#if: {{{gr1|}}}{{{gr2|}}}{{{gr3|}}}{{{gr4|}}}{{{gr5|}}} |<!-- | ||
Line 288: | Line 288: | ||
<h3>Notes</h3> | <h3>Notes</h3> | ||
<dd | <dd class="notes"> | ||
{{Messagebox | {{Messagebox | ||
| '''Only post proven facts here.'''<!-- | | '''Only post proven facts here.'''<!-- | ||
--> Report bugs on the [http://feedback.arma3.com/ Feedback Tracker] and discuss on the [https://discord.gg/arma Arma Discord] or on the [https://forums.bohemia.net/ Forums]. | --> Report bugs on the [http://feedback.arma3.com/ Feedback Tracker] and discuss on the [https://discord.gg/arma Arma Discord] or on the [https://forums.bohemia.net/ Forums]. | ||
<div class{{=}}"plainlinks" style{{=}}"margin-top: -0.25em"> | <div class{{=}}"plainlinks" style{{=}}"margin-top: -0.25em"> | ||
[{{canonicalurl:{{FULLPAGENAMEE}}|action=edit§ion=new&preload=Template:Preload/Base&preloadparams%5B%5D=%7B%7Bsubst%3APreload%2FNote%7C%0A%3C%21--%0A%2A%20Write%20your%20comment%20here%20%28remove%20both%20%22arrows%22%20top%20and%20bottom%29%0A%2A%20Equal%20sign%20%22%3D%22%20should%20be%20written%20%7B%7B%3D%7D%7D%0A%2A%20Pipe%20sign%20%22%7C%22%20should%20be%20written%20%7B%7B%21%7D%7D%0A%2A%20New%20lines%20can%20be%20forced%20with%20%3Cbr%3E%0A%2A%20Please%20%27%27%27PREVIEW%20YOUR%20ADDITION%20BEFORE%20SAVING%27%27%27%0A%0A%2A%20Video%20Tutorial%3A%20https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DNtOl1gLz3Fo%0A--%3E%0A%7D%7D&preloadtitle=&summary=New+note&nosummary=true}} | '''[{{canonicalurl:{{FULLPAGENAMEE}}|action=edit§ion=new&preload=Template:Preload/Base&preloadparams%5B%5D=%7B%7Bsubst%3APreload%2FNote%7C%0A%3C%21--%0A%2A%20Write%20your%20comment%20here%20%28remove%20both%20%22arrows%22%20top%20and%20bottom%29%0A%2A%20Equal%20sign%20%22%3D%22%20should%20be%20written%20%7B%7B%3D%7D%7D%0A%2A%20Pipe%20sign%20%22%7C%22%20should%20be%20written%20%7B%7B%21%7D%7D%0A%2A%20New%20lines%20can%20be%20forced%20with%20%3Cbr%3E%0A%2A%20Please%20%27%27%27PREVIEW%20YOUR%20ADDITION%20BEFORE%20SAVING%27%27%27%0A%0A%2A%20Video%20Tutorial%3A%20https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DNtOl1gLz3Fo%0A--%3E%0A%7D%7D&preloadtitle=&summary=New+note&nosummary=true}} + Add Note]''' <span style{{=}}"font-size: .9em">([[How To#Add a new note|Help]])</span> | ||
</div> | </div> | ||
| i | | i | ||
| | | #DDD | ||
}} | }} | ||
</dd> | </dd> |
Revision as of 23:25, 2 February 2021
Real Virtuality Commands/Functions documentation template, used by these pages.
Usage
{{RV|type=|other parameters, see below}}
- meta information:
- type: (named argument, case-insensitive) "command" or "function"
- displayTitle: (Optional, default {{PAGENAMEE}} - encoded page name, i.e with underscores) use to force page's displayTitle (e.g diag_log (Arma 2))
- sortKey: (Optional, default commandName or functionName without BIS/BIN_fnc_ prefix) use to force category's sort key
- primary parameters:
- game1: (can be unnamed parameter 1) short game name - same as Name template input format. e.g ofp, tkoh, arma3, etc.
- version1: (Optional, default empty - unknown; can be unnamed parameter 2) number in GVI template format: <Major>.<Minor>. e.g 1.46, 1.75, 1.86 etc.
- arg: (Optional, default empty) local or global - if provided, will display the LALocal or GAGlobal icon depending on arguments' locality
- eff: (Optional, default empty) local or global - if provided, will display the LELocal or GEGlobal icon depending on effect's locality
- serverExec: (Optional, default empty) if provided, will display the SEServer icon informing the command must be run on the server
- descr: (can be unnamed parameter 3) the command description
- gr1..gr5: (Optional, default empty) Command groups. Case sensitive.
- s1: (Optional, default {{PAGENAMEE}}; can be unnamed parameter 4) command syntax with named parameters. e.g
unit1 setDammage 1
- p1..20: (Optional, default empty) command parameters with description
- r1: (Optional, default Nothing); can be unnamed parameter 5) syntax's return value
- x1..10: (Optional, default {{Example needed}}) command examples (to be put between <code></code> tags where needed)
- seealso: (Optional, default See also needed; can be unnamed param 6) list of related links in wiki format, separated by comma or space. e.g [[setDir]] [[setPos]]
- secondary parameters:
- mp: (Optional, default empty) if provided, will show a Multiplayer note under the description
- pr: (Optional, default empty) if provided, will show a Problems note under the description
- game2..5: (Optional, default empty) same as game1
- version2..5: (Optional, default empty) same as version1, for the corresponding game#
- s2..6: (Optional, default empty) Alternative syntaxes 1 to 5 (see s1)
- p21..120: (Optional, default empty) Alternative syntaxes parameters (20 each: p21..40, p41..60, p61..80, p81..100, p101..120)
- r2..r6: (Optional, default empty) Alternative syntaxes' return value (see r1)
Automatic categories
Command | Function |
---|---|
|
|
Examples
Code | Result |
---|---|
{{RV}} | -no type provided- |
{{RV|type=abc}} | -wrong type provided- |
{{RV|type=command}} | Hover & click on the images for descriptions
Description
Syntax
ExamplesAdditional InformationNotes |
{{RV|type=function}} | Hover & click on the images for descriptions
Description
Syntax
ExamplesAdditional InformationNotes |
{{RV|type=command |game1= ofp |game2= arma1 |game3= arma2 |game4= tkoh |game5= arma3 |version1= 1.00 |version2= 1.00 |version3= 1.00 |version4= 1.00 |version5= 0.50 |arg= local |eff= global |gr1= Object Manipulation |descr= Sets object heading. Angles are measured in degrees clockwise from north, and regular range goes from 0 to 360 (0° {{=}} N, 90° {{=}} E, 180° {{=}} S, 270° {{=}} W). Negative angles represent a counter-clockwise angle. |s1= object '''setDir''' heading |p1= object: [[Object]] |p2= heading: [[Number]] |r1= [[Nothing]] |x1 = <code>unit1 [[setDir]] 45; {{codecomment|// will set unit1 to face North-East}}</code> |x2 = <code>unit1 [[setDir]] -675; {{codecomment|// will also set unit1 to face North-East ({{=}} 45-360-360)}}</code> |x3 = <code>unit1 [[setDir]] 30; unit1 [[setFormDir]] 30;{{codecomment|// needed for AI to keep the given direction}}</code> |seealso= [[getDir]], [[direction]], [[setFormDir]], [[setVectorDir]], [[setVectorDirAndUp]] |mp= See notes below for more details on [[setDir]] behaviour. }} | Hover & click on the images for descriptions
Description
SyntaxExamples
Additional Information
Notes |
{{RV|type=function |game1= arma2 |version1= 1.00 |game2= TKOH |version2= 1.00 |game3= arma3 |version3= 0.50 |eff= local |gr1 = Diagnostic |descr= Shows Function Library viewer, which contains list of all available functions, both official and unofficial. <gallery> Image:Fnc_help.jpg|Arma 2 File:Take On Helicopters Functions Viewer.jpg|Take On Helicopters </gallery> |s1= [parentDisplay] [[call]] [[BIS_fnc_help]] |p1= parentDisplay: [[Display]] - (Optional, default [[displayNull]]) |r1= [[Nothing]] |x1= <code>[] [[call]] [[BIS_fnc_help]];</code> |seealso= [[Arma 2: Functions Library]], [[Arma 3: Functions Library]], [[Take On Helicopters: Function Library]] }} | Hover & click on the images for descriptions
Description
Syntax
Examples
Additional Information
Notes |
Command Template
{{RV|type=command |game1= |game2= |game3= |game4= |game5= |version1= |version2= |version3= |version4= |version5= |arg= |eff= |serverExec= |gr1= |gr2= |gr3= |gr4= |gr5= |descr= |mp= |pr= |s1= |p1= |p2= |p3= |p4= |p5= |p6= |p7= |p8= |p9= |p10= |p11= |p12= |p13= |p14= |p15= |p16= |p17= |p18= |p19= |p20= |r1= |x1= |seealso= }}
Function Template
{{RV|type=function |game1= |game2= |game3= |game4= |game5= |version1= |version2= |version3= |version4= |version5= |arg= |eff= |serverExec= |gr1= |gr2= |gr3= |gr4= |gr5= |descr= |exec= |mp= |pr= |s1= |p1= |p2= |p3= |p4= |p5= |p6= |p7= |p8= |p9= |p10= |p11= |p12= |p13= |p14= |p15= |p16= |p17= |p18= |p19= |p20= |r1= |x1= |seealso= }}