cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-26 13:37:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Paradise/datum/keybinding.html
T

26 lines
6.1 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/keybinding - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/keybinding.html#var">Var Details</a> - <a href="datum/keybinding.html#proc">Proc Details</a></header><main><h1>keybinding <aside>/<a href="datum.html">datum</a>/<a href="datum/keybinding.html">keybinding</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/keybindings/_keybinding.dm#L1"><img src="git.png" width="16" height="16" title="code/datums/keybindings/_keybinding.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/keybinding.html#var/category">category</a></th><td>The UI category to belong to.</td></tr><tr><th><a href="datum/keybinding.html#var/keys">keys</a></th><td>The default key(s) assigned to the keybind.</td></tr><tr><th><a href="datum/keybinding.html#var/name">name</a></th><td>The user-facing name.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/keybinding.html#proc/can_use">can_use</a></th><td>Returns whether the keybinding can be pressed by the client's current mob.</td></tr><tr><th><a href="datum/keybinding.html#proc/down">down</a></th><td>Called when the client presses the keybind.</td></tr><tr><th><a href="datum/keybinding.html#proc/should_start_looping">should_start_looping</a></th><td>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.</td></tr><tr><th><a href="datum/keybinding.html#proc/should_stop_looping">should_stop_looping</a></th><td>Called on keybind release to determine looping behaviour.
If TRUE is returned, the client will be removed from SSinput's processing loop.</td></tr><tr><th><a href="datum/keybinding.html#proc/up">up</a></th><td>Called when the client releases the keybind.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/category"><aside class="declaration">var </aside>category <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/keybindings/_keybinding.dm#L5"><img src="git.png" width="16" height="16" title="code/datums/keybindings/_keybinding.dm 5"></a></h3><p>The UI category to belong to.</p><h3 id="var/keys"><aside class="declaration">var </aside>keys <aside>– /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/keybindings/_keybinding.dm#L7"><img src="git.png" width="16" height="16" title="code/datums/keybindings/_keybinding.dm 7"></a></h3><p>The default key(s) assigned to the keybind.</p><h3 id="var/name"><aside class="declaration">var </aside>name <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/keybindings/_keybinding.dm#L3"><img src="git.png" width="16" height="16" title="code/datums/keybindings/_keybinding.dm 3"></a></h3><p>The user-facing name.</p><h2 id="proc">Proc Details</h2><h3 id="proc/can_use"><aside class="declaration">proc </aside>can_use<aside>(/<a href="client.html">client</a>/C, /<a href="mob.html">mob</a>/M) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/keybindings/_keybinding.dm#L16"><img src="git.png" width="16" height="16" title="code/datums/keybindings/_keybinding.dm 16"></a></aside></h3><p>Returns whether the keybinding can be pressed by the client's current mob.</p>
<p>Arguments:</p>
<ul>
<li>C - The client.</li>
<li>M - The client's mob.</li>
</ul><h3 id="proc/down"><aside class="declaration">proc </aside>down<aside>(/<a href="client.html">client</a>/C) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/keybindings/_keybinding.dm#L25"><img src="git.png" width="16" height="16" title="code/datums/keybindings/_keybinding.dm 25"></a></aside></h3><p>Called when the client presses the keybind.</p>
<p>Arguments:</p>
<ul>
<li>C - The client.</li>
</ul><h3 id="proc/should_start_looping"><aside class="declaration">proc </aside>should_start_looping<aside>(/<a href="client.html">client</a>/C) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/keybindings/_keybinding.dm#L46"><img src="git.png" width="16" height="16" title="code/datums/keybindings/_keybinding.dm 46"></a></aside></h3><p>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.</p>
<p>Arguments:</p>
<ul>
<li>C - The client.</li>
</ul><h3 id="proc/should_stop_looping"><aside class="declaration">proc </aside>should_stop_looping<aside>(/<a href="client.html">client</a>/C) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/keybindings/_keybinding.dm#L56"><img src="git.png" width="16" height="16" title="code/datums/keybindings/_keybinding.dm 56"></a></aside></h3><p>Called on keybind release to determine looping behaviour.
If TRUE is returned, the client will be removed from SSinput's processing loop.</p>
<p>Arguments:</p>
<ul>
<li>C - The client.</li>
</ul><h3 id="proc/up"><aside class="declaration">proc </aside>up<aside>(/<a href="client.html">client</a>/C) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/datums/keybindings/_keybinding.dm#L35"><img src="git.png" width="16" height="16" title="code/datums/keybindings/_keybinding.dm 35"></a></aside></h3><p>Called when the client releases the keybind.</p>
<p>Arguments:</p>
<ul>
<li>C - The client.</li>
</ul></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>
Reference in New Issue View Git Blame Copy Permalink