View source for Template:RV/doc

{{TOC|side|1.1|2}}
[[Real Virtuality]] [[:Category:Scripting Commands|Commands]]/[[:Category:Functions|Functions]] documentation template, used by [[Special:WhatLinksHere/Template:{{PAGENAMEE}}|these pages]].
{{Feature | Warning | Do '''NOT''' edit this template before '''heavy''' testing, as '''it is widely used!'''  (on ''at least'' {{formatnum:{{#expr: {{formatnum:{{PAGESINCATEGORY:Scripting Commands|pages}}|R}} + {{formatnum:{{PAGESINCATEGORY:Functions|pages}}|R}} }} }} pages, including [[:Category:Scripting Commands|{{PAGESINCATEGORY:Scripting Commands|pages}} commands]] and [[:Category:Functions|{{PAGESINCATEGORY:Functions|pages}} functions]])}}

== Usage ==
{{<nowiki/>RV|'''type='''|''other parameters, see below''}}
* '''meta information:'''
** 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>) - automatically deals with <tt>diag_</tt> and <tt>buldozer_</tt> pages already
** sortKey: (Optional, default commandName or functionName without BIS/BIN_fnc_ prefix) use to force category's sort key
* '''primary parameters:'''
** game1: short game name - same as [[Template:Name|Name]] template input format. Can be: {{Name|ofp|id}}, {{Name|ofpe|id}}, {{Name|arma1|id}}, {{Name|arma2|id}}, {{Name|arma2oa|id}}, {{Name|tkoh|id}}, {{Name|arma3|id}}
** version1: (Optional, default empty - unknown) number in [[Template:GVI|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 {{Icon|localArgument|32}} or {{Icon|globalArgument|32}} icon depending on arguments' locality
** eff: (Optional, default empty) '''local''' or '''global''' - if provided, will display the {{Icon|localEffect|32}} or {{Icon|globalEffect|32}} icon depending on effect's locality
** serverExec: (Optional, default empty) if provided, will display the {{Icon|serverExec|32}} icon informing the command must be run on the server
** descr: (Optional, default <tt>[[:Category:Maintenance/RV/Description needed|Description needed]]</tt>) the command description
** exec: (Optional, Function only, default <tt>call</tt>) use <tt>spawn</tt> for functions to be spawned
** gr1..gr5: (Optional, default <tt>[[:Category:Command Group: Uncategorised|Command Group: Uncategorised]]</tt>) [[:Category:Scripting Commands by Functionality|Command groups]]. '''Case sensitive'''
** s1: (Optional, default <tt>[[:Category:Maintenance/RV/Syntax needed|Syntax needed]]</tt>) command syntax with named parameters, without <tt>&lt;code&gt;</tt> tags nor ending <tt>;</tt> semicolon. e.g {{ic|unit1 '''setDammage''' 1}}
** p1..20: (Optional, default empty) command parameters with description
** r1: (default <tt>[[:Category:Maintenance/RV/Return value needed|Return value needed]]</tt>) syntax's return value
** x1..10: (default <tt>[[:Category:Maintenance/RV/Example needed|Example needed]]</tt>) command examples (to be put between <nowiki><code></code></nowiki> tags where needed)
** seealso: (default <tt>[[:Category:Maintenance/RV/See also needed|See also needed]]</tt>) list of related links in wiki format, separated by comma or space. e.g <nowiki>[[setDir]] [[setPos]]</nowiki>
* '''secondary parameters:'''
** branch: (Optional, default empty) takes free string such as <tt>development</tt> (<tt>dev</tt>), <tt>diagnostic</tt> (<tt>diag</tt>) or <tt>profiling</tt> (<tt>prof</tt>). If provided, will mark the page as Development, Diagnostic or Profiling branch only
** alias: (Optional, default empty) if provided, will show Alias link(s) under the description
** 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..7: (Optional, default empty) same as ''game1''
** version2..7: (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 ==

'''[[:Category:Maintenance/RV|Maintenance/RV]]'''&nbsp;:
{{Columns|2|
* [[:Category:Maintenance/RV/Game1 needed|Maintenance/RV/Game1 needed]]
* [[:Category:Maintenance/RV/Version1 needed|Maintenance/RV/Version1 needed]]
* [[:Category:Maintenance/RV/Description needed|Maintenance/RV/Description needed]]
* [[:Category:Maintenance/RV/Syntax needed|Maintenance/RV/Syntax needed]]
* [[:Category:Maintenance/RV/Return value needed|Maintenance/RV/Return value needed]]
* [[:Category:Maintenance/RV/Example needed|Maintenance/RV/Example needed]]
* [[:Category:Maintenance/RV/See also needed|Maintenance/RV/See also needed]]
* [[:Category:Maintenance/RV/Nameless parameter usage|Maintenance/RV/Nameless parameter usage]]
}}
{| class="wikitable"
! Command
! Function
|- style="vertical-align: top"
|
* <tt>[[:Category:Scripting Commands]]</tt>
* <tt>Category:''game#'': Scripting Commands</tt> (e.g [[:Category:{{arma2}}: Scripting Commands|Category:'''{{arma2}}''': Scripting Commands]])
* <tt>Category:''game1'': Introduced in v''version'''1'''''</tt> (e.g [[:Category:Introduced with {{arma3}} version 1.00|Category:'''{{arma3}}''': Introduced in v'''1.00''']])
* <tt>''game'''1''''': New Scripting Commands</tt> category (e.g [[:Category:{{arma2}}: New Scripting Commands|Category:'''{{arma2}}''': New Scripting Commands]])
<!-- * <tt>[[:Category:Introduced with Arma 3 Development Branch]]</tt> if ''game1'' is <tt>arma3dev</tt> not yet -->
|
* <tt>[[:Category:Functions]]</tt>
* <tt>Category:''game#'': Functions</tt> (e.g [[:Category:{{arma2}}: Functions|Category:'''{{arma2}}''': Functions]])
* <tt>Category:''game'''1''''': Introduced in v''version'''1'''''</tt> (e.g [[:Category:Introduced with {{arma3}} version 1.00|Category:'''{{arma3}}''': Introduced in v'''1.00''']])
* <tt>''game'''1''''': New Functions</tt> category (e.g [[:Category: {{arma2}}: New Functions|Category: '''{{arma2}}''': New Functions]])
<!--* <tt>[[:Category:Introduced with Arma 3 Development Branch]]</tt> if ''game1'' is <tt>arma3dev</tt> not yet, and most probably won't -->
|}

== Examples ==
{|
|- style="background-color: #EEE"
! Code
! Result
|-
| <nowiki>{{RV}}</nowiki>
| {{RV}}<br><br><br>
|-
| <nowiki>{{RV|type=abc}}</nowiki>
| {{RV|type=abc}}<br><br><br>
|-
| style="font-size: 0.9em; white-space: pre" | <pre><nowiki>{{RV|type=command

|game1= ofp
|version1= 1.00

|game2= ofpe
|version2= 1.00

|game3= arma1
|version3= 1.00

|game4= arma2
|version4= 1.00

|game5= arma2oa
|version5= 1.50

|game6= tkoh
|version6= 1.00

|game7= arma3
|version7= 0.50

|branch= development diagnostic profiling

|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.

|alias= someCommand

|pr= Command will not work with roman numbers e.g. VI.

|mp= See notes below for more details on [[setDir]] behaviour.

|s1= object '''setDir''' heading

|p1= object: [[Object]]

|p2= heading: [[Number]] (Optional, default {{ic|0}}) - Direction

|r1= [[Nothing]]

|x1 = <code>unit1 [[setDir]] 45; {{cc|will set unit1 to face North-East}}</code>

|x2 = <code>unit1 [[setDir]] -675; {{cc|will also set unit1 to face North-East ({{=}} 45-360-360)}}</code>

|x3 = <code>unit1 [[setDir]] 30;
unit1 [[setFormDir]] 30; {{cc|needed for AI to keep the given direction}}</code>

|seealso= [[getDir]], [[direction]], [[setFormDir]], [[setVectorDir]], [[setVectorDirAndUp]]
}}</nowiki></pre>
| {{RV|type=command

|game1= ofp
|version1= 1.00

|game2= ofpe
|version2= 1.00

|game3= arma1
|version3= 1.00

|game4= arma2
|version4= 1.00

|game5= arma2oa
|version5= 1.50

|game6= tkoh
|version6= 1.00

|game7= arma3
|version7= 0.50

|branch= development diagnostic profiling

|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.

|alias= someCommand

|pr= Command will not work with roman numbers e.g. VI.

|mp= See notes below for more details on [[setDir]] behaviour.

|s1= object '''setDir''' heading

|p1= object: [[Object]]

|p2= heading: [[Number]] (Optional, default {{ic|0}}) - Direction

|r1= [[Nothing]]

|x1 = <code>unit1 [[setDir]] 45; {{cc|will set unit1 to face North-East}}</code>

|x2 = <code>unit1 [[setDir]] -675; {{cc|will also set unit1 to face North-East ({{=}} 45-360-360)}}</code>

|x3 = <code>unit1 [[setDir]] 30;
unit1 [[setFormDir]] 30; {{cc|needed for AI to keep the given direction}}</code>

|seealso= [[getDir]], [[direction]], [[setFormDir]], [[setVectorDir]], [[setVectorDirAndUp]]
}}<br><br><br>
|-
| style="font-size: 0.9em; white-space: pre" | <pre><nowiki>{{RV|type=function

|game1= arma2
|version1= 1.00

|game2= TKOH
|version2= 1.00

|game3= arma3
|version3= 0.50

|arg= local

|eff= local

|gr1= Diagnostic

|descr= Shows Function Library viewer, which contains list of all available functions, both official and unofficial.

|alias= someFunction

<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: Functions Library]]
}}</nowiki></pre>
| {{RV|type=function

|game1= arma2
|version1= 1.00

|game2= TKOH
|version2= 1.00

|game3= arma3
|version3= 0.50

|arg= local

|eff= local

|gr1= Diagnostic

|descr= Shows Function Library viewer, which contains list of all available functions, both official and unofficial.

|alias= someFunction

<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: Functions Library]]
}}

|}

== Command Template ==
<pre style="columns: 6">
{{RV|type=command

|game1=

|version1=

|game2=

|version2=

|game3=

|version3=

|game4=

|version4=

|game5=

|version5=

|game6=

|version6=

|game7=

|version7=

|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=
}}
</pre>

== Function Template ==
<pre style="columns: 6">
{{RV|type=function

|game1=

|version1=

|game2=

|version2=

|game3=

|version3=

|game4=

|version4=

|game5=

|version5=

|game6=

|version6=

|game7=

|version7=

|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=
}}
</pre>

[[Category:Templates|{{uc:{{PAGENAME}}}}]]