Feature – Template

From Bohemia Interactive Community
Jump to navigation Jump to search
m (-)
(Add Steam default text)
(39 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{{#if:{{{1|}}}|{{#switch:{{uc:{{{1|}}}}}
<includeonly>{{#if:{{{1|}}}|{{#switch:{{uc:{{{1}}}}}
|AFM= {{Messagebox|{{{2|For this command to have any effect, the [[Arma 3 Advanced Helicopter Flight Model]] (AFM) has to be enabled. If AFM is enabled can be checked with [[difficultyEnabledRTD]].}}}|{{Icon|afm}}|#3189C9}}
|AFM= {{Messagebox|{{{2|For this command to have any effect, the [[Arma 3: Advanced Helicopter Flight Model|Advanced Flight Model]] (AFM) has to be enabled. AFM status can be checked with [[difficultyEnabledRTD]].}}}|{{Icon|afm|35}}|#3189C9}}
|ARMA3= {{Messagebox|{{{2|}}}|{{Icon|arma3}}|#ADBF83}}
|OFP
|ARMA3CONTACT= {{Messagebox|{{{2|This content is exclusive to the [[Arma 3 Contact]] Expansion.}}}|{{Icon|arma3contact}}|#81AED3}}{{#ifeq:{{uc:{{FULLPAGENAME}}}}|TEMPLATE:FEATURE||[[Category:Arma 3 Contact]]}}
|ARMA0= {{Messagebox|{{{2|This is an [[:Category:Operation Flashpoint|{{Name|arma0}}]] feature.}}}|{{Icon|arma0}}|#AA8}}
|OFPE= {{Messagebox|{{{2|This is an {{GameCategory|ofpe|link=y}} feature.}}}|{{Icon|ofpe}}|#CDC}}
|ARMA1= {{Messagebox|{{{2|This is an {{GameCategory|arma1|link=y}} feature.}}}|{{Icon|arma1}}|#FFDD7F}}
|ARMA2= {{Messagebox|{{{2|This is an {{GameCategory|arma2|link=y}} feature.}}}|{{Icon|arma2}}|#6EA859}}
|ARMA2OA= {{Messagebox|{{{2|This is an {{GameCategory|arma2oa|link=y}} feature.}}}|{{Icon|arma2oa}}|#E1D6A8}}
|ARMA3= {{Messagebox|{{{2|This is an {{GameCategory|arma3|link=y}} feature.}}}|{{Icon|arma3}}|#ADBF83}}
|ARMA3CONTACT= {{Messagebox|{{{2|This content is exclusive to the [[Arma 3 Contact]] Expansion.}}}|{{Icon|arma3contact|32}}|#81AED3}}
|ARMA3OLDMAN= {{Messagebox|{{{2|This function is used by the [[Arma 3 Apex: Old Man]] content. It might only work properly inside this scenario.}}}|{{Icon|arma3oldman_alt}}|#1C732F}}
|ARMA3OLDMAN= {{Messagebox|{{{2|This function is used by the [[Arma 3 Apex: Old Man]] content. It might only work properly inside this scenario.}}}|{{Icon|arma3oldman_alt}}|#1C732F}}
|DAYZ= {{Messagebox|{{{2|}}}|{{Icon|dayz_alt}}|#000}}
|ARMAR= {{Messagebox|{{{2|This is an {{GameCategory|armaR|link=y}} feature.}}}|{{Icon|armaR}}|#E2A750}}
|EDEN EDITOR
|ARMA4= {{Messagebox|{{{2|This is an {{GameCategory|arma4|link=y}} feature.}}}|{{Icon|arma4}}|#CCC}}
|EDEN_EDITOR= {{Messagebox|{{{2|}}}|{{Icon|arma3eden|60}}|#988297}}
|DAYZ= {{Messagebox|{{{2|This is a {{GameCategory|dayz|link=y}} feature.}}}|{{Icon|dayz_alt}}|#000}}
|TKOH= {{Messagebox|{{{2|}}}|{{Icon|tkoh}}|#8CF}}
|EDENEDITOR
|YLANDS= {{Messagebox|{{{2|}}}|{{Icon|ylands}}|#AED2D8}}
|EDEN EDITOR= {{Messagebox|{{{2|This is an [[:Category:Eden Editor|Eden Editor]] feature.}}}|{{Icon|arma3eden}}|#988297}}
| -unknown feature defined ("{{{1}}}")-
|GAMEPAD= {{Messagebox|{{{2|{{TemplateCase||[[Category:Feature template usage error]]}}}}}|<div style{{=}}"margin-top: -.25em">{{Icon|gamepad}}</div>|#676}}
}}|-no feature defined-}}</includeonly><noinclude>
|GVI= {{Messagebox|{{{4|{{#if:{{{2|}}}|This feature was introduced with {{Name|{{{2}}}}}{{#if:{{{3|}}}|<nowiki/> v{{{3}}}}}.|-no game provided-{{TemplateCase||[[Category:Feature template usage error]]}}}}}}}|{{#if:{{{2|}}}|<div style{{=}}"color: #333">{{GVI|{{{2}}}|{{{3|1.00}}}}}</div>|?}}|#5A8}}
== Usage ==
|IMPORTANT= {{Messagebox|{{{2|{{TemplateCase||[[Category:Feature template usage error]]}}}}}|⚠|#EA0}}
{{<nowiki/>Feature|'''''name'''''|'''''message'''''}}
|INFORMATIVE= {{Messagebox|{{{2|{{TemplateCase||[[Category:Feature template usage error]]}}}}}|ⓘ|#00BFFF}}
* name: (case-insensitive) can be one of:
|KEYBOARD= {{Messagebox|{{{2|{{TemplateCase||[[Category:Feature template usage error]]}}}}}|<div style{{=}}"margin-top: -.25em">{{Icon|keyboard}}</div>|#676}}
** AFM: [[Arma 3 Advanced Helicopter Flight Model]] feature
|PC= {{Messagebox|{{{2|This is a PC feature.}}}|{{Icon|kbm}}|#333; background: linear-gradient(#333 0%, goldenrod 50%, #333 100%);}}
** arma3: {{arma3}} feature
|PLAYSTATION= {{Messagebox|{{{2|This is a PlayStation® feature.}}}|<div style{{=}}"margin-top: -.25em">{{Icon|playstation}}</div>|#006FCD}}
** arma3contact: [[Arma 3 Contact]] feature
|OBSOLETE= {{Messagebox|This information is '''obsolete'''{{#if:{{{3|}}}|<nowiki/> as of {{Name|{{{3}}}}}{{#if:{{{4|}}}|<nowiki/> v{{{4}}}}}|}}.{{#if:{{{2|{{{message|}}}}}}|<nowiki/> Reason: {{{2|{{{message}}}}}}}}|🕖|#999}}
** arma3oldman: [[Arma 3 Apex: Old Man]] feature
|QUOTE= {{Messagebox|{{#if:{{Trim|{{{2|}}}}}|<span class="feature-quote">«&nbsp;{{Trim|{{{2}}}}}&nbsp;»</span>{{#if:{{{3|}}}|&nbsp;&ndash;&nbsp;{{Trim|{{{3}}}}}}}{{#if:{{{4|}}}|&nbsp;({{Link|{{{4}}}|source}})}}}}|«|#8C8}}
** dayz: [[:Category:DayZ]] feature
|SPOILER= <div class="biki-messagebox-spoiler">
** Eden Editor: [[Eden Editor]] feature
<div class="spoiler-title">Spoiler Warning</div>
** TKOH: [[{{tkoh}}]] feature
'''The following text contains game spoilers such as story details or mission walkthroughs. Read at your own risk!'''{{#if:{{{2|}}}
** Ylands: [[{{ylands}}]] feature
|<br>The potential spoilers concern the following topic: {{{2}}}.}}</div>
* message: (Optional) the message to display
|STEAM= {{Messagebox|{{{2|This is a [[Steam]] feature.}}}|{{Icon|steam}}|#171D25}}
|TKOH= {{Messagebox|{{{2|This is a {{GameCategory|tkoh|link=y}} feature.}}}|{{Icon|tkoh|32}}|#8CF}}
|UNSUPPORTEDDOC= {{Messagebox/BI|Disclaimer: This page describes internal undocumented structures of [[Bohemia Interactive]] software.|
This page contains unofficial information.


{| class="wikitable"
Some usage of this information may constitute a violation of the rights of Bohemia Interactive and is in no way endorsed or recommended by {{Name|bi}}.<br><!--
|+ Examples
-->{{Name|bi}} is not willing to tolerate use of such tools if it contravenes any general licenses granted to end users of this community wiki or BI products.
! Code
}}
! Result
|UNSUPPORTEDTOOL= {{Messagebox/BI|Disclaimer: This page describes an unofficial tool created without permission or support of [[{{Name|bi}}]].|
|-
The product itself and its usage may be violating rights of Bohemia Interactive and is in no way endorsed or recommended by {{Name|bi}}.
| <nowiki>{{Feature}}</nowiki>
See also '''[[:Category:Official Tools|Official Tools]]'''.}}
| {{Feature}}
|WARNING= {{Messagebox|{{{2|{{TemplateCase||[[Category:Feature template usage error]]}}}}}|⚠|#F00}}
|-
|XBOX= {{Messagebox|{{{2|This is an Xbox® feature.}}}|<div style{{=}}"margin-top: -.25em">{{Icon|xbox}}</div>|#107C10}}
| <nowiki>{{Feature|test}}</nowiki>
|YLANDS= {{Messagebox|{{{2|This is a {{GameCategory|ylands|link=y}} feature.}}}|{{Icon|ylands|60}}|#AED2D8}}
| {{Feature|test}}
| -unknown [[Template:Feature|feature]] ("{{{1}}}") defined-{{TemplateCase||[[Category:Feature template usage error]]}}
|-
}}|-no feature defined-{{TemplateCase||[[Category:Feature template usage error]]}}}}</includeonly><noinclude>{{Feature/doc}}<templatedata>
| <nowiki>{{Feature|afm}}</nowiki>
{
| {{Feature|afm}}
"params": {
|-
"1": {
| <nowiki>{{Feature|afm|Hello there!}}</nowiki>
"label": "name",
| {{Feature|afm|Hello there!}}
"description": "name of the feature used for the messagebox",
|-
"type": "string",
| <nowiki>{{Feature|arma3}}</nowiki>
"suggestedvalues": [
| {{Feature|arma3}}
"AFM",
|-
"ofp",
| <nowiki>{{Feature|arma3|Hello there!}}</nowiki>
"arma0",
| {{Feature|arma3|Hello there!}}
"ofpe",
|-
"arma1",
| <nowiki>{{Feature|arma3contact}}</nowiki>
"arma2",
| {{Feature|arma3contact}}
"arma2oa",
|-
"arma3",
| <nowiki>{{Feature|arma3contact|Hello there!}}</nowiki>
"arma3contact",
| {{Feature|arma3contact|Hello there!}}
"arma3oldman",
|-
"armaR",
| <nowiki>{{Feature|arma3oldman}}</nowiki>
"arma4",
| {{Feature|arma3oldman}}
"dayz",
|-
"Eden Editor",
| <nowiki>{{Feature|arma3oldman|Hello there!}}</nowiki>
"gamepad",
| {{Feature|arma3oldman|Hello there!}}
"GVI",
|-
"keyboard",
| <nowiki>{{Feature|dayz}}</nowiki>
"important",
| {{Feature|dayz}}
"informative",
|-
"obsolete",
| <nowiki>{{Feature|dayz|Hello there!}}</nowiki>
"quote",
| {{Feature|dayz|Hello there!}}
"playstation",
|-
"spoiler",
| <nowiki>{{Feature|eden editor}}</nowiki>
"tkoh",
| {{Feature|eden editor}}
"UnsupportedDoc",
|-
"UnsupportedTool",
| <nowiki>{{Feature|eden editor|Hello there!}}</nowiki>
"warning",
| {{Feature|eden editor|Hello there!}}
"xbox",
|-
"ylands"
| <nowiki>{{Feature|tkoh}}</nowiki>
],
| {{Feature|tkoh}}
"autovalue": "informative",
|-
"required": true
| <nowiki>{{Feature|tkoh|Hello there!}}</nowiki>
},
| {{Feature|tkoh|Hello there!}}
"2": {},
|-
"3": {},
| <nowiki>{{Feature|ylands}}</nowiki>
"4": {},
| {{Feature|ylands}}
"message": {}
|-
},
| <nowiki>{{Feature|ylands|Hello there!}}</nowiki>
"paramOrder": [
| {{Feature|ylands|Hello there!}}
"1",
|}
"2",
 
"3",
[[Category:Templates|{{uc:{{PAGENAME}}}}]]</noinclude>
"4",
"message"
],
"format": "inline"
}
</templatedata></noinclude>

Revision as of 19:32, 10 July 2024

Adds a feature messagebox. Adds the page to the Feature template usage error category if wrongly filled.

Usage

{{Feature|name|message}}

  • name: (case-insensitive) can be one of:
    • AFM: Arma 3: Advanced Helicopter Flight Model feature
    • ofp/arma0: Operation Flashpoint feature
    • ofp: Operation Flashpoint: Elite feature
    • arma1: ArmA: Armed Assault feature
    • arma2: Arma 2 feature
    • arma2oa: Arma 2: Operation Arrowhead feature
    • arma3: Arma 3 feature
    • arma3contact: Arma 3 Contact feature
    • arma3oldman: Arma 3 Apex: Old Man feature
    • armaR: Arma Reforger feature
    • arma4: Arma 4 feature
    • dayz: DayZ feature
    • Eden Editor: Eden Editor feature
    • Gamepad: a gamepad-specific information
    • GVI: a Game Version Information - see {{GVI}}
      • game id
      • game version (Optional, default "1.00")
      • additional text (Optional, default "This feature was introduced with game vVersion")
    • Keyboard: a keyboard-specific information
    • Important: an important messagebox; parameters:
      • message
    • Informative: an informative messagebox; parameters:
      • message
    • Obsolete: an obsolete part of the documentation or documentation about an obsolete aspect of the product; parameters (all optional):
      • message (obsolescence reason)
      • game (e.g arma3)
      • version (e.g 1.50)
    • Quote: a quote, parameters (all but message optional):
      • message: quote
      • author
      • source (URL)
    • PC: a PC feature
    • playstation: a PlayStation feature
    • Spoiler: spoiler alert
    • TKOH: Take On Helicopters feature
    • UnsupportedDoc: unsupported internal structure documentation (e.g PBO, save file etc)
    • UnsupportedTool: unsupported, most likely unofficial tool
    • Warning: a warning messagebox; parameters:
      • message
    • xbox: an Xbox feature
    • Ylands: Ylands feature
  • message: (Optional) the message to display
Examples
Code Result
{{Feature}} -no feature defined-
{{Feature|test}} -unknown feature ("test") defined-
{{Feature|afm}}
Advanced Helicopter Flight Model
For this command to have any effect, the Advanced Flight Model (AFM) has to be enabled. AFM status can be checked with difficultyEnabledRTD.
{{Feature|afm|Hello there!}}
Advanced Helicopter Flight Model
Hello there!
{{Feature|ofp}}
Operation Flashpoint
This is an Arma: Cold War Assault feature.
{{Feature|ofp|Hello there!}}
Operation Flashpoint
Hello there!
{{Feature|arma0}}
Operation Flashpoint
This is an Arma: Cold War Assault feature.
{{Feature|arma0|Hello there!}}
Operation Flashpoint
Hello there!
{{Feature|ofpe}}
Operation Flashpoint: Elite
This is an Operation Flashpoint: Elite feature.
{{Feature|ofpe|Hello there!}}
Operation Flashpoint: Elite
Hello there!
{{Feature|arma1}}
Armed Assault
This is an ArmA: Armed Assault feature.
{{Feature|arma1|Hello there!}}
Armed Assault
Hello there!
{{Feature|arma2}}
Arma 2
This is an Arma 2 feature.
{{Feature|arma2|Hello there!}}
Arma 2
Hello there!
{{Feature|arma2oa}}
Arma 2: Operation Arrowhead
This is an Arma 2: Operation Arrowhead feature.
{{Feature|arma2oa|Hello there!}}
Arma 2: Operation Arrowhead
Hello there!
{{Feature|arma3}}
Arma 3
This is an Arma 3 feature.
{{Feature|arma3|Hello there!}}
Arma 3
Hello there!
{{Feature|arma3contact}}
enoch icon ca.png
This content is exclusive to the Arma 3 Contact Expansion.
{{Feature|arma3contact|Hello there!}}
enoch icon ca.png
Hello there!
{{Feature|arma3oldman}}
arma3apex oldman logo simplyfied white.png
This function is used by the Arma 3 Apex: Old Man content. It might only work properly inside this scenario.
{{Feature|arma3oldman|Hello there!}}
arma3apex oldman logo simplyfied white.png
Hello there!
{{Feature|armaR}}
Arma Reforger
This is an Arma Reforger feature.
{{Feature|armaR|Hello there!}}
Arma Reforger
Hello there!
{{Feature|arma4}}
Arma 4
This is an Arma 4 feature.
{{Feature|arma4|Hello there!}}
Arma 4
Hello there!
{{Feature|dayz}}
DayZ
This is a DayZ feature.
{{Feature|dayz|Hello there!}}
DayZ
Hello there!
{{Feature|eden editor}}
Eden Editor
This is an Eden Editor feature.
{{Feature|eden editor|Hello there!}}
Eden Editor
Hello there!
{{Feature|gamepad}}
␼
-Text not defined-
{{Feature|gamepad|Hello there!}}
␼
Hello there!
{{Feature|GVI}}
?
-no game provided-
{{Feature|GVI|ofp}}
This feature was introduced with Operation Flashpoint.
{{Feature|GVI|ofp|1.75}}
This feature was introduced with Operation Flashpoint v1.75.
{{Feature|GVI|ofp|1.75|Great game!}}
Great game!
{{Feature|important}}
⚠
-Text not defined-
{{Feature|important|Hello there!}}
⚠
Hello there!
{{Feature|informative}}
ⓘ
-Text not defined-
{{Feature|informative|Hello there!}}
ⓘ
Hello there!
{{Feature|keyboard}}
␽
-Text not defined-
{{Feature|keyboard|Hello there!}}
␽
Hello there!
{{Feature|obsolete}}
🕖
This information is obsolete.
{{Feature|obsolete|Hello there!}}
🕖
This information is obsolete. Reason: Hello there!
{{Feature|obsolete|Hello there!|arma2}}
🕖
This information is obsolete as of Arma 2. Reason: Hello there!
{{Feature|obsolete|Hello there!|arma2|1.03}}
🕖
This information is obsolete as of Arma 2 v1.03. Reason: Hello there!
{{Feature|PC}}
␿
This is a PC feature.
{{Feature|PC|Hello there!}}
␿
Hello there!
{{Feature|playstation}}
This is a PlayStation® feature.
{{Feature|playstation|Hello there!}}
Hello there!
{{Feature|quote}}
«
-Text not defined-
{{Feature|quote|Hello there!}}
«
« Hello there! »
{{Feature|quote|Hello there!|General Kenobi}}
«
« Hello there! » – General Kenobi
{{Feature|quote|Hello there!|General Kenobi|Conversations}}
«
« Hello there! » – General Kenobi (source)
{{Feature|quote|Hello there!|General Kenobi|http://www.youtube.com/watch?v{{=}}rEq1Z0bjdwc}}
«
« Hello there! » – General Kenobi (source)
{{Feature|spoiler}}
Spoiler Warning
The following text contains game spoilers such as story details or mission walkthroughs. Read at your own risk!
{{Feature|spoiler|Hello there!}}
Spoiler Warning
The following text contains game spoilers such as story details or mission walkthroughs. Read at your own risk!
The potential spoilers concern the following topic: Hello there!.
{{Feature|steam}}
Steam icon logo.png
This is a Steam feature.
{{Feature|steam|Hello there!}}
Steam icon logo.png
Hello there!
{{Feature|tkoh}}
Take On Helicopters
This is a Take On Helicopters feature.
{{Feature|tkoh|Hello there!}}
Take On Helicopters
Hello there!
{{Feature|UnsupportedDoc}}
bi symbol white.png
Disclaimer: This page describes internal undocumented structures of Bohemia Interactive software.

This page contains unofficial information.

Some usage of this information may constitute a violation of the rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.
Bohemia Interactive is not willing to tolerate use of such tools if it contravenes any general licenses granted to end users of this community wiki or BI products.
{{Feature|UnsupportedDoc|Hello there!}}
bi symbol white.png
Disclaimer: This page describes internal undocumented structures of Bohemia Interactive software.

This page contains unofficial information.

Some usage of this information may constitute a violation of the rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.
Bohemia Interactive is not willing to tolerate use of such tools if it contravenes any general licenses granted to end users of this community wiki or BI products.
{{Feature|UnsupportedTool}}
bi symbol white.png
Disclaimer: This page describes an unofficial tool created without permission or support of Bohemia Interactive.

The product itself and its usage may be violating rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.

See also Official Tools.
{{Feature|UnsupportedTool|Hello there!}}
bi symbol white.png
Disclaimer: This page describes an unofficial tool created without permission or support of Bohemia Interactive.

The product itself and its usage may be violating rights of Bohemia Interactive and is in no way endorsed or recommended by Bohemia Interactive.

See also Official Tools.
{{Feature|warning}}
⚠
-Text not defined-
{{Feature|warning|Hello there!}}
⚠
Hello there!
{{Feature|xbox}}
This is an Xbox® feature.
{{Feature|xbox|Hello there!}}
Hello there!
{{Feature|ylands}}
Ylands
This is a Ylands feature.
{{Feature|ylands|Hello there!}}
Ylands
Hello there!

No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
name1

name of the feature used for the messagebox

Suggested values
AFM ofp arma0 ofpe arma1 arma2 arma2oa arma3 arma3contact arma3oldman armaR arma4 dayz Eden Editor gamepad GVI keyboard important informative obsolete quote playstation spoiler tkoh UnsupportedDoc UnsupportedTool warning xbox ylands
Auto value
informative
Stringrequired
22

no description

Unknownoptional
33

no description

Unknownoptional
44

no description

Unknownoptional
messagemessage

no description

Unknownoptional
Retrieved from "https://community.bistudio.com/wiki?title=Template:Feature&oldid=365022"