class_openxractionset.rst

github_url:	hide

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.

.. rst-class:: classref-introduction-group

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 action 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.

.. rst-class:: classref-reftable-group

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

.. rst-class:: classref-reftable-group

Methods

void	:ref:`add_action<class_OpenXRActionSet_method_add_action>` ( :ref:`OpenXRAction<class_OpenXRAction>` action )
:ref:`int<class_int>`	:ref:`get_action_count<class_OpenXRActionSet_method_get_action_count>` ( ) |const|
void	:ref:`remove_action<class_OpenXRActionSet_method_remove_action>` ( :ref:`OpenXRAction<class_OpenXRAction>` action )

.. rst-class:: classref-section-separator

---

.. rst-class:: classref-descriptions-group

Property Descriptions

.. rst-class:: classref-property

:ref:`Array<class_Array>` actions = []

.. rst-class:: classref-property-setget

• void set_actions ( :ref:`Array<class_Array>` value )
• :ref:`Array<class_Array>` get_actions ( )

Collection of actions for this action set.

.. rst-class:: classref-item-separator

---

.. rst-class:: classref-property

:ref:`String<class_String>` localized_name = ""

.. rst-class:: classref-property-setget

• void set_localized_name ( :ref:`String<class_String>` value )
• :ref:`String<class_String>` get_localized_name ( )

The localized name of this action set.

.. rst-class:: classref-item-separator

---

.. rst-class:: classref-property

:ref:`int<class_int>` priority = 0

.. rst-class:: classref-property-setget

• void set_priority ( :ref:`int<class_int>` value )
• :ref:`int<class_int>` get_priority ( )

The priority for this action set.

.. rst-class:: classref-section-separator

---

.. rst-class:: classref-descriptions-group

Method Descriptions

.. rst-class:: classref-method

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

Add an action to this action set.

.. rst-class:: classref-item-separator

---

.. rst-class:: classref-method

:ref:`int<class_int>` get_action_count ( ) |const|

Retrieve the number of actions in our action set.

.. rst-class:: classref-item-separator

---

.. rst-class:: classref-method

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

Remove an action from this action set.