From Valve Developer Community
Jump to: navigation, search

Entity description

Can fire rocket-propelled grenades or other missiles with many property customizations. The missiles can be made to home on a target or follow a path.


  • BaseNPC:

Target Path Corner <targetname>
The path_corner that this NPC will move to after spawning.
Squad Name <string>
NPCs that are in the same squad (i.e. have matching squad names) will share information about enemies, and will take turns attacking and covering each other.
Hint Group <string>
Hint groups are used by NPCs to restrict their hint-node searching to a subset of the map's hint nodes. Only hint nodes with matching hint group names will be considered by this NPC.
Hint Limit Nav <boolean>
Limits NPC to using specified hint group for navigation requests, but does not limit local navigation.
Sleep State <choices>
Holds the NPC in stasis until specified condition. See also 'Wake Radius' and 'Wake Squad'.
  • 0: None
  • 1: Waiting for threat
  • 2: Waiting for PVS
  • 3: Waiting for input, ignore PVS
  • 4: Auto PVS
  • 5: Auto PVS after PVS
Wake Radius <float>
Auto-wake if player within this distance
Wake Squad <boolean>
Wake all of the NPCs squadmates if the NPC is woken
Enemy Filter <targetname>
Filter entity to test targets against
Ignore unseen enemies <boolean>
Prefer visible enemies, regardless of distance or relationship priority
Physics Impact Damage Scale <float>
Scales damage energy when this character is hit by a physics object. With a value of 0 the NPC will take no damage from physics.


Damage Filter <targetname>
Name of the filter_damage_type entity that controls which entities can damage us.


Response Contexts <string>
Pre-defined response system contexts for this entity. Format is key:value,key:value,...


Disable shadows <boolean>
Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
Disable ShadowDepth <boolean> (New with Portal 2)
Used to disable rendering into shadow depth (for projected textures) for this entity.
Projected Texture Cache <choices> (New with Portal 2)
Used to hint projected texture system whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead.
  • 0 : Default
  • 1 : No cache - render every frame
  • 2 : Cache it - render only once
Disable flashlight <boolean> (New with Portal 2)
Used to disable projected texture lighting and shadows on this entity.


Render Mode <choices>
Set a non-standard rendering mode on this entity. See Render Modes for details.
FX Amount (0 - 255) <int>
Intensity of the selected render mode.
FX Color (R G B) <color255>
Color used by the selected render mode (if applicable).
Disable Receiving Shadows <bool>
Prevents the entity from receiving shadows.


Render FX <choices>
Several GoldSrc-era visibility modes which change the way the entity is rendered, typically by fading it in and out.


Pitch Yaw Roll (Y Z X) <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.


Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with Left 4 Dead 2)
Name(s) of script files that are executed after all entities have spawned.
Script think function <string> (New with Left 4 Dead 2)
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.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.
  • Parentname:

Parent <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent.
  • StartOn
  • MissileModel
  • LaunchSound
  • FlySound
  • SmokeTrail
Literal Value Description
0 Off
1 On
2 On Homing
  • LaunchSmoke
  • LaunchDelay
<integer> When ON, how long to wait between each launch
  • LaunchSpeed
<float> Initial launch speed of missile (in up direction)
  • PathCornerName
<target_destination> Name of a path corner. If set launches a pathfollowing missing, rather than a homing missile
  • HomingSpeed
<float> Speed to reach when homing
  • HomingStrength
<integer> How strong in homing effect (0-100). Higher values yield sharper turning ability.
  • HomingDelay
<float> Number of seconds to delay before homing starts
  • HomingRampUp
<float> Number of seconds it takes to reach full homing strength after homing delay
  • HomingDuration
<float> Number of seconds the homing effect lasts
  • HomingRampDown
<float> Number of seconds it takes homing effect to decay after homing duration
  • Gravity
<float> Scale for effect of gravity. (1.0 = normal gravity)
  • MinRange
<float> Minimun distance a target can be to be attacked
  • MaxRange
<float> Maximum distance a target can be to be attacked
  • SpinMagnitude
<float> Strength of spin in missile trajectory
  • SpinSpeed
<float> How fast does the spin rotate through 360
  • Damage
<float> How much damage does each missile do
  • DamageRadius


  • 1 : Wait Till Seen
  • 2 : Gag :No IDLE sounds until angry
  • 4 : Fall to ground :Unchecked means *teleport* to ground
  • 8 : Drop Healthkit
  • 16 : Efficient - Don't acquire enemies or avoid obstacles
  • 128 : Wait For Script
  • 256 : Long Visibility/Shoot
  • 512 : Fade Corpse
  • 1024 : Think outside PVS
  • 2048 : Template NPC: This entity is a template for the npc_template_maker. It will not spawn automatically and cannot be used with point_template.
  • 4096 : Do Alternate collision for this NPC (player avoidance)
  • 8192 : Don't drop weapons
  • 16384 : Ignore player push : Dont give way to player
  • 65536  : Check LOS


  • BaseNPC:

SetRelationship <string|targetname or classname> <string|disposition> <int|rank>
Changes whether this NPC likes or dislikes certain others. Used like the ai_relationship entity, with this NPC as the subject.
Values for disposition are:
  • D_HT: Hate
  • D_FR: Fear
  • D_LI: Like
  • D_NU: Neutral
SetHealth <int>
Set the NPC's health.
AddHealth <int> (New with Source 2007)
RemoveHealth <int> (New with Source 2007)
Add to or remove from the NPC's health.
SetBodyGroup <int>
Sets this NPC's body group (from 0 - n).
physdamagescale <float>
Scales the damage taken when this character is hit by a physics object. 0 means this feature is disabled for backwards compatibility.
Burst into flames.
IgniteLifetime <float>
Ignite for the given number of seconds.
IgniteNumHitboxFires <int>
Ignite with the given number of hitbox fires.
IgniteHitboxFireScale <float>
Ignite with the given hitbox fire scale.
Smash into pieces. If this is not possible, disappear.
BecomeRagdoll (New with Source 2007)
Remove itself and become a ragdoll.
Enter/exit scripting state, where NPCs ignore a variety of stimulus that would make them break out of their scripts. They ignore danger sounds, ignore +USE, don't idle speak or respond to other NPC's idle speech, and so on.
Assault <targetname>
Start an assault at the given rally point.
SetSquad <string>
Change the name of this NPC's squad. Leaving the parameter blank will remove the NPC from any existing squad.
Wakes up the NPC if it is sleeping.
ForgetEntity <targetname>
Clears out the NPC's knowledge of a named entity.
Gagged NPCs won't speak (or moan, caw, etc.) unless made to be a choreographed scene.
IgnoreDangerSounds <float>
Ignore danger sounds for the specified number of seconds.
Force the NPC to holster or unholster their weapon. Ignored if the NPC is scripting or if the NPC doesn't use weapons.
As HolsterWeapon, except the weapon is destroyed once it has been concealed.
ForceInteractionWithNPC <string>
Force the NPC to use a dynamic interaction with another NPC. Syntax is <targetname> <dynamic interaction>.
UpdateEnemyMemory <targetname>
Update (or create) this NPC's memory of of the given entity.


Alpha  <integer>
Set the sprite's alpha (0 - 255).
Color  <color255>
Set the sprite's color (R G B).


SetDamageFilter  <string>
Sets the entity to use as damage filter. Pass in an empty string ("") to clear the damage filter.


AddContext <string>
Adds to the entity's list of response contexts. Format is <key>:<value>.
RemoveContext <string>
Remove a context from this entity's list. The name should match the key of an existing context.
Removes all contexts from this entity's list.


Turn shadow off.
Turn shadow on.
DisableReceivingFlashlight  (New with Portal 2)
This object will not receive light or shadows from projected textures.
EnableReceivingFlashlight  (New with Portal 2)
This object may receive light or shadows from projected textures.


Removes this entity from the world.
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 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile  <script> (New with Left 4 Dead 2)
Execute a game script file from disk.
RunScriptCode  <string> (New with Left 4 Dead 2)
Execute a string of script source code. String quotation may be needed when fired via console.
Note:The code is executed in the script scope of the entity that fires the output, not the one of the targeted entity.
Warning:Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction  <string> (New with Left 4 Dead 2)
Execute a game script function.
  • Parentname:

SetParent  <string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment  <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  <string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
Removes this entity from the the movement hierarchy, leaving it free to move independently.
  • TurnOn
Turn on Launcher
  • TurnOff
Turn off Launcher
  • LOSCheckOn
Start checking line of sight before firing
  • LOSCheckOff
Stop checking line of sight before firing
  • SetEnemyEntity
Set entity I should attack. Ignores visibility. (output from other entity only)
  • ClearEnemyEntity
Clear set enemy enemy
  • FireOnce
Fire Once (if have enemy)


  • BaseNPC:

Fired when this NPC takes damage (activator is the damage inflictor)
Fired when this NPC is killed (activator is the killer)
Fired when this NPC reaches half of its maximum health
Fired when this NPC hears a sound (other than combat or the player)
Fired when this NPC hears the player
Fired when this NPC hears combat sounds
OnFoundEnemy <targetname>
Fired when this NPC establishes line of sight to its enemy
Fired when this NPC loses line of sight to its enemy
Fired when this NPC loses its enemy. Usually due to the enemy being killed/removed, or because this NPC has selected a newer, more dangerous enemy
OnFoundPlayer <targetname>
Fired when this NPC establishes line of sight to its enemy, and that enemy is a player
Fired when this NPC loses line of sight to its enemy, and that enemy is a player
Fired when this NPC loses its enemy, and that enemy was a player. Usually due to the enemy being killed/removed, or because this NPC has selected a newer, more dangerous enemy
Fired when this NPC is hurt by a player (activator is the attacker or vehicle driver (if friendly fire))
Fired when this NPC is hurt by a player OR by one of the player's squadmates (activator is the attacker or vehicle driver (if friendly fire))
Fired when this NPC has refused to join the player's squad
Fired when this NPC comes out of a sleep state
OnUser1 to OnUser4
These Outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.

(New with Left 4 Dead)

This Output fires when the entity is killed and removed from the game.
  • OnLaunch
Fires when missile is launched. (activator is the enemy launched at)


The default values of the MissileModel and FlySound properties point to resources that do not exist. Appropriate values would be models/Weapons/W_missile.mdl and weapons/rpg/rocket1.wav, respectively.