Entity Article Template

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

• Template:Kv targetname

Parentname:

Parent (parentname) <targetname>

Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.

Pitch Yaw Roll (Y Z X) (angles) <QAngle>

This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

Minimum / Maximum DX Level (mindxlevel / maxdxlevel) <integer choices> (removed since )

The entity will not exist if the engine is running outside the given range of DirectX Versions.

Choices

Warning:If these are used, the object may break when the user switches their DirectX settings.[missing string] 0 - Default (no bounding) 60 - DirectX 6 (!FGD for mindxlevel) 70 - DirectX 7 80 - DirectX 8 (GeForce4 Ti & FX 5000 series) 81 - DirectX 8.1 (GeForce FX 5800, 5900 & Radeon 8500/9100 and 9000/9200) 90 - DirectX 9 Shader Model 2 92 - OpenGL аналогичен DirectX 9 Shader Model 2 (using ToGL; only) !FGD 95 - DirectX 9 Shader Model 3 (in all games since ) 98 - DirectX 9 Shader Model 3 on Xbox 360 ( only) !FGD

• 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

• keyname

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

Flags - omit if none exist

• Integer value : Flag Name

Omissible description

• Integer value : Flag Name

Omissible description

Inputs - omit if none exist

Parentname:

SetParent <stringRedirectInput/string>

Move with this entity. See Entity Hierarchy (parenting).

SetParentAttachment <stringRedirectInput/string>

Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.

SetParentAttachmentMaintainOffset <stringRedirectInput/string>

As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.

ClearParent

Removes this entity from the the movement hierarchy, leaving it free to move independently.

• 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