Up to date

This page is up to date for Godot 4.3. If you still find outdated information, please open an issue.

OpenXRIPBinding

Inherits: Resource < RefCounted < Object

Defines a binding between an OpenXRAction and an XR input or output.

Description

This binding resource binds an OpenXRAction 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

OpenXRAction

action

PackedStringArray

paths

PackedStringArray()

Methods

void

add_path(path: String)

int

get_path_count() const

bool

has_path(path: String) const

void

remove_path(path: String)


Property Descriptions

OpenXRAction action 🔗

OpenXRAction that is bound to these paths.


PackedStringArray paths = PackedStringArray() 🔗

Paths that define the inputs or outputs bound on the device.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedStringArray for more details.


Method Descriptions

void add_path(path: String) 🔗

Add an input/output path to this binding.


int get_path_count() const 🔗

Get the number of input/output paths in this binding.


bool has_path(path: String) const 🔗

Returns true if this input/output path is part of this binding.


void remove_path(path: String) 🔗

Removes this input/output path from this binding.