Skip to main content

Input map

Input map API allows accessing input commands and their values as well as switching input schemes.

Methods​

getCommand(name: string): number​

Gets command in the input map. If command is not found, null will be returned.

local command = entity.input:getCommand("Move")

We recommend to call this function when script starts instead of during update.

Parameters:

  • name: Command name to find the command with.

Returns:

Internal representation of command.

getValueBoolean(command: number): boolean​

Retrieves command value as boolean:

local command = entity.input:getCommand("Jump")

local value = entity.input:getValueBoolean(command)

Parameters:

  • command: Internal representation of command.

Returns:

Boolean value of command.

  • For boolean commands, the value is the stored boolean value.
  • For axis 2d commands, the value is true if any axis is non-zero
  • For axis 2d commands, the value is false if both axis values are zero

isPressed(command: number): boolean​

Alias of getValueBoolean

getValueAxis2d(command: number): number, number​

Retrieves command value as Axis 2D:

local command = entity.input:getCommand("Move")

local x, y = entity.input:getValueAxis_2d(command)

Parameters:

  • command: Internal representation of command.

Returns:

Axis 2D value of command.

  • For axis 2d commands, the value is the stored Axis 2D value. This value is in range [-1.0, 1.0] for each axis.
  • For boolean commands, the value is (1.0, 1.0) if boolean value is true
  • For boolean commands, the value is (0.0, 0.0) if boolean value is false

setScheme(name: string): void​

Switches input map to provided scheme. If scheme is not found, the function does nothing.

entity.input:setScheme("Combat")

Parameters:

  • name: Name of the scheme to switch to.