Table of Contents

Class OpenXRIPBinding

Namespace
Godot
Assembly
GodotSharp.dll

This binding resource binds an OpenXRAction to an input or output. 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". This would require two binding entries.

public class OpenXRIPBinding : Resource, IDisposable
Inheritance
OpenXRIPBinding
Implements
Inherited Members

Constructors

OpenXRIPBinding() 

public OpenXRIPBinding()

Properties

Action

OpenXRAction that is bound to BindingPath.

public OpenXRAction Action { get; set; }

Property Value

OpenXRAction

BindingModifiers

Binding modifiers for this binding.

public Array BindingModifiers { get; set; }

Property Value

Array

BindingPath

Binding path that defines the input or output bound to Action.

Note: Binding paths are suggestions, an XR runtime may choose to bind the action to a different input or output emulating this input or output.

public string BindingPath { get; set; }

Property Value

string

Paths

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

[Obsolete("Use 'Godot.OpenXRIPBinding.BindingPath' instead.")]
public string[] Paths { get; set; }

Property Value

string[]

Methods

AddPath(string)

Add an input/output path to this binding.

[Obsolete("Binding is for a single path.")]
public void AddPath(string path)

Parameters

path string

GetBindingModifier(int)

Get the OpenXRBindingModifier at this index.

public OpenXRActionBindingModifier GetBindingModifier(int index)

Parameters

index int

Returns

OpenXRActionBindingModifier

GetBindingModifierCount()

Get the number of binding modifiers for this binding.

public int GetBindingModifierCount()

Returns

int

GetPathCount()

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

[Obsolete("Binding is for a single path.")]
public int GetPathCount()

Returns

int

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

HasPath(string)

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

[Obsolete("Binding is for a single path.")]
public bool HasPath(string path)

Parameters

path string

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

RemovePath(string)

Removes this input/output path from this binding.

[Obsolete("Binding is for a single path.")]
public void RemovePath(string path)

Parameters

path string
Edit this page