M MY Multiplayer: Wiki
Side
Kind

unbindKey

Shared

Removes binds this resource made on a key.

bool unbindKey(player thePlayer, string key [, string keyState = both, function|string handler = nil])

Parameters

NameTypeDescription
thePlayerplayerServer only: the player the bind belongs to. On the client, leave this argument out.
keystringThe key's name, in any case: a to z, 0 to 9, F1 to F12, mouse1 to mouse5, mouse_wheel_up, mouse_wheel_down, arrow_l, num_0, space, enter, lshift and others.
keyStatestringWhich binds to remove: "down", "up" or "both".default both
handlerfunction|stringThe function or command name to unbind. Without it, every function this resource bound to the key is unbound, but not the commands.default nil

Returns

true if a bind was removed, false if there was none.

Example

local function openMenu()
    showCursor(true)
end

bindKey("m", "down", openMenu)

addCommandHandler("nomenu", function()
    unbindKey("m", "down", openMenu)
end)

See also