Lou Montana/Sandbox2 – User

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Page cleanup)
Tag: Replaced
m (Add RV/type & RV/param templates - the world is not ready for you my dears…)
 
Line 1: Line 1:
{{TOC|none}}
[[Category:Sandbox]]
[[Category:Sandbox]]
== RV/type Template ==
<includeonly>{{#if:{{{1|}}}|{{#switch:{{lc:{{{1}}}}}
|array= [[Array]]
|boolean= [[Boolean]]
|color= [[Array]] format [[Color]]
|rgb= [[Array]] format [[Color|Color (RGB)]]
|rgba= [[Array]] format [[Color|Color (RGBA)]]
|code= [[Code]]
|config= [[Config]]
|control= [[Control]]
|date= [[Array]] format [[Date]]
|diaryrecord= [[Diary Record]]
|display= [[Display]]
|edenentities= [[Array of Eden Entities]]
|group= [[Group]]
|hashmap= [[HashMap]]
|hashmapkey= [[HashMapKey]]
|loadout= [[Array]] format [[Unit Loadout Array]]
|location= [[Location]]
|namespace= [[Namespace]]
|number= [[Number]]
|object= [[Object]]
|particle= [[Array]] format [[ParticleArray]]
|pos= [[Array]] format [[Position]]
|pos2d= [[Array]] format [[Position#Position2D|Position2D]]
|pos3d= [[Array]] format [[Position#Position3D|Position3D]]
|posagl= [[Array]] format [[Position#PositionAGL|PositionAGL]]
|posagls= [[Array]] format [[Position#PositionAGLS|PositionAGLS]]
|posasl= [[Array]] format [[Position#PositionASL|PositionASL]]
|posatl= [[Array]] format [[Position#PositionATL|PositionATL]]
|posaslw= [[Array]] format [[Position#PositionASLW|PositionASLW]]
|posworld= [[Array]] format [[Position#PositionWorld|PositionWorld]]
|posrel= [[Array]] format [[Position#PositionRelative|PositionRelative]]
|side= [[Side]]
|script= [[Script Handle]]
|string= [[String]]
|task= [[Task]]
|teammember= [[Team Member]]
|text= [[Structured Text]]
|vector3d= [[Array]] format [[Vector3D]]
|waypoint= [[Array]] format [[Waypoint]]
|#default= {{TemplateCase||[[Category:Maintenance/RV/param]]}}[[:Category:Maintenance/RV/param|-Invalid type "{{{1}}}"-]]
}}|{{TemplateCase||[[Category:Maintenance/RV/param]]}}[[:Category:Maintenance/RV/param|-Type not defined-]]}}</includeonly><noinclude>{{Doc/Template
|name= RV/type
|descr= Return a descriptive data type from a keyword.
|param1= keyword
|descr1= parameter's [[:Category:Data Types|Data Type]], can be one of:{{Columns|8|
** array
** boolean
** color
** rgb
** rgba
** code
** config
** control
** date
** diaryrecord
** display
** edenentities
** group
** hashmap
** hashmapkey
** loadout
** location
** namespace
** number
** object
** particle
** pos
** pos2d
** pos3d
** posagl
** posagls
** posasl
** posatl
** posaslw
** posworld
** posrel
** side
** script
** string
** task
** teammember
** text
** vector3d
** waypoint
|shrink= y}}
|example1= <nowiki>{{RV/type}}</nowiki>
|result1= {{RV/type}}
|example2= <nowiki>{{RV/type|Hello there!}}</nowiki>
|result2= {{RV/type|Hello there!}}
|example3= <nowiki>{{RV/type|number}}</nowiki>
|result3= {{RV/type|number}} ([[Number]])
|example4= <nowiki>{{RV/type|pos2D}}</nowiki>
|result4= {{RV/type|pos2D}} ([[Array]] format [[Position#Position2D|Position2D]])
}}</noinclude>
== RV/param Template ==
<includeonly>{{{1|{{TemplateCase||[[Category:Maintenance/RV/param]]}}[[:Category:Maintenance/RV/param|Missing Name]]}}}: {{RV/type|{{{2}}}}} {{#if:{{{3|{{{default|{{{optional|}}}}}}}}}|<nowiki> - </nowiki>{{#if:{{{optional|{{{default|}}}}}}|(Optional{{#if:{{{default|}}}|, default {{hl|{{{default|}}}}}}}) <nowiki/>}}{{{3|}}}}}</includeonly><noinclude>{{Doc/Template
|name= RV/param
|descr= define an [[Template:RV|RV]] parameter
|param1= name
|descr1= the parameter's name
|param2= type
|descr2= [[:Category:Data Types|Data Type]], see [[Template:RV/type|RV/type]] for possible values
|param3= descr
|descr3= parameter's description
|param4= default
|descr4= (Optional) defines the default value (and sets ''optional'' on)
|param5= optional
|descr5= (Optional, unnecessary if ''default'' is set) defines the parameter's optionality
|example1= <nowiki>{{RV/param}}</nowiki>
|result1= {{RV/param}}
|example2= <nowiki>{{RV/param|name}}</nowiki>
|result2= {{RV/param|name}}
|example3= <nowiki>{{RV/param|name|object}}</nowiki>
|result3= {{RV/param|name|object}}
|example4= <nowiki>{{RV/param|name|pos|description}}</nowiki>
|result4= {{RV/param|name|pos|description}}
|example5= <nowiki>{{RV/param|name|posATL|description|optional= y}}</nowiki>
|result5= {{RV/param|name|posATL|description|optional= y}}
|example6= <nowiki>{{RV/param|name|posASL|description|default= 42}}</nowiki>
|result6= {{RV/param|name|posASL|description|default= 42}}
}}</noinclude>

Latest revision as of 01:51, 18 December 2021

RV/type Template

Return a descriptive data type from a keyword.

This template is used on these pages.

Usage

{{RV/type|keyword}}

  • keyword: parameter's Data Type, can be one of:
    • array
    • boolean
    • color
    • rgb
    • rgba
    • code
    • config
    • control
    • date
    • diaryrecord
    • display
    • edenentities
    • group
    • hashmap
    • hashmapkey
    • loadout
    • location
    • namespace
    • number
    • object
    • particle
    • pos
    • pos2d
    • pos3d
    • posagl
    • posagls
    • posasl
    • posatl
    • posaslw
    • posworld
    • posrel
    • side
    • script
    • string
    • task
    • teammember
    • text
    • vector3d
    • waypoint
Examples
Code Result
{{RV/type}} Template:RV/type
{{RV/type|Hello there!}} Template:RV/type
{{RV/type|number}} Template:RV/type (Number)
{{RV/type|pos2D}} Template:RV/type (Array format Position2D)



RV/param Template

define an RV parameter

This template is used on these pages.

Usage

{{RV/param|name|type|descr|default|optional}}

  • name: the parameter's name
  • type: Data Type, see RV/type for possible values
  • descr: parameter's description
  • default: (Optional) defines the default value (and sets optional on)
  • optional: (Optional, unnecessary if default is set) defines the parameter's optionality
Examples
Code Result
{{RV/param}} Template:RV/param
{{RV/param|name}} Template:RV/param
{{RV/param|name|object}} Template:RV/param
{{RV/param|name|pos|description}} Template:RV/param
{{RV/param|name|posATL|description|optional= y}} Template:RV/param
{{RV/param|name|posASL|description|default= 42}} Template:RV/param


Retrieved from "https://community.bistudio.com/wiki?title=User:Lou_Montana/Sandbox2&oldid=296460"