env_headcrabcanister

From Valve Developer Community

Contents 1 Entity description 2 Dedicated CVars 3 Keyvalues 4 Flags 5 Inputs 6 Outputs

Entity description

Headcrab Canister.

The canister is a mortar shell containing a payload of headcrabs. The mortar shell inflicts damage within a radius of where it lands and releases headcrabs after impact. Triggers and entity options offer control over impact damage and when the headcrabs are released, among other options.

For an example of their use, see the shantytown in d1_canals_05.

Dedicated CVars

• sk_env_headcrabcanister_shake_amplitude

<float> Crash effect's shake amplitude

• sk_env_headcrabcanister_shake_radius

<float> Crash effect's shake radius

• sk_env_headcrabcanister_shake_radius_vehicle

<float> Crash effect's shake radius for vehicles

Keyvalues

• targetname <string>

The name that other entities refer to this entity by.

• hammerid <integer> (New with Orange Box)

Read-only ID used for debugging purposes in Hammer.

• parentname <target_destination>

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

• angles <angle>

Pitch Yaw Roll (Y Z X)

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

• HeadcrabType

<choices>

Literal Value	Description
0	Normal headcrabs
1	Fast Headcrabs
2	Poison Headcrabs

• HeadcrabCount

<integer> Number of headcrabs to spawn on impact

• FlightSpeed

<float> Speed to fly through the air

• FlightTime

<float> Time to fly through the air in seconds

• StartingHeight

<float> Relative height from the landing position at which the canister should be launched. Positive values mean launch it above the impact point, negative values mean launch it below.

• MinSkyboxRefireTime

<float> Min number of seconds before the canister is refired. This will only work for canisters placed in the skybox.

• MaxSkyboxRefireTime

<float> Max number of seconds before the canister is refired. This will only work for canisters placed in the skybox.

• SkyboxcanisterCount

<integer> Number of canisters to fire in the skybox (0 means fire continuously, forever).

• Damage

<float> Max damage the canister applies on impact

• DamageRadius

<float> Max radius of the impact damage for the canister

• SmokeLifetime

<float> Duration that the canister smokes. -1 means always smoke.

• LaunchPositionName (New with Episode One)

<target_destination> If the canister should launch to its origin from another point within the world, this should specify an info_target at the launch origin.

Flags

• 1 : No Impact Sound

• 2 : No Launch Sound

• 4096 : Start Impacted

• 8192 : Land at initial position

• 16384 : Wait for input to open

• 32768 : Wait for input to spawn headcrabs

• 65536 : No smoke

• 131072 : No shake

• 262144 : Remove on impact

• 524288 : No impact effects

Inputs

• 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> (New with Episode One)

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.

• ClearParent

Removes this entity from its current movement hierarchy.

• FireCanister

• OpenCanister

Opens the canister (must be called after the OnImpacted output is fired)

• SpawnHeadcrabs

Spawns headcrabs (must be called after the OnImpacted output is fired and after OpenCanister is triggered, if the Wait for Input to open spawnflag is checked.)

• StopSmoke

Outputs

• OnUser1-4

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.

!activator = activator

• OnKilled (New with Left 4 Dead)

Fired when the entity is killed and removed from the game.

• OnLaunched <targetname>

Fired when the canister is launched. The targetname is of the canister.

• OnImpacted

Fires when canister hits the ground

• OnOpened

Fires when canister has finished opening