{{tag>event button}}

{{htmlmetatags>metatag-keywords=(pac3, wiki, event, button)
metatag-description=(Triggers while holding a given key.)
metatag-og:title=(Button | Event)
metatag-og:description=(Triggers while holding a given key.)
}}

====== Button ======
Triggers while holding a given key.

<block box compact>
{{fa>info?color=#3bb0ff&fw&lg}} This event only works while you're holding the button, if you're looking for a toggle button see [[:part:event:#command|command]] event.
</block>

===== Operator =====
None, this event does not use any operators.

===== Arguments =====
^name^type^description^
|**button** | string | The button that will trigger the event. |

===== Button List =====

<button collapse="button_event_list" type="primary" size="sm">Click to show.</button>
 
<collapse id="button_event_list" collapsed="true">
==== Keyboard Keys ====
^name^description^
|**mouse_left**| Left mouse button |
|**mouse_right**| Right mouse button |
|**mouse_middle**| Middle mouse button (scroll wheel click)|
|**mouse_4**| "Back" mouse button |
|**mouse_5**| "Forward" mouse button |
|**mouse_wheel_up**| Mouse wheel scroll up |
|**mouse_wheel_down**| Mouse wheel scroll down |
|**f1** to **f12** | Function keys from F1 to F12 |
|**0** to **9**| Main keyboard numbers from 0 to 9 |
|**pad_0** to **pad_9**| Keypad numbers from 0 to 9 |
|**pad_divide**| Keypad slash key (/) |
|**pad_multiply**| Keypad asterisk key (*) |
|**pad_minus**| Keypad minus key (-) |
|**pad_plus**| Keypad plus key (+) |
|**pad_enter**| Keypad enter key |
|**pad_decimal**| Keypad dot key (.) |
|**a** to **z**| Letters from a to z |
|**lbracket**| Left square bracket key ([) |
|**rbracket**| Right square bracket key (]) |
|**semicolon**| Semicolon key (;) |
|**apostrophe**| Apostrophe key (') |
|**backquote**| Back quote key (`) |
|**comma**| Comma key (,) |
|**period**| Period key (.) |
|**slash**| Slash key (/) |
|**backslash**| Backslash key (\) |
|**minus**| Minus key (-) |
|**equal**| Equal sign key %%(=)%% |
|**enter**| Enter key |
|**space**| Space key |
|**backspace**| Backspace key | 
|**tab**| Tabulator key |
|**capslock**| Caps Lock key |
|**numlock**| Num Lock key |
|**escape**| Escape key |
|**scrolllock**| Scroll Lock key|
|**insert**| Insert key |
|**delete**| Delete key |
|**home**| Home key |
|**end**| End key |
|**pageup**| Page Up key |
|**pagedown**| Page Down key |
|**break**| Break key <text type="danger">Can't get it to work??</text> |
|**lshift**| Left Shift key |
|**rshift**| Right Shift key |
|**lalt**| Left Alt key |
|**ralt**| Right Alt key |
|**lcontrol**| Left Control key |
|**rcontrol**| Right Control key |
|**lwin**| Left Windows key <text type="danger">Can't get it to work??</text> |
|**up**| Up Arrow key |
|**left**| Left Arrow key |
|**down**| Down Arrow key |
|**right**| Right Arrow key |

==== Controller Buttons ====
^name^description^
|**xbutton_a**| <text type="success">A</text> or <text type="primary">Cross</text> <text type="danger">Can't get it to work??</text>|
|**xbutton_b**| <text type="success">B</text> or <text type="primary">Circle</text> button|
|**xbutton_x**| <text type="success">Y</text> or <text type="primary">Triangle</text> button|
|**xbutton_y**| <text type="success">X</text> or <text type="primary">Square</text> button|
|**xbutton_left_shoulder**| <text type="success">Left Bumper</text> or <text type="primary">L1</text> button|
|**xbutton_right_shoulder**| <text type="success">Right Bumper</text> or <text type="primary">R1</text> button|
|**xbutton_ltrigger**| <text type="success">Left Trigger</text> or <text type="primary">L2</text> button|
|**xbutton_rtrigger**| <text type="success">Right Trigger</text> or <text type="primary">R2</text> button|
|**xbutton_back**| <text type="success">Back</text> or <text type="primary">Share</text> button |
|**xbutton_start**| <text type="success">Start</text> or <text type="primary">Options</text> button |
|**xbutton_up**| D-Pad Up <text type="danger">Can't get it to work??</text> |
|**xbutton_down**| D-Pad Down |
|**xbutton_left**| D-Pad Left |
|**xbutton_right**| D-Pad Right |
|**xbutton_stick1**| Left Stick press |
|**xbutton_stick2**| Right Stick press |
|**xstick1_up**| Left Stick up |
|**xstick1_down**| Left Stick down |
|**xstick1_left**| Left Stick left |
|**xstick1_right**| Left Stick right |
|**xstick2_up**| Right Stick up |
|**xstick2_down**| Right Stick down |
|**xstick2_left**| Right Stick left |
|**xstick2_right**| Right Stick right |
</collapse>

===== Usage & Examples =====
<block box>
==== Simple Button Event ====
Set the event to <span code>button</span>, button to <span code>x</span>. The event will trigger when you press **X** and stay active as long as you hold it.

<block box compact>
{{fa>download?color=#7ab353&fw&lg}} **Download:** {{asset:example:event_button.txt}}
</block>
</block>