unbindKey
Remove vínculos criados com bindKey.
Sintaxe
Seção intitulada “Sintaxe”bool unbindKey ( string tecla [, string estado, function callback ] )bool unbindKey ( string tecla, string estado, string nomeDoComando )Parâmetros
Seção intitulada “Parâmetros”| Nome | Tipo | Padrão | Descrição |
|---|---|---|---|
tecla | string | — | Nome da tecla. |
estado | string | — | "down" ou "up" remove só os vínculos daquele estado; "both" ou nada remove os dois. Obrigatório na forma de comando. |
callback | function | — | Se informado, remove só os vínculos que usam exatamente esta função. |
nomeDoComando | string | — | Remove os vínculos daquela tecla que executam este comando (sem diferenciar maiúsculas). |
Retorno
Seção intitulada “Retorno”true se pelo menos um vínculo foi removido, false se não havia nenhum ou se o nome da tecla não for reconhecido.
Só os vínculos criados pelo resource que está chamando são afetados.
As duas formas nunca mexem nos vínculos uma da outra. A forma de função (sem terceiro argumento, ou com uma função) só remove vínculos de função: sem a função, todo vínculo de função da tecla — e do estado, quando você informa um — sai, mas os vínculos de comando ficam. Para remover um vínculo de comando é preciso nomear o comando.
Exemplo
Seção intitulada “Exemplo”local function aoPular() endbindKey("space", "down", aoPular)bindKey("space", "down", "togglehud")
unbindKey("space", "down", aoPular) -- só o vínculo de funçãounbindKey("space", "down", "togglehud") -- só o vínculo de comandounbindKey("f2", "down") -- todos os vínculos de pressionar em f2unbindKey("f2") -- todos os vínculos de f2Veja também
Seção intitulada “Veja também”getKeyState— Verifica se uma tecla está pressionada neste instante.