Entity Article Template

From Valve Developer Community
Revision as of 22:11, 26 August 2005 by Pon (talk | contribs)
Jump to navigation Jump to search

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
#000000 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
Omittable Description
  • Integer value : Flag Name
Omittable 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