Table of Contents

Class OpenXRAction

An OpenXR action.

Inheritance
OpenXRAction

Remarks

This resource defines an OpenXR action. Actions can be used both for inputs (buttons, joysticks, triggers, etc.) and outputs (haptics).

OpenXR performs automatic conversion between action type and input type whenever possible. An analog trigger bound to a boolean action will thus return false if the trigger is depressed and true if pressed fully.

Actions are not directly bound to specific devices, instead OpenXR recognizes a limited number of top level paths that identify devices by usage. We can restrict which devices an action can be bound to by these top level paths. For instance an action that should only be used for hand held controllers can have the top level paths "/user/hand/left" and "/user/hand/right" associated with them. See the reserved path section in the OpenXR specification for more info on the top level paths.

Note that the name of the resource is used to register the action with.

Properties

action_type

The type of action.

var action_type : int = 1

Property Value

int

Remarks

  • void set_action_type(int value)
  • int get_action_type

localized_name

The localized description of this action.

var localized_name : String = ""

Property Value

String

Remarks

  • void set_localized_name(String value)
  • String get_localized_name

toplevel_paths

A collections of toplevel paths to which this action can be bound.

var toplevel_paths : PackedStringArray = PackedStringArray()

Property Value

PackedStringArray

Remarks