View source for Func button

{{LanguageBar}}
{{TabsBar|main=gs2|base=func_button}}
{{CD|CBaseButton|file1=buttons.cpp}}
{{This is a|brush entity|name=func_button}}

It is designed to be used for a [[player]]-usable button. When [[+use]]d by the player, it moves to a pressed position.
For an example of a <code>func_button</code> used to make a keypad, see the [[button_keypad]] prefab.

== Keyvalues ==
{{Brush rendering note}}

{{KV Targetname}}
{{KV|Glow Entity|intn=glow|targetname|only={{l4ds}}|The name of an entity that will get a {{ent|+use}} glow for this button. {{note|{{l4d2}} the "Hand Extend" animation will play when looking at Glow Entity.}}{{bug|The Engine cannot properly find the Glow entity if it's off-grid. It will pick several entities close to where the supposed off-grid glow entity is.}} }}
{{KV|Use Look-At Limit|intn=min_use_angle|since={{csgo}}|string|Limit the usable look-at angle. -1 is looking directly away, 0 is looking perpendicular, 1 is looking directly at. To allow a deviation of at most 45°, insert cos(45°) &asymp; 0.7071 or for 5° use cos(5°) &asymp; 0.9962 (see [[dot product|dot product]]).}}
{{KV|Move Direction (Pitch Yaw Roll)|intn=movedir|angle|Specifies the direction of motion to move when the button is used.}}
{{KV|Delay Before Reset (-1 stay)|intn=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.}}
{{KV|Speed|intn=speed|integer|The speed that the button moves, in units per second.}}
{{KV|Health (Obsolete)|intn=health|integer|Legacy method of specifying whether or not the button can be shot to activate it. Use the ''Damage Activates'' spawnflag instead.}}
{{KV|Lip|intn=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.}}
{{KV|Sounds|intn=sounds|integer 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 <code>Buttons.snd</code> (followed by a number from the Value column in this table) in <code>hl2/scripts/game_sounds_world.txt</code> or your game's appropriate [[Soundscript]] file.}}}}
:{| class="standard-table mw-collapsible mw-collapsed"
! colspan=3 | Choices&nbsp;
|-
! Value || Description || Default Sound
|-
| colspan=3 | Buttons
|-
| <code>0</code> || None (Silent) || common/null.wav
|-
| <code>1</code> || Big zap & Warmup || buttons/button1.wav
|-
| <code>2</code> || Access Denied || buttons/button2.wav
|-
| <code>3</code> || Access Granted || buttons/button3.wav
|-
| <code>4</code> || Quick Combolock || buttons/button4.wav
|-
| <code>5</code> || Power Deadbolt 1 || buttons/button5.wav
|-
| <code>6</code> || Power Deadbolt 2 || buttons/button6.wav
|-
| <code>7</code> || Plunger || buttons/button7.wav
|-
| <code>8</code> || Small zap || buttons/button8.wav
|-
| <code>9</code> || Keycard Sound || buttons/button9.wav
|-
| <code>10</code> || Buzz || buttons/button10.wav
|-
| <code>11</code> || Buzz Off || buttons/button11.wav
|-
| <code>12</code> || latch locked || doors/latchlocked2.wav
|-
| <code>13</code> || Latch Unlocked || doors/latchunlocked1.wav
|-
| <code>14</code> || Lightswitch || buttons/lightswitch2.wav
|-
| <code>15</code> || small bleek || buttons/button15.wav
|-
| <code>16</code> || small deny || buttons/button16.wav
|-
| <code>17</code> || small doop || buttons/button17.wav
|-
| <code>18</code> || small tech deny || buttons/button18.wav
|-
| <code>19</code> || click and combine screen fuzz || buttons/button19.wav
|-
| <code>20</code> || roomy beep || buttons/button20.wav
|-
| colspan=3 | Levers
|-
| <code>21</code> || lever or wheel: turn + move sqeek || buttons/lever1.wav
|-
| <code>22</code> || lever or wheel: latch + release gas || buttons/lever2.wav
|-
| <code>23</code> || lever or wheel: ratchet + sqeek || buttons/lever3.wav
|-
| <code>24</code> || lever or wheel: large ratchet || buttons/lever4.wav
|-
| <code>25</code> || lever or wheel: clanky + gas release || buttons/lever5.wav
|-
| <code>26</code> || lever or wheel: latch + large metal thud || buttons/lever6.wav
|-
| <code>27</code> || lever or wheel: smaller ratchet || buttons/lever7.wav
|-
| <code>28</code> || lever or wheel: smaller lever move || buttons/lever8.wav
|-
| colspan=3 | New buttons
|-
| <code>31</code> || shock buzz || buttons/button21.wav
|-
| <code>32</code> || clickbeep || buttons/button22.wav
|-
| <code>33</code> || tech blip || buttons/button23.wav
|-
| <code>34</code> || clickbeepbeep open || buttons/button24.wav
|-
| <code>35</code> || small high blip || buttons/button12.wav
|-
| <code>36</code> || small tech fuzz blip || buttons/button13.wav
|-
| <code>37</code> || small click bleep (change to lightswitch) || buttons/button14.wav
|-
| colspan=3 | Combine Buttons
|-
| <code>40</code> || combine door lock - locked || buttons/combine_button_locked.wav
|-
| <code>41</code> || combine blip growl || buttons/combine_button1.wav
|-
| <code>42</code> || combine squick growl || buttons/combine_button2.wav
|-
| <code>43</code> || combine whine purr || buttons/combine_button3.wav
|-
| <code>44</code> || combine click talk || buttons/combine_button4.wav
|-
| <code>45</code> || combine click growl fizz || buttons/combine_button5.wav
|-
| <code>46</code> || combine click fizz (deny) || buttons/combine_button6.wav
|-
| <code>47</code> || combine click talker || buttons/combine_button7.wav
|}
{{KV|Locked Sound|intn=locked_sound|integer choices|Sound played when the player tries to use the button, and fails because it's locked.}}
:{| class="standard-table mw-collapsible mw-collapsed"
! colspan=3 | Choices&nbsp;
|-
! Value || Description || Default Sound
|-
| <code>0</code> || None || common/null.wav
|-
| <code>2</code> || Access Denied || buttons/button2.wav
|-
| <code>8</code> || Small zap || buttons/button8.wav
|-
| <code>10</code> || Buzz || buttons/button10.wav
|-
| <code>11</code> || Buzz Off || buttons/button11.wav
|-
| <code>12</code> || Latch Locked || doors/latchlocked2.wav
|}
{{KV|Unlocked Sound|intn=unlocked_sound|integer choices|Sound played when the button is unlocked. {{confirm|doesn't seem to work?}}}}
:{| class="standard-table mw-collapsible mw-collapsed"
! colspan=3 | Choices&nbsp;
|-
! Value || Description || Default Sound
|-
| <code>0</code> || None || common/null.wav
|-
| <code>1</code> || Big zap & Warmup || buttons/button1.wav
|-
| <code>3</code> || Access Granted || buttons/button3.wav
|-
| <code>4</code> || Quick Combolock || buttons/button4.wav
|-
| <code>5</code> || Power Deadbolt 1 || buttons/button5.wav
|-
| <code>6</code> || Power Deadbolt 2 || buttons/button6.wav
|-
| <code>7</code> || Plunger || buttons/button7.wav
|-
| <code>8</code> || Small zap || buttons/button8.wav
|-
| <code>9</code> || Keycard Sound || buttons/button9.wav
|-
| <code>10</code> || Buzz || buttons/button10.wav
|-
| <code>13</code> || Latch Unlocked || doors/latchunlocked1.wav
|-
| <code>14</code> || Lightswitch || buttons/lightswitch2.wav
|}
{{KV|Locked Sentence|intn=locked_sentence|integer choices|A sentence played when the player tries to use the button, and fails because it's locked.}}
:{| class="standard-table mw-collapsible mw-collapsed"
! colspan=3 | Choices&nbsp;
|-
! Value || Description
|-
| <code>0</code> || None
|-
| <code>1</code> || Gen. Access Denied
|-
| <code>2</code> || Security Lockout
|-
| <code>3</code> || Blast Door
|-
| <code>4</code> || Fire Door
|-
| <code>5</code> || Chemical Door
|-
| <code>6</code> || Radiation Door
|-
| <code>7</code> || Gen. Containment
|-
| <code>8</code> || Maintenance Door
|-
| <code>9</code> || Broken Shut Door
|}
{{KV|Unlocked Sentence|intn=unlocked_sentence|integer choices|A sentence played when the button is unlocked.}}
:{| class="standard-table mw-collapsible mw-collapsed"
! colspan=3 | Choices&nbsp;
|-
! Value || Description
|-
| <code>0</code> || None
|-
| <code>1</code> || Gen. Access Granted
|-
| <code>2</code> || Security Disengaged
|-
| <code>3</code> || Blast Door
|-
| <code>4</code> || Fire Door
|-
| <code>5</code> || Chemical Door
|-
| <code>6</code> || Radiation Door
|-
| <code>7</code> || Gen. Containment
|-
| <code>8</code> || Maintenance area
|}
{{KV|Master (Obsolete)|intn=master|target_destination|Legacy support: The name of a master entity. If the master hasn't been activated, this button cannot be pressed.|obsolete=1}}

== Flags ==
{{fl|1|Don't move}}
{{fl|32|Toggle|Makes the button fire the outputs "OnIn" and "OnOut" if being pressed repeatedly.}}
{{fl|256|Touch Activates}}
{{fl|512|Damage Activates}}
{{fl|1024|[[Use]] Activates}}
{{fl|2048|Starts locked}}
{{fl|4096|Sparks}}
{{fl|16384|Non-solid|since={{csgo}}{{also|{{gmod}}}}}}  {{Tip|Use {{ent|func_rot_button}} instead for non-solid buttons in other games, or use a [[%CompileNonSolid]] material.}}

== Inputs ==
{{I|Lock|Lock the button, preventing it from functioning. {{Bug|Do not lock while pressed; it will not return when unlocked.}}}}
{{I|Unlock|Unlock the button, allowing it to function.}}
{{I|Press|Activate the button as if it was pressed.}}
{{I|PressIn|Activate the button as if it was pressed, sending it to the bottom position.}}
{{I|PressOut|Unpress the button, sending it to the top position. Fire OnPressed output.}}

== Outputs ==
{{O|OnDamaged|Fired when the button is damaged.}}
<dd>{{tip|If you have a button over a prop, which fires outputs by damaging the button brush, you might as well use a {{ent|prop_dynamic}} with its "OnTakeDamage" output. This will use the props [[Collision_mesh|collision mesh]] as the button, instead of a brush.</br>
This is very useful for small items, since small button brushes may compile with missing faces, due to a [[vbsp]] bug.}}</dd>
{{O|OnPressed|Fired when the button is pressed.}}
{{O|OnUseLocked|Fired when the button is used while locked.}}
{{O|OnIn|Fired when the button reaches the in/pressed position.}}
{{O|OnOut|Fired when the button reaches the out/released position. "Delay Before Reset" will fire this output, after the delay is over. If the "Toggle" flag is set, pressing the button again will fire this output.}}

== See also ==
* {{ent|func_rot_button}}
* {{ent|momentary_rot_button}}