func_water

GoldSrc

Source Engine

Source 2

edit

Class hierarchy
CBaseDoor ↳CBaseToggle ↳CBaseAnimating ↳CBaseDelay ↳CBaseEntity
doors.cpp

func_water is a brush entity available in all GoldSrc games. A water texture (one prefixed with '!') will act as water (with additional prefixes for other liquid types), but binding it to an entity gives added advantages.

Code:Both func_water and func_door are linked to CBaseDoor C++ class, and can be used interchangeably, setting skin to the appropriate contents. The game code checks for the classname, and only plays movement sounds if the classname is "func_door" or "func_door_rotating".

Key Values

Wave Height (WaveHeight) <float>

Height of waves on any !-prefixed textures on this entity. Default value is 3.2.

Contents (skin) <choices>

What brush contents to use for this entity.

For entities with no clipnodes (such as using zhlt_noclip), this is purely cosmetic.

For intrinsically nonsolid entities (such as func_illusionary, only some contents have any non-cosmetic effect (such as ladder).

Contents types

-1: Empty -2: Solid -3: Water (also disables backface culling) -4: Slime (like water, but inflicts damage) -5: Lava (like slime, but inflicts double damage) -6: Sky -7: Volumetric Light (same as water) -8: ??? Confirm:This is CONTENTS_CLIP, but BSP compilers change it to solid, so it probably has no effect at runtime. -9: Water with 0° current -10: Water with 90° current -11: Water with 180° current -12: Water with 270° current -13: Water with upward current -14: Water with downward current -15: Translucent (like water, but never solid) -16: Ladder Confirm:Allegedly must be tied to an entity with solidity set to SOLID_NOT (such as func_illusionary) in order to be climbable. -17: Zero Gravity -18: Hover Field -19: Fog

Targetname:

Name (targetname) <string>

The targetname that other entities refer to this entity by.

Global:

Global Entity Name (globalname) <string>

Name to identify entity accross level transitions. Entities with the same global name will have the same status accross maps.

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

KillTarget (killtarget) <targetname>

When the door is triggered, it will remove the entity specified by this property from the game.

Speed (speed) <integer>

Speed that the door moves, in units (sliding door) or degrees (rotating door) per second.

Master (master) <targetname>

Name of a master entity.

Move Sound (movesnd) <integer choices>

Only used if classname is func_door or func_door_rotating.

#	Name
0	No Sound
1	Servo (Sliding)
2	Pneumatic (Sliding)
3	Pneumatic (Rolling)
4	Vacuum
5	Power Hydraulic
6	Large Rollers
7	Track Door
8	Snappy Metal Door
9	Squeaky 1
10	Squeaky 2

Stop Sound (stopsnd) <integer choices>

Only used if classname is func_door or func_door_rotating.

#	Name
0	No Sound
1	Clang with brake
2	Clang reverb
3	Ratchet Stop
4	Chunk
5	Light airbrake
6	Metal Slide Stop
7	Metal Lock Stop
8	Snappy Metal Stop

delay before close, -1 stay open (wait) <integer>

Time until the door returns to the closed position. A value of -1 means the door never auto-closes.

Lip (lip) <integer>

When the door opens, it will move its full length minus this many units. Negative values will make the door move that many more than its length.

Damage inflicted when blocked (dmg) <integer>

How much damage the player receives if he gets stuck between the door and something solid.

Message If Triggered (message) <string>

Message appears when the entity has been triggered.

Target (target) <targetname>

When the door is opened, it triggers the entity with the name specified by Target

Delay before fire (delay) <integer>

Delays the door from opening and/or closing (in seconds).

Fire on Close (netname) <string>

Health (shoot open) (health) <integer>

With a non-zero value here, the door will have to be damaged to this extent to open.

Locked Sound (locked_sound) <integer choices>

#	Name
0	None
2	Access Denied
8	Small zap
10	Buzz
11	Buzz Off
12	Latch Locked

Unlocked Sound (unlocked_sound) <integer choices>

#	Name
0	None
1	Big zap & Warmup
3	Access Granted
4	Quick Combolock
5	Power Deadbolt 1
6	Power Deadbolt 2
7	Plunger
8	Small zap
9	Keycard Sound
10	Buzz
13	Latch Unlocked

Locked Sentence (locked_sentence) <integer choices>

#	Name
0	None
1	Gen. Access Denied
2	Security Lockout
3	Blast Door
4	Fire Door
5	Chemical Door
6	Radiation Door
7	Gen. Containment
8	Maintenance Door
9	Broken Shut Door

Unlocked Sentence (unlocked_sentence) <integer choices>

#	Name
0	None
1	Gen. Access Granted
2	Security Disengaged
3	Blast Door
4	Fire Door
5	Chemical Door
6	Radiation Door
7	Gen. Containment
8	Maintenance Door

Minimum light level (_minlight) <string>

Render FX (renderfx) <choices>

Render FX mode to use, for special effects.

Value	Description
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 + fade)

Render Mode (rendermode) <choices>

Render Mode to use.

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

Render Amount (0-255) (renderamt) <integer>

Controls transparency when using another render mode then normal. 0 is completely invisible, and 255 is opaque. If render mode is solid, then all values except 0 are opaque.

Render Color (R G B) (rendercolor) <color255>

Color to use by the specified render mode.
Also used on brush entities to control the speed of scrolling textures; see func_conveyor for more information.

Minimum light level (_minlight) <normal>

ZHLT family

ZHLT Light Flags (ZHLT 2.2+) (zhlt_lightflags) <choices> Special lighting behavior. Only available if using Zoner's Half-Life Compile Tools. 0 : "Default" 1 : "Embedded Fix" 2 : "Opaque (blocks light)" 3 : "Opaque + Embedded fix" 6 : "Opaque + Concave Fix" Light Origin Target (ZHLT 2.2+) (light_origin) <targetname> During lighting compilation, this entity will be treated as if its origin were at the target entity's origin. Requires an origin brush. Entity to Use Model From (ZHLT) (zhlt_usemodel) <targetname> Used to set the model to a different entity's model (bmodel, BSP, MDL, or SPR). The targeted entity will be moved before this entity to ensure proper loading. Requires an origin brush on this entity, as well as on the target entity if target entity is a brush entity. Nonsolid (ZHLT) (zhlt_noclip) <boolean> Disables generation of clipnodes for all brushes on this entity, except for clip brushes. The entity may still be solid to point traces (hitscans, grenades, etc) if the brush contents are set to solid. Tip:Always enable this for func_illusionary, unless skin is set to -16 (ladder); VHLT does not properly strip clipnodes for this entity. Don't Render (ZHLT 3+) (zhlt_invisible) <boolean> Treat all faces as if they were textured with NULL. Tip:Use this on triggers which use custom textures instead of AAATRIGGER or NULL, such as ladders. Custom Hull 1 (VHLT+) (zhlt_hull1) <targetname> Custom Hull 2 (VHLT+) (zhlt_hull2) <targetname> Custom Hull 3 (VHLT+) (zhlt_hull3) <targetname> Which named info_hullshape entity to use for the specified clipping hull. Mins/Maxs (VHLT+) (zhlt_minsmaxs) <mins vector + maxs vector> Override this entity's bounding box. zhlt_transform (zhlt_transform) <???> Never visible (VHLT+) (zhlt_hidden) <boolean> Don't create marksurfaces for this entity, resulting in it being treated by VIS as never visible. Tip:The _HIDDEN texture suffix does the same thing, but also works on world brushes, which are used for model lighting. Strip lightmaps after compiling (VHLT+) (zhlt_striprad) <boolean> Undefines the lightmaps for brushes on this entity after compiling, resulting in the faces being fullbright and not using up allocblock. Unlike TEX_SPECIAL, faces with zhlt_striprad will still affect bounced lighting. Custom Shadow Color (VHLT+) (zhlt_customshadow) <color1> If this entity casts shadows, the shadows will be this color instead of black. Can also be a single value, for monochrome. Fake Lightmap (VHLT v33+) (zhlt_embedlightmap) <boolean> Generates unique diffuse textures for all textured faces, then bakes lighting information directly into the generated textures. Primarily used to prevent translucent surfaces from "glowing", as rendermodes which support translucency don't render lightmaps on the vanilla renderer. Important:The resulting textures will be renamed to have the prefix __rad; as such, any unique attributes will be lost. Downscale Fake Lightmap (VHLT v34+) (zhlt_embedlightmapresolution) <integer> Downscale texture created by zhlt_embedlightmap this many times.

ericw-tools

Note:If any of the booleans are set in worldspawn, they can be disabled per entity by being set to -1. Cast shadows (_shadow) <boolean> Cast shadows from this entity. Implies _shadowself. Self-shadowed (_shadowself) <boolean> Cast shadows from this entity onto itself. Shadow world only (_shadowworldonly) <boolean> Only cast shadows on world, not models. Smooth shading (_phong) <boolean> Enable smooth shading between faces which are less than _phong_angle. Autosmoothing angle (_phong_angle) <integer> Angle to smooth; default 89. Set to 44 to match QRAD/HLRAD defaults. Maximum light level (_maxlight) <normal> Minlight color (_mincolor, _minlight_color) <color1> Color of _minlight. Also accepts color255, provided at least one value is greater than 1. Minlight only (_lightignore) <boolean> Only receive lighting from _minlight Disable backface culling (_mirrorinside) <boolean>

Flags

Starts Open : [1]
Don't link : [4]
Passable : [8]
Toggle : [32]
Use Only : [256]
Monsters Can't : [512]
Not In Deathmatch : [2048]