RV – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Add Example colons and ids)
m (Add syntax ids)
Line 50: Line 50:


--><h3>Syntax</h3>
--><h3>Syntax</h3>
<dl>
<dl id="Syntax 1">
<dt>Syntax:</dt>
<dt>Syntax:</dt>
<dd>{{{s1|{{{4|'''{{PAGENAMEE}}'''}}}}}}</dd><!--
<dd>{{{s1|{{{4|'''{{PAGENAMEE}}'''}}}}}}</dd><!--
Line 63: Line 63:
<dt>Return Value:</dt>
<dt>Return Value:</dt>
<dd>{{{r1|{{{5|[[Nothing]]}}}}}}</dd>
<dd>{{{r1|{{{5|[[Nothing]]}}}}}}</dd>
</dl>|}}<!--
</dl>}}<!--


-->{{#if:{{{s2|}}}|
-->{{#if:{{{s2|}}}|
<h3>Alternative Syntax</h3>
<h3>Alternative Syntax</h3>
<dl>
<dl id="Syntax 2">
<dt>Syntax:</dt>
<dt>Syntax:</dt>
<dd>{{{s2}}}</dd>|}}<!--
<dd>{{{s2}}}</dd><!--


-->{{Command/params
-->{{Command/params
Line 75: Line 75:
| {{{p31|}}} | {{{p32|}}} | {{{p33|}}} | {{{p34|}}} | {{{p35|}}} | {{{p36|}}} | {{{p37|}}} | {{{p38|}}} | {{{p39|}}} | {{{p40|}}} }}<!--
| {{{p31|}}} | {{{p32|}}} | {{{p33|}}} | {{{p34|}}} | {{{p35|}}} | {{{p36|}}} | {{{p37|}}} | {{{p38|}}} | {{{p39|}}} | {{{p40|}}} }}<!--


-->{{#if:{{{s2|}}}|
--><dt>Return Value:</dt>
<dt>Return Value:</dt>
<dd>{{{r2|[[Nothing]]}}}</dd>
<dd>{{{r2|[[Nothing]]}}}</dd>
</dl>|}}<!--
</dl>}}<!--


-->{{#if:{{{s3|}}}|
-->{{#if:{{{s3|}}}|
<h3>Alternative Syntax 2</h3>
<h3>Alternative Syntax 2</h3>
<dl>
<dl id="Syntax 3">
<dt>Syntax:</dt>
<dt>Syntax:</dt>
<dd>{{{s3}}}</dd>|}}<!--
<dd>{{{s3}}}</dd><!--


-->{{Command/params
-->{{Command/params
Line 90: Line 89:
| {{{p51|}}} | {{{p52|}}} | {{{p53|}}} | {{{p54|}}} | {{{p55|}}} | {{{p56|}}} | {{{p57|}}} | {{{p58|}}} | {{{p59|}}} | {{{p60|}}} }}<!--
| {{{p51|}}} | {{{p52|}}} | {{{p53|}}} | {{{p54|}}} | {{{p55|}}} | {{{p56|}}} | {{{p57|}}} | {{{p58|}}} | {{{p59|}}} | {{{p60|}}} }}<!--


-->{{#if:{{{s3|}}}|
--><dt>Return Value:</dt>
<dt>Return Value:</dt>
<dd>{{{r3|[[Nothing]]}}}</dd>
<dd>{{{r3|[[Nothing]]}}}</dd>
</dl>|}}<!--
</dl>}}<!--


-->{{#if:{{{s4|}}}|
-->{{#if:{{{s4|}}}|
<h3>Alternative Syntax 3</h3>
<h3>Alternative Syntax 3</h3>
<dl>
<dl id="Syntax 4">
<dt>Syntax:</dt>
<dt>Syntax:</dt>
<dd>{{{s4}}}</dd>|}}<!--
<dd>{{{s4}}}</dd><!--


-->{{Command/params
-->{{Command/params
Line 105: Line 103:
| {{{p71|}}} | {{{p72|}}} | {{{p73|}}} | {{{p74|}}} | {{{p75|}}} | {{{p76|}}} | {{{p77|}}} | {{{p78|}}} | {{{p79|}}} | {{{p80|}}} }}<!--
| {{{p71|}}} | {{{p72|}}} | {{{p73|}}} | {{{p74|}}} | {{{p75|}}} | {{{p76|}}} | {{{p77|}}} | {{{p78|}}} | {{{p79|}}} | {{{p80|}}} }}<!--


-->{{#if:{{{s4|}}}|
--><dt>Return Value:</dt>
<dt>Return Value:</dt>
<dd>{{{r4|[[Nothing]]}}}</dd>
<dd>{{{r4|[[Nothing]]}}}</dd>
</dl>|}}<!--
</dl>}}<!--


-->{{#if:{{{s5|}}}|
-->{{#if:{{{s5|}}}|
<h3>Alternative Syntax 4</h3>
<h3>Alternative Syntax 4</h3>
<dl>
<dl id="Syntax 5">
<dt>Syntax:</dt>
<dt>Syntax:</dt>
<dd>{{{s5}}}</dd>|}}<!--
<dd>{{{s5}}}</dd><!--


-->{{Command/params
-->{{Command/params
Line 120: Line 117:
| {{{p91|}}} | {{{p92|}}} | {{{p93|}}} | {{{p94|}}} |  {{{p95|}}} | {{{p96|}}} | {{{p97|}}} | {{{p98|}}} | {{{p99|}}} | {{{p100|}}} }}<!--
| {{{p91|}}} | {{{p92|}}} | {{{p93|}}} | {{{p94|}}} |  {{{p95|}}} | {{{p96|}}} | {{{p97|}}} | {{{p98|}}} | {{{p99|}}} | {{{p100|}}} }}<!--


-->{{#if:{{{s5|}}}|
--><dt>Return Value:</dt>
<dt>Return Value:</dt>
<dd>{{{r5|[[Nothing]]}}}</dd>
<dd>{{{r5|[[Nothing]]}}}</dd>
</dl>|}}<!--
</dl>|}}<!--
Line 127: Line 123:
-->{{#if:{{{s6|}}}|
-->{{#if:{{{s6|}}}|
<h3>Alternative Syntax 5</h3>
<h3>Alternative Syntax 5</h3>
<dl>
<dl id="Syntax 6">
<dt>Syntax:</dt>
<dt>Syntax:</dt>
<dd>{{{s6}}}</dd>|}}<!--
<dd>{{{s6}}}</dd><!--


-->{{Command/params
-->{{Command/params
Line 135: Line 131:
| {{{p111|}}} | {{{p112|}}} | {{{p113|}}} | {{{p114|}}} | {{{p115|}}} | {{{p116|}}} | {{{p117|}}} | {{{p118|}}} | {{{p119|}}} | {{{p120|}}} }}<!--
| {{{p111|}}} | {{{p112|}}} | {{{p113|}}} | {{{p114|}}} | {{{p115|}}} | {{{p116|}}} | {{{p117|}}} | {{{p118|}}} | {{{p119|}}} | {{{p120|}}} }}<!--


-->{{#if:{{{s6|}}}|
--><dt>Return Value:</dt>
<dt>Return Value:</dt>
<dd>{{{r6|[[Nothing]]}}}</dd>
<dd>{{{r6|[[Nothing]]}}}</dd>
</dl>|}}<!--
</dl>|}}<!--
Line 239: Line 234:
== Usage ==
== Usage ==
{{<nowiki/>RV|'''type='''|''other parameters, see below''}}
{{<nowiki/>RV|'''type='''|''other parameters, see below''}}
* meta information:
* '''meta information:'''
** '''type''': (named argument, case-insensitive) "command" or "function"
** type: (named argument, case-insensitive) "command" or "function"
** displayTitle: (Optional, default <tt>{{<nowiki/>PAGENAMEE}}</tt> (encoded page name, i.e with underscores)) use to force page's displayTitle (e.g <tt>diag_log (Arma 2)</tt>)
** displayTitle: (Optional, default <tt>{{<nowiki/>PAGENAMEE}}</tt> (encoded page name, i.e with underscores)) use to force page's displayTitle (e.g <tt>diag_log (Arma 2)</tt>)
** '''sortKey''': (Optional, default commandName or functionName without BIS/BIN_fnc_ prefix) use to force category's sort key
** sortKey: (Optional, default commandName or functionName without BIS/BIN_fnc_ prefix) use to force category's sort key
* '''primary parameters:'''
* '''primary parameters:'''
** game1: (can be unnamed parameter '''1''') short game name - same as [[Template:Name|Name]] template input format. e.g ofp, tkoh, arma3, etc.
** game1: (can be unnamed parameter '''1''') short game name - same as [[Template:Name|Name]] template input format. e.g ofp, tkoh, arma3, etc.

Revision as of 03:36, 16 January 2021

Commands/Functions documentation template.

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 version or unnamed parameter 2) number in Template:GVI template format: <Major>.<Minor>. e.g 1.46, 1.75, 1.86 etc.
    • arg: (Optional, default empty) argument locality definition - same as EffArg template input format. e.g local, loc or global, glob
    • eff: (Optional, default empty) effects locality definition - same as EffArg template input format. e.g local, loc or global, glob
    • serverExec: (Optional, default empty) if provided, will display the Template:ServerExec 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

Description:
Template:Stub

Syntax

Syntax:
RV
Template:Command/params

Examples

Examples:
Template:Example needed

Additional Information

See also:
See also needed
Groups:
Uncategorised

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

+ Add Note (Help)

{{RV|type=function}}
Hover & click on the images for descriptions

Description

Description:
Template:Stub
Execution:
call

Syntax

Syntax:
RV
Template:Command/params

Examples

Examples:
Template:Example needed

Additional Information

See also:
See also needed
Groups:
Uncategorised

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

+ Add Note (Help)

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=
}}
Retrieved from "https://community.bistudio.com/wiki?title=Template:RV&oldid=194859"