</brief_description>

<description>

This resource defines an OpenXR action. Actions can be used both for inputs (buttons/joystick/trigger/etc) and outputs (haptics).

Actions are not directly bound to specific devices, instead OpenXR recognises a limited number of top level paths that identify devices by usage. We can restrict which devices an action can be bound to by these top level paths. For instance an action that should only be used for hand held controllers can have the top level paths "/user/hand/left" and "/user/hand/right" associated with them. See the [url=https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#semantic-path-reserved]reserved path section in the OpenXR specification[/url] for more info on the top level paths.

Note that the name of the resource is used to register the action with.

</description>

<description>

OpenXR uses an action system similar to Godots Input map system to bind inputs and outputs on various types of XR controllers to named actions. OpenXR specifies more detail on these inputs and outputs than Godot supports.

Another important distinction is that OpenXR offers no control over these bindings. The bindings we register are suggestions, it is up to the XR runtime to offer users the ability to change these bindings. This allows the XR runtime to fill in the gaps if new hardware becomes available.

</description>

<tutorials>

</tutorials>

<methods>

<method name="add_action_set">

<return type="void" />

<description>

Add an action set.

</description>

</method>

<method name="add_interaction_profile">

<return type="void" />

<description>

Add an interaction profile.

</description>

Setup this action set with our default actions.

</description>

</method>

<method name="remove_action_set">

<return type="void" />

<description>

Remove an action set.

</description>

</method>

<method name="remove_interaction_profile">

<return type="void" />

<description>

Remove an interaction profile.

</description>

</methods>

<members>

<member name="action_sets" type="Array" setter="set_action_sets" getter="get_action_sets" default="[]">

</member>

<member name="interaction_profiles" type="Array" setter="set_interaction_profiles" getter="get_interaction_profiles" default="[]">

</member>

</members>

</class>

</brief_description>

<description>

Action sets in OpenXR define a collection of actions that can be activated in unison. This allows games to easily change between different states that require different inputs or need to reinterpret inputs. For instance we could have an action set that is active when a menu is open, an action set that is active when the player is freely walking around and an action set that is active when the player is controlling a vehicle.

</description>

<tutorials>

</tutorials>

<methods>

<method name="add_action">

<return type="void" />

<description>

Add an action to this action set.

</description>

</method>

<method name="remove_action">

<return type="void" />

<description>

Remove an action from this action set.

</description>

Defines a binding between an [OpenXRAction] and an XR input or output.

</brief_description>

<description>

</description>

<tutorials>

</tutorials>

<members>

<member name="action" type="OpenXRAction" setter="set_action" getter="get_action">

</member>

<member name="paths" type="PackedStringArray" setter="set_paths" getter="get_paths" default="PackedStringArray()">

Paths that define the inputs or outputs bound on the device.

</description>

<tutorials>

</tutorials>

<members>

<member name="bindings" type="Array" setter="set_bindings" getter="get_bindings" default="[]">

Action bindings for this interaction profile.

</brief_description>

<description>

The OpenXR interface allows Godot to interact with OpenXR runtimes and make it possible to create XR experiences and games.

</description>

<tutorials>

</tutorials>

</class>