func_button

From Valve Developer Community
Jump to: navigation, search

func_button is a brush entity available in all Source games. It is designed to be used for a player-usable button. When used by the player, it moves to a pressed position. For an example of a func_button used to make a keypad, see the button_keypad prefab.

Bug: Do not lock while pressed; it will not return when unlocked.

In code, it is represented by class CBaseButton, defined in buttons.cpp.

Keyvalues

Move Direction (Pitch Yaw Roll) (movedir) <angle>
Specifies the direction of motion to move when the button is used.
Speed (speed) <integer>
The speed that the button moves, in units per second.
Health (Obsolete) (health) <integer>
Legacy method of specifying whether or not the button can be shot to activate it. Use the Damage Activates spawnflag instead.
Lip (lip) <integer>
The amount, in inches, of the button to leave sticking out of the wall it recedes into when pressed. Negative values make the button recede even further into the wall.
Master (Obsolete) (master) <string>
Legacy support: The name of a master entity. If the master hasn't been activated, this button cannot be pressed.
Sounds (sounds) <choices>
Make this button emit a sound when pressed.
Note:The list below was made for Half-Life 2. All games support this keyvalue, but some don't have a number of these sound files. To edit these sounds, look for Buttons.snd (followed by a number from the Value column in this table) in hl2/scripts/game_sounds_world.txt or your game's appropriate Soundscript file.
Value Description Default Sound
Buttons
0 None (Silent) 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
12 latch locked doors/latchlocked2.wav
13 Latch Unlocked doors/latchunlocked1.wav
14 Lightswitch buttons/lightswitch2.wav
15 small bleek buttons/button15.wav
16 small deny buttons/button16.wav
17 small doop buttons/button17.wav
18 small tech deny buttons/button18.wav
19 click and combine screen fuzz buttons/button19.wav
20 roomy beep buttons/button20.wav
Levers
21 lever or wheel: turn + move sqeek buttons/lever1.wav
22 lever or wheel: latch + release gas buttons/lever2.wav
23 lever or wheel: ratchet + sqeek buttons/lever3.wav
24 lever or wheel: large ratchet buttons/lever4.wav
25 lever or wheel: clanky + gas release buttons/lever5.wav
26 lever or wheel: latch + large metal thud buttons/Lever6.wav
27 lever or wheel: smaller ratchet buttons/Lever7.wav
28 lever or wheel: smaller lever move buttons/Lever8.wav
New buttons
31 shock buzz buttons/button21.wav
32 clickbeep buttons/button22.wav
33 tech blip buttons/button23.wav
34 clickbeepbeep open buttons/button24.wav
35 small high blip buttons/button12.wav
36 small tech fuzz blip buttons/button13.wav
37 small click bleep (change to lightswitch) buttons/button14.wav
Combine Buttons
40 combine door lock - locked buttons/combine_button_locked.wav
41 combine blip growl buttons/combine_button1.wav
42 combine squick growl buttons/combine_button2.wav
43 combine whine purr buttons/combine_button3.wav
44 combine click talk buttons/combine_button4.wav
45 combine click growl fizz buttons/combine_button5.wav
46 combine click fizz (deny) buttons/combine_button6.wav
47 combine click talker buttons/combine_button7.wav
Delay Before Reset (-1 stay) (wait) <integer>
Amount of time, in seconds, after the button has been pressed before it returns to the starting position. Once it has returned, it can be used again. If the value is set to -1, the button never returns.
Locked Sound (locked_sound) <choices>
Sound played when the player tries to use the button, and fails because it's locked.
Value Description Default Sound
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 doors/latchlocked2.wav
Unlocked Sound (unlocked_sound) <choices>
Sound played when the button is unlocked.
Confirm:doesn't seem to work?
Value Description Default Sound
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 doors/latchunlocked1.wav
14 Lightswitch buttons/lightswitch2.wav
Locked Sentence (locked_sentence) <choices>
A sentence played when the player tries to use the button, and fails because it's locked.
Value Description
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) <choices>
A sentence played when the button is unlocked.
Value Description
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 area
Glow Entity (glow) <targetname> (New with Left 4 Dead)
The name of an entity that will get a +use glow for this button.
Use Look-At Limit (min_use_angle) <string> (New with Counter-Strike: Global Offensive)
Limit the usable look-at angle. -1 is looking directly away, 0 is looking perpendicular, 1 is looking directly at.

Visible Brush:

Minimum Light (_minlight) <float>
Minimum amount of light to hit this brush. 0 is none, 1 is normal, and 2 is doubled.
Damage Filter Name (damagefilter) <targetname>
When this entity receives damage, it will filter by this entity.
Render Mode (rendermode) <choices>
Set a non-standard rendering mode on this entity.
Render FX (renderfx) <choices>
Preset pattern of appearance effects.
To do: 18-21, 25
Render FX / Transparency (0 - 255) (renderamt) <integer>
Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
Render Color (R G B) (rendercolor) <color255>
Color tint.
Shadow Cast Distance (shadowcastdist) <integer> !FGD
Sets how far the entity casts dynamic shadows. 0 means default distance from the shadow_control entity.
Shadows (vrad_brush_cast_shadows) <integer> !FGD
Determines if this entity will cast lightmap shadows.
  • 0: No shadows
  • 1: Cast shadows
Disable Shadows (disableshadows) <boolean>
Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.
Disable Receiving Shadows (disablereceiveshadows) <boolean>
Prevent the entity from receiving shadows on itself.
Texture Frame (texframeindex) <integer> !FGD
The frame number for any animated textures on this entity.
Minimum CPU Level (mincpulevel) <choices> (New with Left 4 Dead)
A user with a CPU level lower than this will not see this object rendered in-game. It's unclear how the CPU level is decided, but most systems are classified as "high".
Maximum CPU Level (maxcpulevel) <choices> (New with Left 4 Dead)
  • 0: Default
  • 1: Low
  • 2: Medium
  • 3: High
Minimum GPU Level (mingpulevel) <choices> (New with Left 4 Dead)
Maximum GPU Level (maxgpulevel) <choices> (New with Left 4 Dead)
  • 0: Default
  • 1: Very low
  • 2: Low
  • 3: Medium
  • 4: High

Brush:

Minimum Bounding Box Size (mins) <vector> !FGD
Co-ordinate of the minimum bounding box corner. The bounding box is drawn from this corner to the other one. Requires Bounding Box collisions (solid 2) to be used. Can be used to overwrite the collision shape of a brush, although it can only be a cuboid.
Maximum Bounding Box Size (maxs) <vector> !FGD
Co-ordinate of the maximum bounding box corner. The bounding box is drawn from this corner to the other one. Requires Bounding Box collisions (solid 2) to be used. Can be used to overwrite the collision shape of a brush, although it can only be a cuboid.
Collisions (solid) <choices> !FGD
Method of collision for this entity.
Model Index (modelindex) <short> !FGD
Changes the entity's model to a precached model on the map.

Base:

Classname (classname) <string>
The classname defines the type of entity. Classnames can be changed using AddOutput, which will influence how the engine deals with the entity in certain circumstances.
Name (targetname) <string>
The name that other entities refer to this entity by.
Global Entity Name (globalname) <string>
Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.
Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma. Every entity can be parented, even point entities. Entities which are parented will be forced to transition to the next map, such as from a trigger_transition. Some entities which aren't intended to be parented may not function correctly. phys_constraint can be used as a workaround to parenting.
Origin (X Y Z) (origin) <coordinates>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.
Pitch Yaw Roll (X Y Z) (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.
Note:This works on brush entities, although Hammer doesn't show the new angles.
Flags (spawnflags) <integer>
Toggles features of an entity, its specific number is determined by the combination of flags added.
Response Contexts (ResponseContext) <string>
Pre-defined response system contexts for this entity. Format is key:value,key:value,.... Contexts may be filtered.
Effects (effects) <integer> !FGD
Combination of effect flags to use.
Local Time (ltime) <float> !FGD
The local time of the entity, independent of the global clock. Used mainly for physics calculations.
Next Think (nextthink) <float> !FGD
Amount of time before the entity thinks again.
Hammer ID (hammerid) <integer> !FGD
The entity's Hammer ID. Mainly used by plugins and debugging commands, such as ent_keyvalue. Can be manually assigned with the "hammerid" or "id" keyvalue. Entities spawned at run-time are not assigned any Hammer ID.
Disable for Xbox 360 (disableX360) <boolean> (New with Left 4 Dead 2) !FGD
If Yes, disables this entity on the Xbox 360 version of Source.
Entity Scripts (vscripts) <scriptlist> (New with Left 4 Dead 2)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function (thinkfunction) <string> (New with Left 4 Dead 2)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call. Try to avoid expensive operations in this function, as it may cause performance problems.
Lag Compensation (LagCompensate) <boolean> (New with Left 4 Dead 2) !FGD
Set to Yes to lag compensate this entity. Should be used very sparingly!
Is Automatic-Aim Target (is_autoaim_target) <boolean> (New with Counter-Strike: Global Offensive) !FGD
If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.

Flags

  • 1: Don't move
  • 32: Toggle
  • 256: Touch Activates
  • 512: Damage Activates
  • 1024: Use Activates
  • 2048: Starts locked
  • 4096: Sparks
  • 16384: Non-Solid (New with Counter-Strike: Global Offensive)

Inputs

Lock
Lock the button, preventing it from functioning.
Unlock
Unlock the button, allowing it to function.
Press
Activate the button as if it was pressed.
PressIn
Activate the button as if it was pressed, sending it to the bottom position.
PressOut
Unpress the button, sending it to the top position.

Visible Brush:

Alpha  <integer>
Sets the entity's transparency to a number from 0 (invisible) to 255 (fully visible). Requires the entity to have its Render Mode (rendermode) set to a number other than 0.
AlternativeSorting  <boolean>
Swaps the rendering order of the entity. Used to attempt to fix sorting problems when rendering, for example an object rendering in front of translucent materials.
Color  <color255>
Sets an RGB color for the entity.
SetDamageFilter  <targetname>
Sets a filter for this entity for when it receives damage.
EnableDamageForces
Allows the entity to be pushed by damage done to it (usually force amount correlates with the damage done).
DisableDamageForces
Prevents the entity from being pushed by damage done to it.
EnableShadow
Allows the entity to draw a render target shadow.
DisableShadow
Prevents the entity from drawing a render target shadow.
EnableDraw  (New with Portal 2)
Removes EF_NODRAW from the entity.
DisableDraw  (New with Portal 2)
Applies EF_NODRAW to the entity. Note that this is different than rendermode 10.
EnableReceivingFlashlight  (New with Portal 2)
Makes it so that the entity is lit by env_projectedtextures.
DisableReceivingFlashlight  (New with Portal 2)
Prevents the entity from being lit by env_projectedtextures. The shadow made by the texture will still cast.
EnableDrawInFastReflection  (New with Portal 2)
Makes the entity be rendered in reflections from water materials using $reflectonlymarkedentities.
DisableDrawInFastReflection  (New with Portal 2)
Prevents the entity from rendering in fast reflections.

Base:

Kill
Removes this entity and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster than Kill.
SetParent  <string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment  <string>
Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset  <string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.
AddOutput  <string>
Evaluates a keyvalue/output on this entity.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
DispatchEffect  <string> !FGD
Dispatches a special effect from the entity's origin. Removed and replaced entirely by the particle system since <Left 4 Dead>.
DispatchResponse  <string> !FGD
Dispatches a response to the entity. See Response and Concept.
AddContext  <string>
Adds to the entity's list of response contexts. Format is <key>:<value>.
RemoveContext  <string>
Remove a context from this entity's list. The name should match the key of an existing context.
ClearContext  <string>
Removes all contexts from this entity's list.
RunScriptFile  <script> (New with Left 4 Dead 2)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode  <string> (New with Left 4 Dead 2)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug:  In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction  <string> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin  <coordinates> (New with Alien Swarm) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles  <angles> (New with Alien Swarm) !FGD
Set this entity's angles.

Outputs

OnDamaged
Fired when the button is damaged.
OnPressed
Fired when the button is pressed.
OnUseLocked
Fired when the button is used while locked.
OnIn
Fired when the button reaches the in/pressed position.
OnOut
Fired when the button reaches the out/released position.

Base:

OnUser1 to OnUser4
These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (Only in the Left 4 Dead series)
This output fires when the entity is killed and removed from the game.

See Also