Difference between revisions of "Entity Article Template"

From Valve Developer Community
Jump to: navigation, search
(Does displaytitle even work?)
(blanking for now)
Line 1: Line 1:
<nowiki>{{{<game acronym> <point/brush>|<entity class name>}}}</nowiki>
+
{{construction-notice|Due to other major edits currently occurring, this page will not be available for a while. We are working very hard to get everything sorted out as fast and as well as possible.}}
{{syntax2
 
|in=<nowiki>{{css point|ammo_57mm}}</nowiki>
 
|out={{css}} '''ammo_57mm''' is a [[point entity]] available in [[Counter-Strike: Source]].
 
}}
 
{{tip|If the entity is available everywhere, use "base" as game acronym.}}
 
 
 
== Entity description ==
 
This should be a plainly-worded but accurate description of the basic function of the entity. A basic description for most entities is included in the help built into [[Hammer]].
 
 
 
For an NPC's inputs, outputs etc. the [[Npc_sniper|npc_sniper]] article could be handy. Many of the details seem the same for different NPCs, so it could save typing.
 
 
 
The information for the entity Keys, Outputs, and Inputs can be found inside the Hammer entity help, or in the [[FGD]]. Flag names can only be found in the [[FGD]].
 
 
 
== Dedicated Console Variables - omit if none exist ==
 
; cvar_name <data type>
 
: Omittable Description
 
; sk_barney_health <integer>
 
: Barney's spawn health
 
 
 
== Keyvalues - omit if none exist ==
 
{{tip|See [[:Category:Keyvalue Templates]] for a list of available templates.}}
 
{{KV|Keyvalue Name|vartype|A description of the Keyvalue.}}
 
{{KV|Brightness|color255|The color of the spotlight cone.}}
 
 
 
=== {{Game link|Half-Life 2}} ===
 
{{tip| Use <nowiki>=== {{Game link|Game Name}} ===</nowiki> to sort Keyvalues that exist only in selected games.}}
 
{{KV Targetname}}
 
{{KV Parentname}}
 
{{KV Angles}}
 
{{KV DXLevelChoice}}
 
 
 
== Flags - omit if none exist ==
 
{{tip|See [[:Category:Flag Templates]] for a list of available templates.}}
 
 
 
* Integer value : Flag Name
 
: Omissible description
 
* Integer value : Flag Name
 
: Omissible description
 
 
 
== Inputs - omit if none exist ==
 
{{tip|See [[:Category:Input Templates]] for a list of available templates.}}
 
 
 
{{IO|Input Name|A description of the Input.|param=vartype}}
 
{{IO|SetSpeed|Set the speed of the train, as a ratio of max speed [0, 1]|param=float}}
 
{{I Targetname}}
 
{{I Parentname}}
 
 
 
== Outputs - omit if none exist ==
 
{{tip|See [[:Category:Output Templates]] for a list of available templates.}}
 
 
 
{{IO|Output Name|A description of the Input.}}
 
{{IO|OnPressed|Fired when the button is pressed.}}
 
{{O Targetname}}
 
 
 
== See also ==
 
{{note|Add links to related articles, entities, or tutorials here.}}
 
 
 
* [[Assaults]] - appropriate links to tutorials, related articles and entities etc.
 
* [[ambient_generic]]
 
 
 
[[Category:Entities]]
 

Revision as of 16:51, 24 July 2018

Under construction.png Due to other major edits currently occurring, this page will not be available for a while. We are working very hard to get everything sorted out as fast and as well as possible.