Generic Keyvalues, Inputs and Outputs/Keyvalues

This template is our holder for all keyvalues that are assigned through CBaseEntity. The template has a very specific syntax that you must follow to apply properly, because new games have added new features throughout the years. See Help:Templates for more info on named parameters.

{{KV BaseEntity}}

No parameters: display keyvalues for ALL games.

{{KV BaseEntity|base=1}}

Base: display keyvalues that have only existed since whatever game added the class (most have existed since HL2, the first Source game).

{{KV BaseEntity|l4d2=1}}

Game as a parameter: display the keyvalues that base displays, AND keyvalues that were added to the class, by the specified game. You can specify as many games as needed. You must specify ALL the games you want to include (e.g. l4d2 will not automatically include l4d keyvalues as well). This is because there are situations like in Portal 2, where the output OnKilled is not available through CBaseEntity, despite being a far descendant of the L4D branch which added it.

All parameters for this template:

• base
• l4d
• l4d2
• as
• csgo

Note:If you want to edit something on this template, please make sure you edit it in both places. Per-game keyvalues are duplicated, for complex technical reasons.

For full documentation on this family of templates, see FGD Template Prototype. Still confused on something? Ask for help before editing this template.

---

Classname (classname) ([todo internal name (i)]) <string>

The classname defines the type of entity. Classnames can be changed using AddOutput, which will influence how the engine deals with the entity in certain circumstances.

Name (targetname) ([todo internal name (i)]) <string>

The name that other entities refer to this entity by.

Global Entity Name (globalname) ([todo internal name (i)]) <string>

Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.

Parent (parentname) ([todo internal name (i)]) <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. Every entity can be parented, even point entities. Some entities which aren't intended to be parented may not function correctly. phys_constraint can be used as a workaround to parenting.

Warning:In Counter-Strike: Source, parenting this entity to another can break the map.

Origin (X Y Z) (origin) ([todo internal name (i)]) <origin>

The position of this entity's center in the world. Rotating entities typically rotate around their origin.

Pitch Yaw Roll (X Y Z) (angles) ([todo internal name (i)]) <angle>

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.

Note:This works on brush entities, although Hammer doesn't show the new angles.

Effects (effects) ([todo internal name (i)]) <string> !FGD

Effect flags.

Response Contexts (ResponseContext) ([todo internal name (i)]) <string>

Pre-defined response system contexts for this entity. Format is key:value,key:value,...

Hammer ID (hammerid) ([todo internal name (i)]) <string> !FGD

The entity's Hammer ID. Mainly used by plugins and debugging commands, such as ent_keyvalue.

Minimum CPU Level (mincpulevel) ([todo internal name (i)]) <integer> (in all games since ) !FGD

Minimum CPU Level allowed for this entity. 0 means all levels allowed.

Maximum CPU Level (maxcpulevel) ([todo internal name (i)]) <integer> (in all games since ) !FGD

Maximum CPU Level allowed for this entity. 0 means all levels allowed.

Minimum GPU Level (mingpulevel) ([todo internal name (i)]) <integer> (in all games since ) !FGD

Minimum GPU Level allowed for this entity. 0 means all levels allowed.

Maximum GPU Level (maxgpulevel) ([todo internal name (i)]) <integer> (in all games since ) !FGD

Maximum GPU Level allowed for this entity. 0 means all levels allowed.

Todo: Better description for all of these.

Disable for Xbox 360 (disableX360) ([todo internal name (i)]) <boolean> (in all games since ) !FGD

If Yes, disables this entity on the Xbox 360 version of Source.

Glow Backface Multiple (glowbackfacemult) ([todo internal name (i)]) <string> (in all games since ) !FGD

Entity Scripts (vscripts) ([todo internal name (i)]) <scriptlist> (in all games since )

Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.

Script think function (thinkfunction) ([todo internal name (i)]) <string> (in all games since )

Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call. Try to avoid expensive operations in this function, as it may cause performance problems.

Lag Compensation (LagCompensate) ([todo internal name (i)]) <boolean> (in all games since )

Set to Yes to lag compensate this entity. Should be used very sparingly!

Is Automatic-Aim Target (is_autoaim_target) ([todo internal name (i)]) <boolean> (in all games since ) !FGD

If yes, automatic-aim assistance will target this entity.