keybinding
Vars | |
| category | The UI category to belong to. |
|---|---|
| keys | The default key(s) assigned to the keybind. |
| name | The user-facing name. |
Procs | |
| can_use | Returns whether the keybinding can be pressed by the client's current mob. |
| down | Called when the client presses the keybind. |
| should_start_looping | Called on keybind press to determine looping behaviour. If TRUE is returned, the client will be added to SSinput's processing loop. Use VERY sparingly. |
| should_stop_looping | Called on keybind release to determine looping behaviour. If TRUE is returned, the client will be removed from SSinput's processing loop. |
| up | Called when the client releases the keybind. |
Var Details
category
The UI category to belong to.
keys
The default key(s) assigned to the keybind.
name
The user-facing name.
Proc Details
can_use
Returns whether the keybinding can be pressed by the client's current mob.
Arguments:
- C - The client.
- M - The client's mob.
down
Called when the client presses the keybind.
Arguments:
- C - The client.
should_start_looping
Called on keybind press to determine looping behaviour. If TRUE is returned, the client will be added to SSinput's processing loop. Use VERY sparingly.
Arguments:
- C - The client.
should_stop_looping
Called on keybind release to determine looping behaviour. If TRUE is returned, the client will be removed from SSinput's processing loop.
Arguments:
- C - The client.
up
Called when the client releases the keybind.
Arguments:
- C - The client.