RV/doc – Template
Jump to navigation
Jump to search
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)) - automatically deals with diag_ and buldozer_ 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 Name template input format. Can be: ofp, ofpe, arma1, arma2, arma2oa, tkoh, arma3
- version1: (Optional, default empty - unknown) 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: (Optional, default [[:Category:Maintenance
/RV /Description needed|Description needed]]) the command description - exec: (Optional, Function only, default call) use spawn for functions to be spawned
- gr1..gr5: (Optional, default Command Group: Uncategorised) Command groups. Case sensitive
- s1: (Optional, default [[:Category:Maintenance
/RV /Syntax needed|Syntax needed]]) command syntax with named parameters, without <sqf> tags nor ending
- semicolon. e.g unit1 setDammage 1
- p1..p20: (Optional, default empty) command parameters with description
- r1: (default [[:Category:Maintenance
/RV /Return value needed|Return value needed]]) syntax's return value - x1..x10: (default [[:Category:Maintenance
/RV /Example needed|Example needed]]) command examples (to be put between <sqf></sqf> tags where needed) - seealso: (default [[:Category:Maintenance
/RV /See also needed|See also needed]]) 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
- version2..7: (Optional, default empty) same as version1, for the corresponding game#
- s2..s6: (Optional, default empty) Alternative syntaxes 1 to 5 (see s1)
- s2since..s6since: (Optional, default empty) game version that introduced the syntax; format gameId gameVersion, e.g arma3 1.50
- p21..p120: (Optional, default empty) Alternative syntaxes' parameters (20 each: p21..40, p41..60, p61..80, p81..100, p101..120)
- p21since..p120since: (Optional, default empty) game version that introduced the parameter; format gameId gameVersion, e.g arma3 1.50
- r2..r6: (Optional, default empty) Alternative syntaxes' return value (see r1)
Automatic categories
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 {{hl|0}}) - direction |p2since= arma2 1.00 |r1= [[Nothing]] |x1 = <sqf>unit1 setDir 45; // will set unit1 to face North-East</sqf> |x2 = <sqf>unit1 setDir -675; // will also set unit1 to face North-East (= 45-360-360)</sqf> |x3 = <sqf> unit1 setDir 30; unit1 setFormDir 30; // needed for AI to keep the given direction </sqf> |seealso= [[getDir]] [[direction]] [[setFormDir]] [[setVectorDir]] [[setVectorDirAndUp]] }} |
Description
Syntax
Examples
Additional Information
Notes
|
{{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= <sqf>[] call BIS_fnc_help;</sqf> |seealso= [[Arma 2: Functions Library]] [[Arma 3: Functions Library]] [[Take On Helicopters: Functions Library]] }} |
Description
Syntax
Examples
Additional Information
Notes
|
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= }}