Menu
Lumberyard
Developer Guide (Version 1.11)

ScriptBind_ActionMapManager

CryLua is deprecated and will be removed in a future version of Lumberyard.

The action map manager provides a high-level interface to handle input controls inside a game. An action map is a set of key or button mappings for a particular game mode (such as controlling a helicopter). For more information, see Controller Devices and Game Input.

EnableActionFilter

Enables or disables a specified action filter. An action filter allows actions like moveleft or moveright to succeed or fail. For more information, see Action Filters.

Syntax

Copy
ActionMapManager.EnableActionFilter( name, enable )

Parameter Description
name The name of the filter.
enable Specify true to enable the filter, or false to disable it.

EnableActionMap

Enables or disables an action map.

Syntax

Copy
ActionMapManager.EnableActionMap(const char *name, bool enable)

Parameter Description
name The name of the action map to enable or disable.
enable Specify true to enable the action map, or false to disable it.

EnableActionMapManager

Enables or disables the action map manager.

Syntax

Copy
ActionMapManager.EnableActionMapManager( enable, resetStateOnDisable )

Parameter Description
enable Enables or disables the action map manager. Specify true to enable the action map manager, or false to disable it.
resetStateOnDisable Resets the action states when the action map manager is disabled.

GetDefaultActionEntity

Retrieves the currently set default action entity.

Syntax

Copy
ActionMapManager.GetDefaultActionEntity()

InitActionMaps

Initializes the action maps and filters found in the file specified.

Syntax

Copy
ActionMapManager.InitActionMaps( path )

Parameter Description
path The XML file path.

IsFilterEnabled

Queries whether the filter specfied is currently enabled.

Syntax

Copy
ActionMapManager.IsFilterEnabled( filterName )

Parameter Description
filterName The name of the filter whose status to check.

LoadControllerLayoutFile

Loads the given controller layout into the action map manager.

Syntax

Copy
ActionMapManager.LoadControllerLayoutFile( layoutName )

Parameter Description
layoutName The name of the layout.

LoadFromXML

Loads information from an XML file.

Syntax

Copy
ActionMapManager.LoadFromXML(const char *name)

Parameter Description
name The name of the XML file to load.

SetDefaultActionEntity

Sets a new default action entity. The action map manager assigns new action maps to the action entity that you set as the default.

Syntax

Copy
ActionMapManager.SetDefaultActionEntity( id, updateAll )

Parameter Description
id Specifies the EntityId of the action entity that is to become the default.
updateAll Updates all existing action map assignments.