Entity Article Template

From Valve Developer Community

Table of contents

1 Entity description

2 Dedicated Console Variables - omit if none exist

3 Keyvalues - omit if none exist

4 Flags - omit if none exist

5 Inputs - omit if none exist

6 Outputs - omit if none exist

7 See also

[edit]

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.

[edit]

Dedicated Console Variables - omit if none exist

cvar_name

<data type> Omittable Description

sk_barney_health

<integer> Barney's spawn health

[edit]

Keyvalues - omit if none exist

targetname <target_source>

Defines the name that other entities refer to this entity by.

hammerid [Episode Two Update]

<integer readonly> This id is used for debugging purposes in Hammer.

parentname <target_destination>

Specifies the targetname of this entity's Parent in a movement hierarchy. Child entities move with their Parent.

angles <angle>

Pitch Yaw Roll (Y Z X)

This entity's angular orientation in the world (also used for angular effect entities).

mindxlevel

<choices> Minimum DX Level

Literal Value	Description
0	default (lowest)
70	dx7

maxdxlevel

<choices> Maximum DX Level

Literal Value	Description
0	default (lowest)
60	dx6

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

But not for this:

ExampleYesNo

<choices> Omittable Description

Literal Value	Description
0	Yes
1	No

keyname

<type of value> Replace this with a description of what the key is used for.

[edit]

Flags - omit if none exist

Integer value : Flag Name

Omissible description

Integer value : Flag Name

Omissible description

[edit]

Inputs - omit if none exist

Kill

Removes this entity from the world.

KillHierarchy

Removes this entity and all its children from the world.

AddOutput <string>

Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.

Format: <key> <value>

Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>

FireUser1-4

Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.

SetParent <target_destination>

Changes the entity's parent in the movement hierarchy.

SetParentAttachment <string>

Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.

SetParentAttachmentMaintainOffset <string> [Episode One Update]

Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the Parent's Origin and Angles at the time it is attached.