BindKey

Binds a player's key to a console command, which will be triggered when the key is pressed. Keys that are bound to actual keyboard keys are displayed and can be modified by the user from the settings window.

Syntax

Click to collapse [-]

Server

bindKey ( player thePlayer, string key, string keyState, string bindName, function handlerFunction,  [ var arguments, ... ] ) 

Click to expand [+]

Client

bindKey ( string key, string keyState, string bindName, function handlerFunction,  [ var arguments, ... ] ) 

Required Arguments

Click to collapse [-]

Server

• thePlayer: The player you wish to bind the key of.
• key: The key or control you wish to bind to the command. See key names for a list of possible keys and control names for a list of possible controls.
• keyState: A string that has one of the following values:
  • "up": If the bound key should trigger the function when the key is released
  • "down": If the bound key should trigger the function when the key is pressed
  • "both": If the bound key should trigger the function when the key is pressed or released
• bindName: The name for this key bind when it appears in the client's settings dialog.
• handlerFunction: The function that will be triggered when the player's key is pressed. This function should have the form:

function functionName ( source, key, keyState, [ var arguments, ... ] )

The values passed to this function are:

• source: The player who pressed the key
• key: The key that was pressed
• keyState: The state of the key that was pressed, down if it was pressed, up if it was released.
• arguments The optional arguments you specified when calling bindKey (see below).

Click to expand [+]

Client

• key: The key or control you wish to bind to the command. See key names for a list of possible keys and control names for a list of possible controls.
• keyState: A string that has one of the following values:
  • "up": If the bound key should trigger the function when the key is released
  • "down": If the bound key should trigger the function when the key is pressed
  • "both": If the bound key should trigger the function when the key is pressed or released
• bindName: The name for this key bind when it appears in the client's settings dialog.
• handlerFunction: The function that will be triggered when the player's key is pressed. This function should have the form:

function functionName ( key, keyState, [ var arguments, ... ] )

The values passed to this function are:

• key: The key that was pressed
• keyState: The state of the key that was pressed, down if it was pressed, up if it was released.
• arguments The optional arguments you specified when calling bindKey (see below).

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

• arguments: Any arguments you may want to pass to the function when the key is pressed by the user. Any number of arguments of can be specified, each being passed to the designated function.

Example

Click to collapse [-]

Example 1

This example will bind a player's 'F1' key and 'fire' control to 1 input function.

function funcInput ( source, key, keyState )
  local state = "let go of"
  if ( keyState == "down" ) then
    state = "pressed"
  end
  outputChatBox ( getClientName ( source ) .. " " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ( source )
  bindKey ( source, "F1", "down", "", funcInput ) -- bind the player's F1 down key
  bindKey ( source, "F1", "up", "", funcInput ) -- bind the player's F1 up key
  bindKey ( source, "fire", "both", "", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )

Click to expand [+]

Example 2

This example will bind a player's 'F1' key and 'fire' control to 1 input function, clientside.

function funcInput ( key, keyState )
  local state = "let go of"
  if ( keyState == "down" ) then
    state = "pressed"
  end
  outputChatBox ( "You " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ( source )
  bindKey ( "F1", "down", "", funcInput ) -- bind the player's F1 down key
  bindKey ( "F1", "up", "", funcInput ) -- bind the player's F1 up key
  bindKey ( "fire", "both", "", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )

See Also

• addCommandHandler
• bindKey
• executeCommandHandler
• getCommandHandlers
• getFunctionsBoundToKey
• getKeyBoundToFunction
• isControlEnabled
• removeCommandHandler
• toggleAllControls
• toggleControl
• unbindKey