| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the OpenXRIPBinding.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_OpenXRIPBinding:
- OpenXRIPBinding
- ===============
- **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Defines a binding between an :ref:`OpenXRAction<class_OpenXRAction>` and an XR input or output.
- Description
- -----------
- This binding resource binds an OpenXR action to inputs or outputs. As most controllers have left hand and right versions that are handled by the same interaction profile we can specify multiple bindings. For instance an action "Fire" could be bound to both "/user/hand/left/input/trigger" and "/user/hand/right/input/trigger".
- Properties
- ----------
- +---------------------------------------------------+------------------------------------------------------+-------------------------+
- | :ref:`OpenXRAction<class_OpenXRAction>` | :ref:`action<class_OpenXRIPBinding_property_action>` | |
- +---------------------------------------------------+------------------------------------------------------+-------------------------+
- | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`paths<class_OpenXRIPBinding_property_paths>` | ``PackedStringArray()`` |
- +---------------------------------------------------+------------------------------------------------------+-------------------------+
- Property Descriptions
- ---------------------
- .. _class_OpenXRIPBinding_property_action:
- - :ref:`OpenXRAction<class_OpenXRAction>` **action**
- +----------+-------------------+
- | *Setter* | set_action(value) |
- +----------+-------------------+
- | *Getter* | get_action() |
- +----------+-------------------+
- Action that is bound to these paths.
- ----
- .. _class_OpenXRIPBinding_property_paths:
- - :ref:`PackedStringArray<class_PackedStringArray>` **paths**
- +-----------+-------------------------+
- | *Default* | ``PackedStringArray()`` |
- +-----------+-------------------------+
- | *Setter* | set_paths(value) |
- +-----------+-------------------------+
- | *Getter* | get_paths() |
- +-----------+-------------------------+
- Paths that define the inputs or outputs bound on the device.
- .. |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.)`
|
