Scripting/Squirrel/Functions/UnbindKey

UnbindKey remove a binded key. (Keys cannot be removed for one Player, only for everyone)

Syntax

UnbindKey(key)

Arguments

• int key - The key you want to unbind

Example

The following example will unbind a key for a player

function onScriptLoad()
{
    lshift <- BindKey(true, 0xA0, 0, 0);
}
 
function onKeyDown( player, key )
{
    if( key == lshift )
    {
        MessagePlayer( ">> You pressed the left shift key", player );
    }
}

function OnPlayerCommand( player,cmd , text )
{
	if(cmd == "unbind")
	{
		UnbindKey(lshift);
	}
}

Notes

• Callbacks onScriptLoad, onKeyDown and onPlayerCommand were used in this example. More info about them in the corresponding pages.