:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the OpenXRActionMap.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_OpenXRActionMap:

OpenXRActionMap
===============

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Collection of :ref:`OpenXRActionSet<class_OpenXRActionSet>` and :ref:`OpenXRInteractionProfile<class_OpenXRInteractionProfile>` resources for the OpenXR module.

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.

The action map therefor needs to be loaded at startup and can't be changed afterwards. This resource is a container for the entire action map.

Properties
----------

+---------------------------+----------------------------------------------------------------------------------+--------+
| :ref:`Array<class_Array>` | :ref:`action_sets<class_OpenXRActionMap_property_action_sets>`                   | ``[]`` |
+---------------------------+----------------------------------------------------------------------------------+--------+
| :ref:`Array<class_Array>` | :ref:`interaction_profiles<class_OpenXRActionMap_property_interaction_profiles>` | ``[]`` |
+---------------------------+----------------------------------------------------------------------------------+--------+

Methods
-------

+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action_set<class_OpenXRActionMap_method_add_action_set>` **(** :ref:`OpenXRActionSet<class_OpenXRActionSet>` action_set **)**                                                    |
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_interaction_profile<class_OpenXRActionMap_method_add_interaction_profile>` **(** :ref:`OpenXRInteractionProfile<class_OpenXRInteractionProfile>` interaction_profile **)**       |
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_default_action_sets<class_OpenXRActionMap_method_create_default_action_sets>` **(** **)**                                                                                     |
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_action_set<class_OpenXRActionMap_method_remove_action_set>` **(** :ref:`OpenXRActionSet<class_OpenXRActionSet>` action_set **)**                                              |
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_interaction_profile<class_OpenXRActionMap_method_remove_interaction_profile>` **(** :ref:`OpenXRInteractionProfile<class_OpenXRInteractionProfile>` interaction_profile **)** |
+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_OpenXRActionMap_property_action_sets:

- :ref:`Array<class_Array>` **action_sets**

+-----------+------------------------+
| *Default* | ``[]``                 |
+-----------+------------------------+
| *Setter*  | set_action_sets(value) |
+-----------+------------------------+
| *Getter*  | get_action_sets()      |
+-----------+------------------------+

----

.. _class_OpenXRActionMap_property_interaction_profiles:

- :ref:`Array<class_Array>` **interaction_profiles**

+-----------+---------------------------------+
| *Default* | ``[]``                          |
+-----------+---------------------------------+
| *Setter*  | set_interaction_profiles(value) |
+-----------+---------------------------------+
| *Getter*  | get_interaction_profiles()      |
+-----------+---------------------------------+

Method Descriptions
-------------------

.. _class_OpenXRActionMap_method_add_action_set:

- void **add_action_set** **(** :ref:`OpenXRActionSet<class_OpenXRActionSet>` action_set **)**

Add an action set.

----

.. _class_OpenXRActionMap_method_add_interaction_profile:

- void **add_interaction_profile** **(** :ref:`OpenXRInteractionProfile<class_OpenXRInteractionProfile>` interaction_profile **)**

Add an interaction profile.

----

.. _class_OpenXRActionMap_method_create_default_action_sets:

- void **create_default_action_sets** **(** **)**

Setup this action set with our default actions.

----

.. _class_OpenXRActionMap_method_remove_action_set:

- void **remove_action_set** **(** :ref:`OpenXRActionSet<class_OpenXRActionSet>` action_set **)**

Remove an action set.

----

.. _class_OpenXRActionMap_method_remove_interaction_profile:

- void **remove_interaction_profile** **(** :ref:`OpenXRInteractionProfile<class_OpenXRInteractionProfile>` interaction_profile **)**

Remove an interaction profile.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`