Entity Article Template: Difference between revisions
m (revert) |
m (reworked) |
||
Line 16: | Line 16: | ||
== Keyvalues - omit if none exist == | == Keyvalues - omit if none exist == | ||
* {{kv targetname}} | * {{kv targetname}} | ||
<!-- Source found at [[Template:KV Targetname]] --> | <!-- Source found at [[Template:KV Targetname]] --> | ||
Line 40: | Line 37: | ||
Instead of this: | Instead of this: | ||
:* ''' | :* '''ExampleChoices''' | ||
:: <choices> Omittable Description | :: <choices> Omittable Description | ||
::{| | ::{| | ||
! Literal Value || Description | ! Literal Value || Description | ||
|- | |- | ||
| 0 || | | 0 || Choice 1 | ||
|- | |- | ||
| 1 || | | 1 || Choice 2 | ||
|} | |} | ||
* '''keyname''' | |||
: <type of value> Replace this with a description of what the key is used for. | |||
But not for this: | But not for this: | ||
Line 70: | Line 70: | ||
== Inputs - omit if none exist == | == Inputs - omit if none exist == | ||
* {{i targetname}} | |||
* {{i parentname}} | |||
* '''Intput Name''' | * '''Intput Name''' | ||
: Replace this with a description of the Input. | : Replace this with a description of the Input. | ||
== Outputs - omit if none exist == | |||
* {{i targetname}} | * {{i targetname}} | ||
* '''Output Name''' | * '''Output Name''' | ||
: Omittable Description | : Omittable Description | ||
== See also == | == See also == |
Revision as of 23:59, 12 December 2007
Entity description
Description of the entity goes here. 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.
The quick brown fox jumps over the lazy dog. 1234567890. Description of entity goes here, blah blah. The quick brown fox jumps over the lazy dog. 1234567890. Description of entity goes here, blah blah. The quick brown fox jumps over the lazy dog. 1234567890.
For an NPC's inputs, outputs etc. the 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
- Omittable Description
- sk_barney_health
- <integer> Barney's spawn health
Keyvalues - omit if none exist
- rendercolor
- ⇆#000000rgb(0,0,0)⇆ The color of the spotlight cone.
Use this:
- ExampleYesNo
- <boolean> Omittable Description
Instead of this:
- ExampleChoices
- <choices> Omittable Description
Literal Value Description 0 Choice 1 1 Choice 2
- keyname
- <type of value> Replace this with a description of what the key is used for.
But not for this:
- ExampleYesNo
- <choices> Omittable Description
Literal Value Description 0 Yes 1 No
Flags - omit if none exist
- Integer value : Flag Name
- Omissible description
- Integer value : Flag Name
- Omissible description
Inputs - omit if none exist
- Template:I targetname
- Template:I parentname
- Intput Name
- Replace this with a description of the Input.
Outputs - omit if none exist
- Template:I targetname
- Output Name
- Omittable Description
See also

- Assaults - appropriate links to tutorials, related articles and entities etc.
- ambient_generic