Env headcrabcanister: Difference between revisions
Jump to navigation
Jump to search
VimonElrac (talk | contribs) No edit summary |
m (Classifying as model entity) |
||
| (33 intermediate revisions by 17 users not shown) | |||
| Line 1: | Line 1: | ||
{{LanguageBar}} | |||
{{CD|CEnvHeadcrabCanister|file1=env_headcrabcanister.cpp}} | |||
[[File:Headcrabcanister.jpg|frame|right]] | |||
{{this is a|model entity|name=env_headcrabcanister|game=Half-Life 2 series|game1=Source 2006|game2=Source 2013|game3=Portal}} The canister is a mortar shell containing a payload of [[headcrab]]s. The mortar shell inflicts damage within a radius of where it lands and releases headcrabs after impact. Inputs and keyvalues offer control over impact damage and when the headcrabs are released, among other options. | |||
For an example of their use, see the shantytown in {{ent|d1_canals_05}}. | |||
== Flags == | |||
{{fl|1|No Impact Sound}} | |||
{{fl|2|No Launch Sound}} | |||
{{fl|4096|Start Impacted}} | |||
== | {{fl|8192|Land at initial position}} | ||
{{fl|16384|Wait for input to open}} | |||
{{fl|32768|Wait for input to spawn headcrabs}} | |||
{{fl|65536|No smoke}} | |||
{{fl|131072|No shake}} | |||
{{fl|262144|Remove on impact}} | |||
{{fl|524288|No impact effects}} | |||
== Keyvalues == | == Keyvalues == | ||
{{KV Targetname}} | |||
{{KV|Which headcrab to Spawn?|intn=HeadcrabType|choices|Select which headcrab will jump out the canister. | |||
:*0: Normal headcrabs | |||
:*1: Fast Headcrabs | |||
:*2: Poison Headcrabs}} | |||
{{KV|Headcrab count|intn=HeadcrabCount|int|Number of headcrabs to spawn on impact.}} | |||
{{KV|Min Refire time|intn=MinSkyboxRefireTime|float|Min number of seconds before the canister is refired. This will only work for canisters placed in the skybox.}} | |||
{{KV|Max Refire time|intn=MaxSkyboxRefireTime|float|Max number of seconds before the canister is refired. This will only work for canisters placed in the skybox.}} | |||
{{KV|Canister count|intn=SkyboxCannisterCount|int|Number of canisters to produce and fire across the skybox. The target should be positioned inside the skybox. 0 means fire continuously, forever.}} | |||
{{KV|Impact damage|intn=Damage|float|Max damage the canister applies on impact.}} | |||
| | {{KV|Impact damage Radius|intn=DamageRadius|float|Max radius of the impact damage for the canister.}} | ||
{{KV|Smoke duration|intn=SmokeLifetime|float|Duration that the canister smokes. -1 means always smoke.}} | |||
{{KV|Launch Position Name|intn=LaunchPositionName|target_destination|If the canister should launch to its origin from another point within the world, this should specify an {{ent|info_target}} at the launch origin.}} | |||
{{KV|Flight Speed|intn=FlightSpeed|float|Speed to fly through the air.}} | |||
{{KV|Flight Time|intn=FlightTime|float|Time to fly through the air in seconds.}} | |||
{{KV|Starting Height|intn=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.}} | |||
| | |||
= | |||
== Inputs == | == Inputs == | ||
{{I|FireCanister|param=void|Fires the canister.}} | |||
{{I|OpenCanister|param=void|Opens the canister (must be called after the <code>OnImpacted</code> output is fired).}} | |||
{{I|SpawnHeadcrabs|param=void|Spawns headcrabs (must be called after the <code>OnImpacted</code> output is fired and after <code>OpenCanister</code> is triggered, if the ''Wait for Input to open''' flag is checked).)}} | |||
{{I|StopSmoke|param=void|Causes the smoke effect to stop.}} | |||
== Outputs == | == Outputs == | ||
{{O|OnLaunched|param=ehandle|ac-is-this=1|Fired when the canister is launched. {{outadd|the targetname of the canister}}}} | |||
{{O|OnImpacted|param=void|ac-is-this=1|Fires when canister hits the ground.}} | |||
{{O|OnOpened|param=void|ac-is-this=1|Fires when canister has finished opening.}} | |||
== ConVars/Commands == | |||
{{varcom|start}} | |||
{{varcom|sk_env_headcrabcanister_shake_amplitude|50|Arbitrary decimal (float)|Crash effect's shake amplitude. Though the default is 50, the shake amplitude can only go up to 16.}} | |||
{{varcom|sk_env_headcrabcanister_shake_radius|1024|dist|Radius the player must be within for the screen shake effect to occur. Shake amplitude is gradually decreased the farther away from the explosion the player is.}} | |||
{{varcom|sk_env_headcrabcanister_shake_radius_vehicle|2500|dist|As above, but when in a vehicle.}} | |||
{{varcom|end}} | |||
== See also == | |||
* {{ent|npc_headcrab}} | |||
Latest revision as of 04:31, 19 May 2025
 Class hierarchy
|
|---|
| CEnvHeadcrabCanister |
| env_headcrabcanister.cpp
|
env_headcrabcanister is a model entity available in 
Half-Life 2 series, 
Source 2006, 
Source 2013, and 
Portal. 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. Inputs and keyvalues 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.
Flags
- No Impact Sound : [1]
- No Launch Sound : [2]
- Start Impacted : [4096]
- Land at initial position : [8192]
- Wait for input to open : [16384]
- Wait for input to spawn headcrabs : [32768]
- No smoke : [65536]
- No shake : [131072]
- Remove on impact : [262144]
- No impact effects : [524288]
Keyvalues
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
- Which headcrab to Spawn? (HeadcrabType) <choices>
- Select which headcrab will jump out the canister.
- 0: Normal headcrabs
- 1: Fast Headcrabs
- 2: Poison Headcrabs
- Headcrab count (HeadcrabCount) <integer>
- Number of headcrabs to spawn on impact.
- Min Refire time (MinSkyboxRefireTime) <float>
- Min number of seconds before the canister is refired. This will only work for canisters placed in the skybox.
- Max Refire time (MaxSkyboxRefireTime) <float>
- Max number of seconds before the canister is refired. This will only work for canisters placed in the skybox.
- Canister count (SkyboxCannisterCount) <integer>
- Number of canisters to produce and fire across the skybox. The target should be positioned inside the skybox. 0 means fire continuously, forever.
- Impact damage (Damage) <float>
- Max damage the canister applies on impact.
- Impact damage Radius (DamageRadius) <float>
- Max radius of the impact damage for the canister.
- Smoke duration (SmokeLifetime) <float>
- Duration that the canister smokes. -1 means always smoke.
- Launch Position Name (LaunchPositionName) <targetname>
- If the canister should launch to its origin from another point within the world, this should specify an info_target at the launch origin.
- Flight Speed (FlightSpeed) <float>
- Speed to fly through the air.
- Flight Time (FlightTime) <float>
- Time to fly through the air in seconds.
- Starting Height (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.
Inputs
- FireCanister <void>
- Fires the canister.
- OpenCanister <void>
- Opens the canister (must be called after the
OnImpactedoutput is fired).
- SpawnHeadcrabs <void>
- Spawns headcrabs (must be called after the
OnImpactedoutput is fired and afterOpenCanisteris triggered, if the Wait for Input to open' flag is checked).)
- StopSmoke <void>
- Causes the smoke effect to stop.
Outputs
- OnLaunched <targetname*>
- !activator = !caller = this entity
Fired when the canister is launched. This output automatically puts the targetname of the canister into the parameter box for inputs, if the mapper does not override the parameter with something else.
- OnImpacted <void>
- !activator = !caller = this entity
Fires when canister hits the ground.
- OnOpened <void>
- !activator = !caller = this entity
Fires when canister has finished opening.
ConVars/Commands
| Cvar/Command | Parameters or default value | Descriptor | Effect |
|---|---|---|---|
| sk_env_headcrabcanister_shake_amplitude | 50 | Arbitrary decimal (float) | Crash effect's shake amplitude. Though the default is 50, the shake amplitude can only go up to 16. |
| sk_env_headcrabcanister_shake_radius | 1024 | Hammer units | Radius the player must be within for the screen shake effect to occur. Shake amplitude is gradually decreased the farther away from the explosion the player is. |
| sk_env_headcrabcanister_shake_radius_vehicle | 2500 | Hammer units | As above, but when in a vehicle. |