View source for Squirrel/Client/Functions/Controls/BindKey

{{Squirrel/Title|BindKey}}

This function binds a key to a handler function, which will be called when the player presses the key.

== Syntax ==

<code>bool BindKey( int key, int state, closure func, [ args... ] )</code>
<code>bool BindKey( int key, int state, string func, [ args... ] )</code>

== Arguments ==

* '''key''' - This is the key to be bound. For keys 'A'-'Z' and '0'-'9' this value will be the ascii code of the character. For special keys, check a list [[Squirrel/Client/Constants#Bindable_Keys|here]]
* '''state''' - The bind type, either BINDTYPE_DOWN (triggered when the key is pressed down) or BINDTYPE_UP (triggered when the key is released)
* '''func''' - Either a pointer to the handler function or the name of the function as a string
* '''args''' - Any additional arguments you wish to pass to the handler function

== Example ==

This example will print "Hallo there! 123" to the chatbox when the player presses the H key down.

<code lang="squirrel">
function onScriptLoad()
{
     BindKey( 'H', BINDTYPE_DOWN, HalloThere, 123 );
}

function HalloThere( somenumber )
{
     Message( "Hallo there! " + somenumber );
}
</code>

=== Notes ===

The function [[Squirrel/Client/Messages/Message|Message]] and call [[Squirrel/Client/Events/Misc/onScriptLoad|onScriptLoad]] were used in in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Squirrel/Client/Functions/Controls}}