f7c611ab71
- Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
45 lines
2.1 KiB
XML
45 lines
2.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="OpenXRActionSet" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
|
<brief_description>
|
|
Collection of [OpenXRAction] resources that make up an action set.
|
|
</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.
|
|
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.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_action">
|
|
<return type="void" />
|
|
<param index="0" name="action" type="OpenXRAction" />
|
|
<description>
|
|
Add an action to this action set.
|
|
</description>
|
|
</method>
|
|
<method name="get_action_count" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Retrieve the number of actions in our action set.
|
|
</description>
|
|
</method>
|
|
<method name="remove_action">
|
|
<return type="void" />
|
|
<param index="0" name="action" type="OpenXRAction" />
|
|
<description>
|
|
Remove an action from this action set.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="actions" type="Array" setter="set_actions" getter="get_actions" default="[]">
|
|
Collection of actions for this action set.
|
|
</member>
|
|
<member name="localized_name" type="String" setter="set_localized_name" getter="get_localized_name" default="""">
|
|
The localized name of this action set.
|
|
</member>
|
|
<member name="priority" type="int" setter="set_priority" getter="get_priority" default="0">
|
|
The priority for this action set.
|
|
</member>
|
|
</members>
|
|
</class>
|