Entity Article Template: Difference between revisions
Jump to navigation
Jump to search
Note:Add links to related articles, entities, or tutorials here.
mNo edit summary |
m (cleanup) |
||
| Line 1: | Line 1: | ||
==Entity | == 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]]. | 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]]. | ||
| Line 9: | Line 8: | ||
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]]. | 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 - | == Dedicated Console Variables - omit if none exist == | ||
* '''cvar_name''' | * '''cvar_name''' | ||
: <data type> Omittable Description | : <data type> Omittable Description | ||
| Line 17: | Line 15: | ||
: <integer> Barney's spawn health | : <integer> Barney's spawn health | ||
==Keyvalues - | == Keyvalues - omit if none exist == | ||
* '''keyname''' | * '''keyname''' | ||
: <type of value> Replace this with a description of what the key is used for. | : <type of value> Replace this with a description of what the key is used for. | ||
| Line 65: | Line 62: | ||
|} | |} | ||
==Flags - | == Flags - omit if none exist == | ||
* Integer value : Flag Name | * Integer value : Flag Name | ||
: | : Omissible description | ||
* Integer value : Flag Name | * Integer value : Flag Name | ||
: | : Omissible description | ||
== Inputs - omit if none exist == | |||
* '''Intput Name''' | * '''Intput Name''' | ||
: Replace this with a description of the Input. | : Replace this with a description of the Input. | ||
| Line 82: | Line 77: | ||
* {{i parentname}} | * {{i parentname}} | ||
==Outputs - | == Outputs - omit if none exist == | ||
* '''Output Name''' | * '''Output Name''' | ||
: Omittable Description | : Omittable Description | ||
| Line 89: | Line 83: | ||
* {{i targetname}} | * {{i targetname}} | ||
==See | == See also == | ||
{{note|Add links to related articles, entities, or tutorials here.}} | |||
* [[Assaults]] - appropriate links to tutorials, related articles and entities etc. | * [[Assaults]] - appropriate links to tutorials, related articles and entities etc. | ||
* [[ambient_generic]] | * [[ambient_generic]] | ||
[[Category:Entities]] | [[Category:Entities]] | ||
Revision as of 01:38, 11 October 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
- keyname
- <type of value> Replace this with a description of what the key is used for.
- rendercolor
- ⇆#000000rgb(0,0,0)⇆ The color of the spotlight cone.
Use this:
- ExampleYesNo
- <boolean> Omittable Description
Instead of this:
- ExampleYesNo
- <choices> Omittable Description
Literal Value Description 0 No 1 Yes
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
- Intput Name
- Replace this with a description of the Input.
Outputs - omit if none exist
- Output Name
- Omittable Description
See also
Note:Add links to related articles, entities, or tutorials here.- Assaults - appropriate links to tutorials, related articles and entities etc.
- ambient_generic