RV/doc – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
(Split RV & doc)
 
m (Fix doc)
Line 19: Line 19:
** s1: (Optional, default <tt>{{<nowiki/>PAGENAMEE}}</tt>; can be unnamed parameter '''4''') command syntax with named parameters. e.g {{ic|unit1 '''setDammage''' 1}}
** s1: (Optional, default <tt>{{<nowiki/>PAGENAMEE}}</tt>; can be unnamed parameter '''4''') command syntax with named parameters. e.g {{ic|unit1 '''setDammage''' 1}}
** p1..20: (Optional, default empty) command parameters with description
** p1..20: (Optional, default empty) command parameters with description
** r1: (Optional, default [[Nothing]]); can be unnamed parameter '''5''') syntax's return value
** r1: (default <tt>[[:Category:Return value needed|Return value needed]]</tt>); can be unnamed parameter '''5''') syntax's return value
** exec: (Optional, Function only, default <tt>call</tt>) use <tt>spawn</tt> for functions to be spawned
** exec: (Optional, Function only, default <tt>call</tt>) use <tt>spawn</tt> for functions to be spawned
** x1..10: (Optional, default <tt>[[:Category:Example needed|Example needed]]</tt>) command examples (to be put between <nowiki><code></code></nowiki> tags where needed)
** x1..10: (default <tt>[[:Category:Example needed|Example needed]]</tt>) command examples (to be put between <nowiki><code></code></nowiki> tags where needed)
** seealso: (Optional, default <tt>[[:Category:See also needed|See also needed]]</tt>; can be unnamed param '''6''') list of related links in wiki format, separated by comma or space. e.g <nowiki>[[setDir]] [[setPos]]</nowiki>
** seealso: (default <tt>[[:Category:See also needed|See also needed]]</tt>; can be unnamed param '''6''') list of related links in wiki format, separated by comma or space. e.g <nowiki>[[setDir]] [[setPos]]</nowiki>
* '''secondary parameters:'''
* '''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
** 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
Line 28: Line 28:
** mp: (Optional, default empty) if provided, will show a Multiplayer note 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
** pr: (Optional, default empty) if provided, will show a Problems note under the description
** game2..7: (Optional, default empty) same as ''game1''. '''7''' possible games: {{Name|ofp|short}}, {{Name|ofpe|short}}, {{Name|arma|short}}, {{Name|arma2|short}}, {{Name|arma2oa|short}}, {{Name|tkoh|short}}, {{Name|arma3|short}}
** game2..7: (Optional, default empty) same as ''game1''. '''7''' possible games: {{Name|ofp|id}}, {{Name|ofpe|id}}, {{Name|arma1|id}}, {{Name|arma2|id}}, {{Name|arma2oa|id}}, {{Name|tkoh|id}}, {{Name|arma3|id}}
** version2..7: (Optional, default empty) same as ''version1'', for the corresponding ''game#''
** version2..7: (Optional, default empty) same as ''version1'', for the corresponding ''game#''
** s2..6: (Optional, default empty) Alternative syntaxes 1 to 5 (see ''s1'')
** s2..6: (Optional, default empty) Alternative syntaxes 1 to 5 (see ''s1'')

Revision as of 00:53, 13 June 2021

Real Virtuality Commands/Functions documentation template, used by these pages.

⚠
Do NOT edit this template before heavy testing, as it is widely used! (on at least 4,746 pages, including 2,669 commands and 2,077 functions)

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 - Optional, default Description needed) 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: (default Return value needed); can be unnamed parameter 5) syntax's return value
    • exec: (Optional, Function only, default call) use spawn for functions to be spawned
    • x1..10: (default Example needed) command examples (to be put between <code></code> tags where needed)
    • seealso: (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:
    • branch: (Optional, default empty) takes free string such as development (dev), diagnostic (diag) or profiling (prof). 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. 7 possible games: ofp, ofpe, arma1, arma2, arma2oa, tkoh, arma3
    • 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

Command Function

Examples

Code Result
{{RV}} -no type provided-


{{RV|type=abc}} -wrong type ("abc") provided-


{{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]]
}}
Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
Hover & click on the images for description
⚠
Only available in Development/Diagnostic/Profiling branch(es) until its release with Arma 3 patch v1.00.

Description

Description:
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.
Multiplayer:
See notes below for more details on setDir behaviour.
Problems:
Command will not work with roman numbers e.g. VI.
Alias:
someCommand
Groups:
Object Manipulation

Syntax

Syntax:
object setDir heading
Parameters:
object: Object
heading: Number (Optional, default 0) - Direction
Return Value:
Nothing

Examples

Example 1:
unit1 setDir 45; // will set unit1 to face North-East
Example 2:
unit1 setDir -675; // will also set unit1 to face North-East (= 45-360-360)
Example 3:
unit1 setDir 30; unit1 setFormDir 30; // needed for AI to keep the given direction

Additional Information

See also:
getDirdirectionsetFormDirsetVectorDirsetVectorDirAndUp

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note 



{{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]]
}}
Logo A2.png1.00tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalLELocal
Hover & click on the images for description

Description

Description:
Shows Function Library viewer, which contains list of all available functions, both official and unofficial.
Execution:
call
Alias:
someFunction
Groups:
Diagnostic

Syntax

Syntax:
[parentDisplay] call BIS_fnc_help
Parameters:
parentDisplay: Display - (Optional, default displayNull)
Return Value:
Nothing

Examples

Example 1:
[] call BIS_fnc_help;

Additional Information

See also:
Arma 2: Functions Library Arma 3: Functions Library Take On Helicopters: Functions Library

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Command Template

{{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=
}}

Function Template

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