ARVRController

Inherits: Spatial < Node < Object

A spatial node representing a spatially-tracked controller.

Description

This is a helper spatial node that is linked to the tracking of controllers. It also offers several handy passthroughs to the state of buttons and such on the controllers.

Controllers are linked by their ID. You can create controller nodes before the controllers are available. If your game always uses two controllers (one for each hand), you can predefine the controllers with ID 1 and 2; they will become active as soon as the controllers are identified. If you expect additional controllers to be used, you should react to the signals and add ARVRController nodes to your scene.

The position of the controller node is automatically updated by the ARVRServer. This makes this node ideal to add child nodes to visualize the controller.

Tutorials

Properties

int

controller_id

1

float

rumble

0.0

Methods

String

get_controller_name ( ) const

TrackerHand

get_hand ( ) const

bool

get_is_active ( ) const

float

get_joystick_axis ( int axis ) const

int

get_joystick_id ( ) const

Mesh

get_mesh ( ) const

int

is_button_pressed ( int button ) const

Signals

  • button_pressed ( int button )

Emitted when a button on this controller is pressed.

  • button_release ( int button )

Emitted when a button on this controller is released.

  • mesh_updated ( Mesh mesh )

Emitted when the mesh associated with the controller changes or when one becomes available. Generally speaking this will be a static mesh after becoming available.

Property Descriptions

  • int controller_id

Default

1

Setter

set_controller_id(value)

Getter

get_controller_id()

The controller’s ID.

A controller ID of 0 is unbound and will always result in an inactive node. Controller ID 1 is reserved for the first controller that identifies itself as the left-hand controller and ID 2 is reserved for the first controller that identifies itself as the right-hand controller.

For any other controller that the ARVRServer detects, we continue with controller ID 3.

When a controller is turned off, its slot is freed. This ensures controllers will keep the same ID even when controllers with lower IDs are turned off.

Default

0.0

Setter

set_rumble(value)

Getter

get_rumble()

The degree to which the controller vibrates. Ranges from 0.0 to 1.0. If changed, updates ARVRPositionalTracker.rumble accordingly.

This is a useful property to animate if you want the controller to vibrate for a limited duration.

Method Descriptions

  • String get_controller_name ( ) const

If active, returns the name of the associated controller if provided by the AR/VR SDK used.

Returns the hand holding this controller, if known. See TrackerHand.

  • bool get_is_active ( ) const

Returns true if the bound controller is active. ARVR systems attempt to track active controllers.

  • float get_joystick_axis ( int axis ) const

Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller.

  • int get_joystick_id ( ) const

Returns the ID of the joystick object bound to this. Every controller tracked by the ARVRServer that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry.

  • Mesh get_mesh ( ) const

If provided by the ARVRInterface, this returns a mesh associated with the controller. This can be used to visualize the controller.

  • int is_button_pressed ( int button ) const

Returns true if the button at index button is pressed. See JoystickList, in particular the JOY_VR_* constants.