Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

InputMap

Inherits: Object

A singleton that manages all InputEventActions.

Description

Manages all InputEventAction which can be created/modified from the project settings menu Project > Project Settings > Input Map or in code with add_action and action_add_event. See Node._input.

Tutorials

Methods

void

action_add_event ( StringName action, InputEvent event )

void

action_erase_event ( StringName action, InputEvent event )

void

action_erase_events ( StringName action )

float

action_get_deadzone ( StringName action )

InputEvent[]

action_get_events ( StringName action )

bool

action_has_event ( StringName action, InputEvent event )

void

action_set_deadzone ( StringName action, float deadzone )

void

add_action ( StringName action, float deadzone=0.5 )

void

erase_action ( StringName action )

bool

event_is_action ( InputEvent event, StringName action, bool exact_match=false ) const

StringName[]

get_actions ( )

bool

has_action ( StringName action ) const

void

load_from_project_settings ( )


Method Descriptions

void action_add_event ( StringName action, InputEvent event )

Adds an InputEvent to an action. This InputEvent will trigger the action.


void action_erase_event ( StringName action, InputEvent event )

Removes an InputEvent from an action.


void action_erase_events ( StringName action )

Removes all events from an action.


float action_get_deadzone ( StringName action )

Returns a deadzone value for the action.


InputEvent[] action_get_events ( StringName action )

Returns an array of InputEvents associated with a given action.

Note: When used in the editor (e.g. a tool script or EditorPlugin), this method will return events for the editor action. If you want to access your project's input binds from the editor, read the input/* settings from ProjectSettings.


bool action_has_event ( StringName action, InputEvent event )

Returns true if the action has the given InputEvent associated with it.


void action_set_deadzone ( StringName action, float deadzone )

Sets a deadzone value for the action.


void add_action ( StringName action, float deadzone=0.5 )

Adds an empty action to the InputMap with a configurable deadzone.

An InputEvent can then be added to this action with action_add_event.


void erase_action ( StringName action )

Removes an action from the InputMap.


bool event_is_action (