func_button Last edited 3 weeks ago2024-10-12 16:00:54 UTC

func_button - Brush Entity

This entity allows you to create various types of buttons, such as: switches, plungers, touch plates, push buttons, etc., that will trigger an event when activated. Works almost like a func_door.

Attributes

• Name (targetname) - Property used to identify entities.
• Global Entity Name (globalname)
• Pitch Roll Yaw (angles) - Set the angle for moving buttons here.
• Master (master) - The name of a multisource (or game_team_master) entity. A master must usually be active in order for the entity to work. Thus they act almost like an on/off switch, in their simplest form, and like an AND gate in the case of the multisource.
• Targetted object (target) - When this entity is activated, it triggers the entity/ies with the name specified by Target.
• Delay before trigger (delay) - The time in seconds before an entity should trigger its target (after being triggered itself).
• KillTarget (killtarget) - [undocumented] When the entity is triggered, it will remove from the game the entity specified by this property.

• Speed (speed) - The speed a moving button will move from its resting state to its activated state.
• Target path (netname) - Seemingly unused.
• Health (health) - If the button has to be shot, rather than pressed, specify a value greater than 0 here. When this amount of damage occurs, the button will activate.
• Lip (lip) - Number of units left after move (the lip value is subtracted from the move distance).
• Delay before reset (wait) - Time in seconds before the button pops back out or becomes reuseable (-1 = Never).

• Render FX (renderfx) - Gives objects special render effects. Think of it as modifying whatever the Render Mode puts out. 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 (rendermode) - Controls the type of rendering that is used for an object. Options are:
  • 0 = Normal
  • 1 = Color
  • 2 = Texture
  • 3 = Glow
  • 4 = Solid
  • 5 = Additive
• FX Amount (renderamt)
• FX Color (rendercolor)

• Sounds (sounds) - The sound made by the button on activation. The sound is played at the same time as the Unlocked Sound. Values are:
  • 0 = None (common/null.wav)
  • 1 = Big zap & Warmup (buttons/button1.wav)
  • 2 = Access Denied (buttons/button2.wav)
  • 3 = Access Granted (buttons/button3.wav)
  • 4 = Quick Combolock (buttons/button4.wav)
  • 5 = Power Deadbolt 1 (buttons/button5.wav)
  • 6 = Power Deadbolt 2 (buttons/button6.wav)
  • 7 = Plunger (buttons/button7.wav)
  • 8 = Small zap (buttons/button8.wav)
  • 9 = Keycard Sound (buttons/button9.wav)
  • 10 = Buzz (buttons/button10.wav)
  • 11 = Buzz Off (buttons/button11.wav)
  • 14 = Lightswitch (buttons/lightswitch2.wav)
• Locked Sound (locked_sound) - Sounds to play when the entity is 'locked'. Options are:
  • 0 = None (common/null.wav)
  • 2 = Access Denied (buttons/button2.wav)
  • 8 = Small zap (buttons/button8.wav)
  • 10 = Buzz (buttons/button10.wav)
  • 11 = Buzz Off (buttons/button11.wav)
  • 12 = Latch Locked (buttons/latchlocked1.wav)
• Unlocked Sound (unlocked_sound) - Sound to play when entity is 'unlocked'. Options are:
  • 0 = None (common/null.wav)
  • 1 = Big zap & Warmup (buttons/button1.wav)
  • 3 = Access Granted (buttons/button3.wav)
  • 4 = Quick Combolock (buttons/button4.wav)
  • 5 = Power Deadbolt 1 (buttons/button5.wav)
  • 6 = Power Deadbolt 2 (buttons/button6.wav)
  • 7 = Plunger (buttons/button7.wav)
  • 8 = Small zap (buttons/button8.wav)
  • 9 = Keycard Sound (buttons/button9.wav)
  • 10 = Buzz (buttons/button10.wav)
  • 13 = Latch Unlocked (buttons/latchunlocked1.wav)
  • 14 = Light Switch (buttons/lightswitch2.wav)
• Locked Sentence (locked_sentence) - Sentence that is spoken when entity is 'locked'. Options are:
  • 1 = Gen. Access Denied (NA)
  • 2 = Security Lockout (ND)
  • 3 = Blast Door (NF)
  • 4 = Fire Door (NFIRE)
  • 5 = Chemical Door (NCHEM)
  • 6 = Radiation Door (NRAD)
  • 7 = Gen. Containment (NCON)
  • 8 = Maintenance Door (NH)
  • 9 = Broken Shut Door (NG)
• Unlocked Sentence (unlocked_sentence) - Sentence that is spoken when entity is 'unlocked'. Options are:
  • 1 = Gen. Access Granted (EA)
  • 2 = Security Disengaged (ED)
  • 3 = Blast Door (EF)
  • 4 = Fire Door (EFIRE)
  • 5 = Chemical Door (ECHEM)
  • 6 = Radiation Door (ERAD)
  • 7 = General Containment (ECON)
  • 8 = Maintenance area (EH)

• ZHLT Lightflags (zhlt_lightflags)
• Light Origin Target (light_origin)
• Minimum light level (_minlight)

Flags

• Don't move (1) - If this is enabled, the button will not move (oriented by angles) when triggered.
• Toggle (32) - Sets button mode to toggle (it does not reset, but waits to be activated again).
• Sparks (64) - Makes button spark randomly when in the off position.
• Touch activates (256) - Button can only be activated by the player bumping into it (or by being damaged, if Health is specified).

Notes

• In addition to speed, the button will move relative to angles and according to its brush size; the larger the brush, the longer the time until it reaches the other edge (time can be reduced by lip).
• While moving, it can get blocked by monsters, player and func_pushable, but not by any other thing; can't hurt; can't be used neither return nor trigger the target until unblocked and completed the move.
• It can be pressed 64 units away from its edge by the player, regardless of anything surrounding it.
• Apply one of the toggling textures (ones with '+0' or '+A' at the beginning of their names) to get an alternative to the moving button.
• Locked Sound and Locked Sentence will be played if the button has a master that is not active.
• Although Unlocked Sound is supposed to override sounds, it doesn't.
• When the button is back home on return, it retriggers all its targets that have multisource classname. It allows to lock some other entity once the button is returned. It's useful when you want to make a player do something on time while the button is resetting, or require multiple players to press buttons at the same time in order to fire something else through the unlocked multisource (e.g. some co-op maps use this feature to block the map from playing in singleplayer). Note that Toggle buttons trigger their target on return too, which can lead to triggering the multisource two times, effectively leaving it at the same state.
• Buttons with Toggle spawnflag generally ignore the "Delay before reset" value, as they will wait for the user input to trigger their target and switch their status, unless "Delay before reset" is set to -1, in which case they will only be usable once.
• Buttons with Toggle spawnflag doesn't check for the master on return. That means if master becomes inactive between the normal activation and return activation, the return activation will still trigger the target.
• Buttons with Toggle spawnflag can be activated again right away: there's no delay. It's worth to remember if the trigger target takes some time do its job (e.g. a door opening), because the repeated activation can lead to desynchronized state between the button and its target.
• Due to Toggle buttons not having a delay between activations, the buttons with both Toggle and Touch activates flags can fire the target a lot of times at the short period of time (one time per each registered player touch).
• Buttons with Toggle and Touch activates spawnflags fire the target two times on return (before moving and after it's done, or two times in one frame if the button has Don't move spawnflag).