UIElement:action_pressed

Executes callbacks bound to an action being pressed. Only callbacks owned by elements within this root and which can receive input are executed.

The only guarantee on callback execution order is that callbacks with the "when_focused" relevance execute before those with the "always" relevance. If any callback returns true, this function exits early.

If no callback has returned true, this function falls back to built-in input handling. Supported built-in inputs are "ui_left", "ui_right", "ui_down" and "ui_up", which move focus in the corresponding direction.

This method can only be called on elements that have no parent.

Usage

ui_element:action_pressed(player_index, action)

Arguments

Name	Type	Description
player_index	number	Number identifying the player who emitted the input.
action	string	Input action that was pressed (eg. "jump").

Returns

Name	Type	Description
handled	boolean	True if any bound callback for this input returned true or focus was moved by a built-in handler, false otherwise.

Examples

local menu = crystal.Overlay:new();
menu:bind_input("+ui_ok", "always", nil, function()
  print("Binding Executed");
end);
menu:action_pressed(1, "ui_ok"); -- Prints "Binding Executed"