This article's documentation is for the "GoldSrc" engine. Click here for more information.

func_button

From Valve Developer Community
Jump to navigation Jump to search
English (en)Translate (Translate)
func_button
TypeBrush entity
EngineGoldSrc GoldSrc
AvailabilityIn all games
 

func_button is a brush entity available in all GoldSrc GoldSrc games. The button can be used to trigger an event when it is touched or used. When the button is touched or used, it will move in the direction set by its angle, for a length equal to its own length. Following is a list of its important properties.

Key Values

Targetname:

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Master (master) <string>
Name of a multisource entity.
Speed (speed) <integer>
Speed of the button to move from its non-activated to its activated state.
Lip (lip) <float>
Health (shootable if > 0) (health) <integer>
Targetted object (target) <targetname>
Targeted object.
Target path (netname) <targetname>
Target Path.
Delay before reset (wait) <integer>
Delay before reset (-1 stay).
Delay before trigger (delay) <string>
Delay before trigger.


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.


Flags

Don't move : [1]

If this is enabled, the button will instantly go from inactive to activated when it is touched or used without moving.

Toggle : [32]

If this flag is enabled, the button will pause in its active and inactive position, waiting to be touched or used again. Each time it is activated, it will activate its events.

Sparks : [64]

If this is enabled, the button will randomly emit sparks when it is in its inactive position.

Touch Activates : [256]

If this is enabled, it will be possible to activate the button simply by touching it rather than using the "use" key on it.