Entity Article Template: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 9: Line 9:
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]].


==Keyvalues==
==Keyvalues - Omit if none exist==


* '''keyname'''
* '''keyname'''
Line 25: Line 25:
: <color255> The color of the spotlight cone.
: <color255> The color of the spotlight cone.


==Flags==
Use this:
 
:* '''ExampleYesNo'''
:: {{boolean}} Omittable Description
 
Instead of this:
 
:* '''ExampleYesNo'''
:: <choices> Omittable Description
::{|
! Literal Value || Description
|-
| 0 || No
|-
| 1 || Yes
|}
 
==Flags - Omit if none exist==


* Integer value - Flag Name
* Integer value - Flag Name
Line 33: Line 50:
: Replace this with a description of the flag (if needed).
: Replace this with a description of the flag (if needed).


==Inputs==
==Inputs - Omit if none exist==


* '''Intput Name'''
* '''Intput Name'''
Line 42: Line 59:
* {{i parentname}}
* {{i parentname}}


==Outputs==
==Outputs - Omit if none exist==


* '''Output Name'''
* '''Output Name'''

Revision as of 10:16, 12 July 2005

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.

Keyvalues - Omit if none exist

  • keyname
<type of value> Replace this with a description of what the key is used for.
  • rendercolor
<color255> 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

Flags - Omit if none exist

  • Integer value - Flag Name
Replace this with a description of the flag (if needed).
  • Integer value - Flag Name
Replace this with a description of the flag (if needed).

Inputs - Omit if none exist

  • Intput Name
Replace this with a description of the Input.

Outputs - Omit if none exist

  • Output Name
Replace this with a description of the Output.

See Also