Half-Life Env Entities

Originally written for TWHL

• Env_beam
• Env_beverage
• Env_blood
• Env_bubbles
• Env_explosion
• Env_fade
• Env_funnel
• Env_global
• Env_glow
• Env_laser
• Env_message
• Env_render
• Env_shake
• Env_shooter
• Env_sound
• Env_spark
• Env_sprite

---

env_beam

Creates a laser or 'beam' effect between two points.

Properties

Name - The Name of the entity.

Start Entity - The name of the entity at which the beam will begin.

Ending Entity - The name of the entity at which the beam will end.

Render FX - The options are as follows:

0 = Normal
1 = Slow Pulse
2 = Fast Pulse
3 = Slow Wide Pulse
4 = Fast Wide Pulse
5 = Slow Fade Away
6 = Fast Fade Away
7 = Slow Become Solid
8 = Fast Become Solid
9 = Slow Strobe
10 = Fast Strobe
11 = Faster Strobe
12 = Slow Flicker
13 = Fast Flicker
14 = Constant Glow
15 = Distort
16 = Hologram (Distort and Fade) 

Brightness - The value of the Render Mode, between 0 and 255. "Solid" mode simply needs a non-0 value to work, while in other modes translucency is controlled by this value.

Beam Color - An RGB value that controls the colour of the object rendering. Only Color and Glow Render Modes use the Render Color property, but other entities also use it under different SmartEdit names.

Radius - Noise radius or the amount of "radial static movement" in the beam.

Life - Time for beam to stay on, in seconds. 0 is infinite.

Width of beam - Width of beam in (pixels*0.1). Range: 0 - 255.

Amount of noise - "Static" or beam movement. Range: 0 - 255.

Sprite Name - Name of sprite to use as beam's texture.

Texture Scroll Rate - How fast the texture should scroll along the beam. Range: 0 -1 00.

Frames per 10 seconds - Framerate for sprite texture animation. (0 is none)

Starting Frame - Sprite animation frame at which to begin.

Strike again time - How long to wait after the beam has turned itself off before it should start again, in 10ths of a second. Range: 0 - 255.

Damage / second - Damage done to monsters or the player when beam hits them.

Flags

(1) Start On - Entity will start on (or active). This usually only has effect if the entity is given a name (most entities that aren't given names start on anyway), or has its Toggle flag set on.
(2) Toggle - With this flag set on, an entity can be turned on and off, either by the player, or by being triggered.
(4) Random Strike - The beam will strike at randon points along a defined path.
(8) Ring - Forms a ring between the two targets.
(16) StartSparks - Generates a Spark Sprite at the beam start.
(32) EndSparks - As above, but at the beam end.
(64) Decal End - Decals (bullet holes) may appear where the beam hits objects. Good for laser trace lines.
(128) Shade Start - Start of beam fades away.
(256) Shade End - End of beam fades away.

Related Entities

None

Notes:
Info_target entities can be used as the beam start and end points.
You can create moving beams by using func_trains as the targets, but they need an origin brush for the beam to aim at.

Top

---

env_beverage

Creates a Monstermaker for beverage cans .

Properties

Name - The Name of the entity, so it can be triggered.

Pitch Roll Yaw - Sets the pitch (up / down), yaw (left / right) and roll (bank) respectively. The compass in WorldCraft / Hammer corresponds to Yaw. The settings are not always (or not all) used.

Capacity - The number of times the entity can be triggered. Once this number has been spawned, further triggering will result in nothing (vending machines run out, you know).

Beverage Type - The texture of the cans. Values:

0 = Coca-Cola
1 = Sprite
2 = Diet Coke
3 = Orange
4 = Surge
5 = Moxie
6 = Random

Flags

None

Related Entities

None

Notes:
Each can gives the player 1 health.

Top

---

env_blood

Creates a Blood Spurting entity.

Properties

Name - The Name of the entity, so it can be triggered.

Pitch Roll Yaw - Sets the pitch (up / down), yaw (left / right) and roll (bank) respectively. The compass in WorldCraft / Hammer corresponds to Yaw. The settings are not always (or not all) used.

Blood color - 0 for red, 1 for yellow.

Amount of blood - The higher the value, the more gruesome.

Flags

(1) Random Direction - Blood sprays randomly, ignoring Yaw value.
(2) Blood Stream - Shoots a stream of particles instead of just a splash.
(4) On Player - The blood emanates from the player that triggered it.
(8) Spray decals - Creates blood decals on any surface in the direction the blood shoots.

Related Entities

None

Notes:
Dripping water? What has that got to do with env_blood? Good Question, Jeff 'Yesukai' Pritchard wrote a tutorial on Collective called: Cool looking Dripping Water showing how to turn the humble env_blood into a drip making machine.

Top

---

env_bubbles

Creates a stream of rising bubbles.

Properties

Name - The Name of the entity, so it can be triggered.

Bubble density - The number of bubbles produced.

Bubble frequency - The higher the value, the shorter the delay between each set of bubbles being produced.

Speed of Current - The speed the bubbles move in the direction specified by the angle.

Flags

(1)Start Off - With this flag set, the entity will need to be triggered before becoming active.

Related Entities

None

Notes: This is the only brush-based env entity.
Horizontal streams of bubbles cannot be produced with this entity. Use a cycler entity instead, with the pipe_bubbles.mdl model.

Top

---

env_explosion

This entity creates any combination of fireball, smoke, sparks, decals and sound, also known as an explosion.

Properties

Name - The Name of the entity.

Magnitude - The size of the explosion, 100 is average.

Flags

(1) No Damage - Explosion won't cause any damage.
(2) Repeatable - Entity can be triggered more than once.
(4) No Fireball - There is no orange fireball. It won't look much like an explosion.
(8) No Smoke - Creates a pollution-free explosion.
(16) No Decals - No scorch marks are left behind.
(32) No Sparks - No sparks fly out.

Related Entities

None

Notes: It's possible to create a similar effect with a combination of other entities, but it wouldn't be much fun, so this quick and easy one is here instead!

Top

---

env_fade

Creates a screen fade effect.

Properties

Name - The Name of the entity.

Duration - Duration of effect in seconds.

Hold Fade - Time to hold fade, in seconds.

Fade Alpha - The value of the Render Mode, between 0 and 255. "Solid" mode simply needs a non zero value to work, while in other modes translucency is controlled by this value.

Fade Color - An RGB value that controls the colour of the object rendering. Only Color and Glow Render Modes use the Render Color property, but other entities also use it under different SmartEdit names.

Flags

(1) Fade From - Normal fade is from the "Normal Colour" of the screen to the "Fade Colour". If you check this flag the process is reversed.
(2) Modulate - Attenuates the "Screen Colours" in RBG with the "Fade Colours".

Related Entities

None

Notes:
This is normally used when switching from 'Player' to 'Camera' View to avoid jerky cut scene starts.
Also used in conjunction with 'Special Game' enties to finish levels when the player dies.

Top

---

env_funnel

Produces a funnel of little sprites, as seen in the Half-Life disaster sequence.

Properties

Name - The Name of the entity for triggering.

Flags

Reverse - Use this to reverse the effect.

Related Entities

None

Notes:
None.

Top

---

env_global

This entity stores 'global' variables across levels, so you can set a state in one level, and retrieve it in another.

Properties

Name - Trigger the env_global to set its Initial State. You can alternatively set the Set Initial State flag on to do this automatically when the level loads.

Global State to Set - The name of the global variable you want to set. This name must be the Global State to Read value of entities such as the multisource, that read the global state.

Trigger Mode - Values:

0 = Off
1 = On
2 = Dead
3 = Toggle

This is the state that the global variable is set to when the env_global is triggered. If it is set to Toggle, the state will be toggled between on and off whenever the env_global is triggered, starting on the Initial State value.

Initial State - This is the state the global variable is given when the level loads, if the Set Initial State flag is enabled. Also, it is the first state given to the variable if Trigger Mode is toggle. Values are:

0 = Off
1 = On
2 = Dead

Flags

Set Initial State - If enabled, the global variable is set to its Inital State when the level loads, rather than when the entity is triggered.

Related Entities

Almost every Entity that requires a Global.

Notes:
None.

Top

---

env_glow

Based on the env_sprite, this entity was specifically designed to create light halo effects.

Properties

Name - This entity cannot be toggled on and off, although the env_sprite can.

Render FX - The options are as follows:

0 = Normal
1 = Slow Pulse
2 = Fast Pulse
3 = Slow Wide Pulse
4 = Fast Wide Pulse
5 = Slow Fade Away
6 = Fast Fade Away
7 = Slow Become Solid
8 = Fast Become Solid
9 = Slow Strobe
10 = Fast Strobe
11 = Faster Strobe
12 = Slow Flicker
13 = Fast Flicker
14 = Constant Glow
15 = Distort
16 = Hologram (Distort and Fade)

Render Mode - Options are:

0 = Normal
1 = Color
2 = Texture
3 = Glow
4 = Solid
5 = Additive 

FX Amount - The value of the Render Mode, between 0 and 255.
'Solid' mode simply needs a non zero value to work, while in other modes translucency is controlled by this value.

FX Color - An RGB value that controls the colour of the object rendering. Only Color and Glow Render Modes use the Render Color property, but other entities also use it under different SmartEdit names.

path/filename.spr of sprite - The sprite to be used by the entity. The default is sprites/flare1.spr, but you can see them all by browsing the "sprites" folder in the "pak0.pak" file.

Scale - The scale that the sprite should be drawn at.

Flags

None

Related Entities

Env_sprite

Notes:
Normally used to produce a Halo effect around lights, to give it more ambience. The ability to match the colour of the light with the colour of the Glow, makes it more realistic. Just be careful of the size...

Top

---

env_laser

Creates a damaging beam. Based on the env_beam, so everything it does can be done by an env_beam.

Properties

Name - If given a name, the beam will start off, unless the Start On flag is set.

Render FX - The options are as follows:

0 = Normal
1 = Slow Pulse
2 = Fast Pulse
3 = Slow Wide Pulse
4 = Fast Wide Pulse
5 = Slow Fade Away
6 = Fast Fade Away
7 = Slow Become Solid
8 = Fast Become Solid
9 = Slow Strobe
10 = Fast Strobe
11 = Faster Strobe
12 = Slow Flicker
13 = Fast Flicker
14 = Constant Glow
15 = Distort
16 = Hologram (Distort and Fade)

Pitch Roll Yaw - Sets the pitch (up / down), yaw (left / right) and roll (bank) respectively. The compass in WorldCraft / Hammer corresponds to Yaw. The settings are not always (or not all) used.

Target of laser - The beam will be emitted from the entity and will end at this target.

Brightness - The higher this number, the less transparent the beam.

Beam Color - An RGB value that controls the colour of the object rendering. You can pick the colour from the Smart button.

Width of beam - The beam width. It will be rendered in-game as the number multiplied by 0.1 to produce the width in pixels. Range: 0 - 255.

Amount of noise - The higher this value, the more the beam jumps around. 0 is stationary. Range: 0 - 255.

Sprite Name - The name of the sprite used as a texture. Default is sprites/laserbeam.spr.

End Sprite - This sprite is placed where the laser beam ends.

Texture Scroll Rate - The speed at which the texture sprite scrolls across the beam. Range: 0 - 100.

Starting Frame - Set the frame on which to begin animating. Allows you to select different-looking beams from a multi-frame (animated) sprite.

Damage / second - Specify the amount of damage to be done per second by the beam.

Flags

(1) Start On - Entity will start on (or active). This usually only has effect if the entity is given a name (most entities that aren't given names start on anyway), or has its Toggle flag set on.
(16) Start Sparks - Makes sparks shoot out of the env_laser's point.
(32) End Sparks - Sparks are emitted from the target (end) point.
(64) Decal End - Creates scorch marks at the end of the beam.

Related Entities

Env_beam

Notes:
env_laser differs from env_beam in that instead of the beam being created between two points, the env_laser entity acts as the start point, with the beam extending to a target.
The simplest target to use is the info_node entity, but anything with a name can be used, including brush-based entities (such as func_wall).
In this case, the brush needs to be grouped with an origin brush that defines the targetted point. An origin brush is any brush with the texture called "origin" on all faces.
If you have multiple entities with the same name as the laser target, the beam will jump from point to point randomly, originating always from the env_laser's location.

Top

---

env_message

This entity allows you to display text messages with sound for the player.

Properties

Name - Give the entity a name so that it can be triggered.

Target - When an entity is activated, it triggers the entity with the name specified by Target.

Message Name - The text of the message (see note below)

path/filename.wav of WAV - This will be the path to a WAV file from the sounds folder

Volume 0 - 10 - Loud or not.

Sound Radius- Values:

0 = Small Radius
1 = Medium Radius
2 = Large Radius
3 = Play Everywhere

Flags

(1) Play Once - The text will only be triggered once.
(2) All Clients - Everyone will see the message

Related Entities

None

Notes:
This entity only allows the use of predefined text messages. These are found in the "titles.txt" file in the root of "pak0.pak", in your Half-Life\valve\ folder. Browse the PAK with a PAK viewer (like PakExplorer), and open the "titles.txt" file. The format is:

NAME
{
Message
}

This entity is only really useful for mods, where a custom "titles.txt" file is distributed, either in the PAK, or in the mod's root folder. To see how to construct your own file, read through Valve's comments in their one.

Top

---

env_render

This entity allows you to change the rendering properties of most of the visible entities in the game (monsters, func_walls etc.), while the map is running. The four render properties of the env_render will be copied to its target.

Properties

Name - Entity must be triggered to activate.

Target - The name of the entity whose properties are to be changed.

Render FX - The options are as follows:

0 = Normal
1 = Slow Pulse
2 = Fast Pulse
3 = Slow Wide Pulse
4 = Fast Wide Pulse
5 = Slow Fade Away
6 = Fast Fade Away
7 = Slow Become Solid
8 = Fast Become Solid
9 = Slow Strobe
10 = Fast Strobe
11 = Faster Strobe
12 = Slow Flicker
13 = Fast Flicker
14 = Constant Glow
15 = Distort
16 = Hologram (Distort and Fade)

Render Mode - Options are:

0 = Normal
1 = Color
2 = Texture
3 = Glow
4 = Solid
5 = Additive

FX Amount - The value of the Render Mode, between 0 and 255.
'Solid' mode simply needs a non zero value to work, while in other modes translucency is controlled by this value.

FX Color - An RGB value that controls the colour of the object rendering. Only Color and Glow Render Modes use the Render Color property, but other entities also use it under different SmartEdit names.

Flags

(1) No Renderfx - Render FX will not be copied.
(2) No Renderamt - Render Amount will not be copied.
(4) No Rendermode - Render Mode will not be copied.
(8) No Rendercolor - Render Color will not be copied.

Related Entities

None

Notes:
Use this entity to fake situations that would be impossible for the game engine, such as apparently binding multiple entities together (e.g. a moving doorhandle on a rotating door). With a bit of careful setup, it is possible to let the the doorhandle move first, then become invisible, then let the door move (with a static doorhandle attached).

Top

---

env_shake

This entity produces a shake effect that is useful for big explosions, large guns and the like.

Properties

Name - Give the entity a name so that it can be triggered.

Amplitude 0-16 - The power of the shake.

Effect Radius - The radius around the entity in which the effect is "felt".

Duration - Time the effect lasts in seconds.

0.1 = jerk, 255.0 = rumble - The frequency of the vibration. The higher the number, the lower the frequency.

Flags

(1) GlobalShake - Shake occurs everywhere.

Related Entities

None

Notes:
There used to be two other flags, In Air and Disrupt Control, that sound interesting, but were obviously not implemented.

Top

---

env_shooter

The env_shooter shoots out models or sprites or Gibs.

Properties

Name - Provide a name so that the entity can be triggered.

Pitch Roll Yaw - Sets the pitch (up / down), yaw (left / right) and roll (bank) respectively. The compass in WorldCraft / Hammer corresponds to Yaw. The settings are not always (or not all) used.

Number of Gibs - The number of gibs that will be spawned on activation.

Delay between shots - The time in seconds between each gib being shotout. 0 means they are all expelled at once.

Gib Velocity - The speed that gibs are shot out.

Course Variance - How much each gib's direction will vary from the normal.

Gib Life - Time in seconds that gibs are visible.

Render FX - The options are as follows:

0 = Normal
1 = Slow Pulse
2 = Fast Pulse
3 = Slow Wide Pulse
4 = Fast Wide Pulse
5 = Slow Fade Away
6 = Fast Fade Away
7 = Slow Become Solid
8 = Fast Become Solid
9 = Slow Strobe
10 = Fast Strobe
11 = Faster Strobe
12 = Slow Flicker
13 = Fast Flicker
14 = Constant Glow
15 = Distort
16 = Hologram (Distort and Fade)

Render Mode - Options are:

0 = Normal
1 = Color
2 = Texture
3 = Glow
4 = Solid
5 = Additive

FX Amount - The value of the Render Mode, between 0 and 255.
'Solid' mode simply needs a non zero value to work, while in other modes translucency is controlled by this value.

FX Color - An RGB value that controls the colour of the object rendering. Only Color and Glow Render Modes use the Render Color property, but other entities also use it under different SmartEdit names.

Model or Sprite name - The path and name of the model or sprite to be shot. e.g. models/model.mdl or sprites/sprite.mdl.

Material Sound - The sound that is produced when gibs hit the ground. Values:

-1 = None
0 = Glass
1 = Wood
2 = Metal
3 = Flesh
4 = Concrete

Gib Sprite Scale - Applies to sprites only. Sets their scale.

Gib Skin - Applies to models only. Sets the skin if more than one is available.

Flags

(1) Repeatable - Allows the entity to be triggered more than once.

Related Entities

None

Notes:
You will need a model viewer such as HLMV to browse the models that are available. To see sprites, use the model viewer to extract the .spr files, then open them with a sprite viewer.
A full Gib list is available at Collective.
If you do decide for some reason to shoot heaps of Barneys all over the joint, just remember that the models center will not have been initialised. Which means they will sink into the floor up to their waste.

Top

---

env_sound

This entity controls how the ambient sounds are processed. Use it to enhance the atmosphere of a particular area.

Properties

Radius - When the player passes through an part of this area around the entity, the sound style is triggered on.

Room Type - The sound setting to use. Types are:

0 = Normal (off)
1 = Generic
2 = Metal Small
3 = Metal Medium
4 = Metal Large
5 = Tunnel Small
6 = Tunnel Medium
7 = Tunnel Large
8 = Chamber Small
9 = Chamber Medium
10 = Chamber Large
11 = Bright Small
12 = Bright Medium
13 = Bright Large
14 = Water 1
15 = Water 2
16 = Water 3
17 = Concrete Small
18 = Concrete Medium
19 = Concrete Large
20 = Big 1
21 = Big 2
22 = Big 3
23 = Cavern Small
24 = Cavern Medium
25 = Cavern Large
26 = Weirdo 1
27 = Weirdo 2
28 = Weirdo 3 

Flags

None

Related Entities

None

Notes:
Once the player has had a particular sound style applied, it stays with the player until it is changed by another env_sound. The setting can be returned to normal by forcing the player to pass through an env_sound with a Room Type of 0 (Normal).
Typically these entities are placed above doorways and set the sound for the room. As the player passes into the room, the "Room Type" is initiated, it effects footsteps, and anything else that makes a sound in that room. Another env_sound at the exit of the same type and setting will cancel the effect.

Top

---

env_spark

Produces an electrical spark effect.

Properties

Name - When given a name, and with the Toggle flag set on, you can turn the entity on and off.

Pitch Roll Yaw - Sets the pitch (up / down), yaw (left / right) and roll (bank) respectively. The compass in WorldCraft / Hammer corresponds to Yaw. The settings are not always (or not all) used.

Max Delay - Maximum delay between sparks.

Flags

(32) Toggle - With this flag set on, an entity can be turned on and off, either by the player, or by being triggered.
(64)Start On - Entity will start on (or active). This usually only has effect if the entity is given a name (most entities that aren't given names start on anyway), or has its Toggle flag set on.

Related Entities

None

Notes:
None

Top

---

env_sprite

Places a sprite (small 2D image) in your map.

Properties

Name - Giving the env_sprite a name will allow it to be triggered on and off.

Render FX - The options are as follows:

0 = Normal
1 = Slow Pulse
2 = Fast Pulse
3 = Slow Wide Pulse
4 = Fast Wide Pulse
5 = Slow Fade Away
6 = Fast Fade Away
7 = Slow Become Solid
8 = Fast Become Solid
9 = Slow Strobe
10 = Fast Strobe
11 = Faster Strobe
12 = Slow Flicker
13 = Fast Flicker
14 = Constant Glow
15 = Distort
16 = Hologram (Distort and Fade)

Render Mode - Options are:

0 = Normal
1 = Color
2 = Texture
3 = Glow
4 = Solid
5 = Additive

FX Amount - The value of the Render Mode, between 0 and 255.
'Solid' mode simply needs a non zero value to work, while in other modes translucency is controlled by this value.

FX Color - An RGB value that controls the colour of the object rendering. Only Color and Glow Render Modes use the Render Color property, but other entities also use it under different SmartEdit names.

Pitch Roll Yaw - Sets the pitch (up / down), yaw (left / right) and roll (bank) respectively. The compass in WorldCraft / Hammer corresponds to Yaw. The settings are not always (or not all) used.

Framerate - For animated sprites, controls the framerate.

Sprite Name - The path and name of the sprite as found in the PAK (default is sprites/glow01.spr).

Scale - Sets the scale. Default is 1:1. If you leave this setting blank, the sprite will be set at it's optimum initial scale. Sometimes this is NOT 1:1. Entering a value of 1 here may increase the size of a standard sprite.

Flags

(1) Start On - Entity will start on (or active). This usually only has effect if the entity is given a name (most entities that aren't given names start on anyway), or has its Toggle flag set on.
(2) Play Once - With animated sprites, makes the sprite play through its frames only once before it needs to be re-triggered to work.

Related Entities

Env_glow

Notes:
To see all the sprites you can use, browse through the "pak0.pak" file found in your Half-Life\valve\ folder with a PAK viewer (such as HLMV). Extract the .spr files and open them with SprView.

Top

Next Entity Guide Func Entities

---