godot-docs/classes/class_openxractionset.rst

:github_url: hide

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

.. _class_OpenXRActionSet:

OpenXRActionSet
===============

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

Collection of :ref:`OpenXRAction<class_OpenXRAction>` resources that make up an action set.

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.

Action sets can contain the same actions, or actions with the same name, if such action sets are active at the same time the action set with the highest priority defines which binding is active.

Note that the name of the resource is used to identify the action set within OpenXR.

Properties
----------

+-----------------------------+----------------------------------------------------------------------+--------+
| :ref:`Array<class_Array>`   | :ref:`actions<class_OpenXRActionSet_property_actions>`               | ``[]`` |
+-----------------------------+----------------------------------------------------------------------+--------+
| :ref:`String<class_String>` | :ref:`localized_name<class_OpenXRActionSet_property_localized_name>` | ``""`` |
+-----------------------------+----------------------------------------------------------------------+--------+
| :ref:`int<class_int>`       | :ref:`priority<class_OpenXRActionSet_property_priority>`             | ``0``  |
+-----------------------------+----------------------------------------------------------------------+--------+

Methods
-------

+------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action<class_OpenXRActionSet_method_add_action>` **(** :ref:`OpenXRAction<class_OpenXRAction>` action **)**       |
+------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_action<class_OpenXRActionSet_method_remove_action>` **(** :ref:`OpenXRAction<class_OpenXRAction>` action **)** |
+------+-----------------------------------------------------------------------------------------------------------------------------+

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

.. _class_OpenXRActionSet_property_actions:

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

+-----------+--------------------+
| *Default* | ``[]``             |
+-----------+--------------------+
| *Setter*  | set_actions(value) |
+-----------+--------------------+
| *Getter*  | get_actions()      |
+-----------+--------------------+

Collection of actions for this action set.

----

.. _class_OpenXRActionSet_property_localized_name:

- :ref:`String<class_String>` **localized_name**

+-----------+---------------------------+
| *Default* | ``""``                    |
+-----------+---------------------------+
| *Setter*  | set_localized_name(value) |
+-----------+---------------------------+
| *Getter*  | get_localized_name()      |
+-----------+---------------------------+

The localised name of this action set.

----

.. _class_OpenXRActionSet_property_priority:

- :ref:`int<class_int>` **priority**

+-----------+---------------------+
| *Default* | ``0``               |
+-----------+---------------------+
| *Setter*  | set_priority(value) |
+-----------+---------------------+
| *Getter*  | get_priority()      |
+-----------+---------------------+

The priority for this action set.

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

.. _class_OpenXRActionSet_method_add_action:

- void **add_action** **(** :ref:`OpenXRAction<class_OpenXRAction>` action **)**

Add an action to this action set.

----

.. _class_OpenXRActionSet_method_remove_action:

- void **remove_action** **(** :ref:`OpenXRAction<class_OpenXRAction>` action **)**

Remove an action from this action set.

.. |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.)`