func_button

GoldSrc

Source Engine

Source 2

Class hierarchy
CBaseButton ↳CBaseToggle ↳CBaseAnimating ↳CBaseDelay ↳CBaseEntity
buttons.cpp

func_button is a brush entity available in all  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

Todo: sound KVs

Important: Default values are applied for this entity if the applicable KVs set to zero, not only if absent.

Name (targetname) <string>

The targetname that other entities refer to this entity by, usually via the target, killtarget, and TriggerTarget KVs.

Target (target) <targetname>

The targetname of an entity this entity will trigger when activated.

Delay before trigger (delay) <integer>

Delay in seconds before firing the targeted entity.

Killtarget (killtarget) <targetname>

Entity to remove when activated.

Delay before reset (wait) <integer>

Default Value: 1
Delay before reset (-1 stay).

Master (master) <string>

Name of a multisource entity.

Speed (speed) <integer>

Default Value: 40
Speed of the button to move from its non-activated to its activated state.

Pitch Yaw Roll (Y Z X) (angles) <QAngle>

Direction the button will move when pressed, if applicable.

Angular Velocity (Y Z X) (avelocity) <vector3> !FGD

Default Value: 0 0 0
Per-axis rotation speed while the button is moving. Use the same speed values as func_rotating.

Lip (lip) <float>

Default Value: 4

Health (shootable if > 0) (health) <integer>

Will trigger upon any amount of damage if greater than zero, regardless of what is set. Effectively acts as a boolean.

Target path (netname) <targetname> 

In FGD, but seems to do nothing.

Render Mode (rendermode) <integer choices>

Render Mode to use.

Render modes

Normal Color Texture Glow Solid Additive

Render Amount (renderamt) <integer 0–255>

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.

Render FX (renderfx) <integer choices>

Render FX mode to use, for special effects.

Render effects

Normal Slow Pulse Fast Pulse Slow Wide Pulse Fast Wide Pulse Slow Fade Away Fast Fade Away Slow Become Solid Fast Become Solid Slow Strobe Fast Strobe Faster Strobe Slow Flicker Fast Flicker Constant Glow Distort Hologram (Distort + fade)

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.