Env poison gas: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Changed parameters of {{this is a}} to comply with the updated version. This action was performed by a bot.)
No edit summary
 
Line 16: Line 16:


==Keyvalues==
==Keyvalues==
{{KV|[[Targetname|Name]]|string| The [[targetname]] that other entities refer to this entity by.}}
{{KV Targetname}}
{{KV|Active|integer|Gas cloud active on spawn (1: Yes, 0: No).}}
{{KV|Active|integer|Gas cloud active on spawn (1: Yes, 0: No).}}
{{KV|Damage|float|Damage per second (DPS) inflicted by this poison.}}
{{KV|Damage|float|Damage per second (DPS) inflicted by this poison.}}
Line 34: Line 34:


==Inputs==
==Inputs==
{{IO|TurnOn|Turn Gas On.}}
{{I|TurnOn|Turn Gas On.}}
{{IO|TurnOff|Turn Gas Off.}}
{{I|TurnOff|Turn Gas Off.}}
{{bug | Turning off the cloud does not disable the sound effects.}}
{{bug | Turning off the cloud does not disable the sound effects.}}
{{IO|SetRadius|Set Gas cloud radius|param=float}}
{{I|SetRadius|Set Gas cloud radius|param=float}}
{{IO|SetDuration|Set Gas cloud duration (0: Infinite).|param=float}}
{{I|SetDuration|Set Gas cloud duration (0: Infinite).|param=float}}
{{bug | If the duration is non-infinite the sound effects will be muted on activation.}}
{{bug | If the duration is non-infinite the sound effects will be muted on activation.}}
{{IO|SetSpawnRate|Set Gas particle spawn rate.|param=float}}
{{I|SetSpawnRate|Set Gas particle spawn rate.|param=float}}
{{note | The entity needs to be turned off and on again for any effects to occur.}}
{{note | The entity needs to be turned off and on again for any effects to occur.}}
{{IO|Sound|Turn gas cloud sound on or off.|param=bool}}
{{I|Sound|Turn gas cloud sound on or off.|param=bool}}
{{bug | Does not seem to have any effect.}}
{{bug | Does not seem to have any effect.}}
{{IO|SetStartColor|Set the color of the gas at start.|param=vector}}
{{I|SetStartColor|Set the color of the gas at start.|param=vector}}
{{IO|SetEndColor|Set the color of the gas at end.|param=vector}}
{{I|SetEndColor|Set the color of the gas at end.|param=vector}}
{{bug | Does not seem to have any effect.}}
{{bug | Does not seem to have any effect.}}
{{ScrollBox|title=Targetname|}}
{{IO|[[AddOutput]]|Evaluates a keyvalue/output on this entity. <br/>Format: <code><key> <value></code><br/>Format: <code><output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite></code>|param=string}}
{{IO|FireUser1|to=FireUser4|Fire the <code>OnUser</code> outputs; see [[User Inputs and Outputs]].}}
{{IO|Kill|Removes this entity and any entities parented to it from the world.}}
{{IO|KillHierarchy|Functions the same as <code>Kill</code>, although this entity and any entities parented to it are killed on the same frame, being marginally faster than <code>Kill</code>.}}


==Ouputs==
==Ouputs==
{{ScrollBox|title=Targetname|}}
{{O|OnUse|Fires when the <code>Use</code> input is given.}}
{{IO|OnUse|Fires when the <code>Use</code> input is given.}}
{{O BaseEntity}}

Latest revision as of 11:19, 26 September 2024

List of SE1 entities
The four types of gas, antigen is invisible due to a bug.

env_poison_gas is a point entity available in SiN Episodes SiN Episodes. It spawns a cloud of gas from a selection of different gas types within its radius of effect, which are only ever used actively once in se1_u4lab01 (U4 Lab - Infiltration) to teach the player of the U4 gas and passively in the background maps as decoration. The U4 gas is also used by the prop_mutagen_barrel entity and antigen by all of the health objects in the game like the prop_antigen_canister. The entity is able to produce four different types of gas:


  • U4 is known for its green colour, slows down the world from the player's POV and begins to hurt once the affect bar is full.
  • Antigen is normally blue and heals the player over time.
  • Radiation is an unused orange gas and damages on a constant rate like if being cut.
  • Inert has no effects of any kind and should only ever be used for decoration purposes.
Warning.pngWarning: Be careful with the amount of particles and their spawnrate, as they can decrease performance in heavily detailed scenes
Note.pngNote: By letting the entity spawn with an infinite duration and then changing it while active, makes the sound stop correctly once the duration is up.
Tip.pngTip: Please consider using an ambient_generic entity for the sound if it shall ever need to be turned off (ambient/gas/gas_poison_loop2.wav).

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Active ([todo internal name (i)]) <integer>
Gas cloud active on spawn (1: Yes, 0: No).
Damage ([todo internal name (i)]) <float>
Damage per second (DPS) inflicted by this poison.
Icon-Bug.pngBug: Does not seem to have any effect. U4 and Radiation always deals and antigen always heals about 3 DPS no matter what.  [todo tested in ?]
Radius ([todo internal name (i)]) <float>
Poison gas radius.
Duration ([todo internal name (i)]) <float>
Duration in seconds (0: Infinite).
Icon-Bug.pngBug: If the duration is non-infinite the sound effects will be muted on activation.  [todo tested in ?]
Spawnrate ([todo internal name (i)]) <float>
Particle Spawn Rate.
Gas Type ([todo internal name (i)]) <choices>
Type of gas.
  • 0: U4
  • 1: Antigen
  • 2: Radiation
  • 3: Inert
Icon-Bug.pngBug: The antigen gas type is invisible but else works as expected. An env_steam or func_smokevolume can be used to fake its gas cloud, RGB colour: (0 65 100).  [todo tested in ?]
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.

Inputs

TurnOn
Turn Gas On.
TurnOff
Turn Gas Off.
Icon-Bug.pngBug: Turning off the cloud does not disable the sound effects.  [todo tested in ?]
SetRadius <floatRedirectInput/float>
Set Gas cloud radius
SetDuration <floatRedirectInput/float>
Set Gas cloud duration (0: Infinite).
Icon-Bug.pngBug: If the duration is non-infinite the sound effects will be muted on activation.  [todo tested in ?]
SetSpawnRate <floatRedirectInput/float>
Set Gas particle spawn rate.
Note.pngNote: The entity needs to be turned off and on again for any effects to occur.
Sound <booleanRedirectInput/boolean>
Turn gas cloud sound on or off.
Icon-Bug.pngBug: Does not seem to have any effect.  [todo tested in ?]
SetStartColor <vectorRedirectInput/Vector>
Set the color of the gas at start.
SetEndColor <vectorRedirectInput/Vector>
Set the color of the gas at end.
Icon-Bug.pngBug: Does not seem to have any effect.  [todo tested in ?]

Ouputs

OnUse
Fires when the Use input is given.