The AR/VR server.
    public static class ARVRServer

The AR/VR server is the heart of our AR/VR solution and handles all the processing.

Inheritance Chain

Static Properties

    public static ARVRInterface PrimaryInterface { get; set; }

    public static Object Singleton { get; }

    public static float WorldScale { get; set; }

Allows you to adjust the scale to your game’s units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter.

Static Methods

    public static void CenterOnHmd(RotationMode rotationMode, bool keepHeight)

This is an important function to understand correctly. AR and VR platforms all handle positioning slightly differently.

For platforms that do not offer spatial tracking, our origin point (0,0,0) is the location of our HMD, but you have little control over the direction the player is facing in the real world.

For platforms that do offer spatial tracking, our origin point depends very much on the system. For OpenVR, our origin point is usually the center of the tracking space, on the ground. For other platforms, it’s often the location of the tracking camera.

This method allows you to center your tracker on the location of the HMD. It will take the current location of the HMD and use that to adjust all your tracking data; in essence, realigning the real world to your player’s current position in the game world.

For this method to produce usable results, tracking information must be available. This often takes a few frames after starting your game.

You should call this method after a few seconds have passed. For instance, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, or when implementing a teleport mechanism.

    public static ARVRInterface FindInterface(string name)

Finds an interface by its name. For instance, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it.

    public static Transform GetHmdTransform()

Returns the primary interface’s transformation.

    public static ARVRInterface GetInterface(int idx)

Gets the interface registered at a given index in our list of interfaces.

    public static int GetInterfaceCount()

Gets the number of interfaces currently registered with the AR/VR server. If your project supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try to initialize each interface and use the first one that returns true.

    public static Godot.Collections.Array GetInterfaces()

Returns a list of available interfaces the ID and name of each interface.

    public static ulong GetLastCommitUsec()

    public static ulong GetLastFrameUsec()

    public static ulong GetLastProcessUsec()

    [Obsolete("GetPrimaryInterface is deprecated. Use the PrimaryInterface property instead.")]
    public static ARVRInterface GetPrimaryInterface()

Getter for PrimaryInterface

    public static Transform GetReferenceFrame()

Gets the reference frame transform. Mostly used internally and exposed for GDNative build interfaces.

    public static ARVRPositionalTracker GetTracker(int idx)

Gets the positional tracker at the given ID.

    public static int GetTrackerCount()

Gets the number of trackers currently registered.

    [Obsolete("GetWorldScale is deprecated. Use the WorldScale property instead.")]
    public static float GetWorldScale()

Getter for WorldScale

    [Obsolete("SetPrimaryInterface is deprecated. Use the PrimaryInterface property instead.")]
    public static void SetPrimaryInterface(ARVRInterface @interface)

Setter for PrimaryInterface

    [Obsolete("SetWorldScale is deprecated. Use the WorldScale property instead.")]
    public static void SetWorldScale(float arg0)

Setter for WorldScale


    "interface_added" (String interface_name)

Emitted when a new interface has been added.

    "interface_removed" (String interface_name)

Emitted when an interface is removed.

    "tracker_added" (String tracker_name, int type, int id)

Emitted when a new tracker has been added. If you don’t use a fixed number of controllers or if you’re using ARVRAnchors for an AR solution, it is important to react to this signal to add the appropriate ARVRController or ARVRAnchor nodes related to this new tracker.

    "tracker_removed" (String tracker_name, int type, int id)

Emitted when a tracker is removed. You should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one).

Inner Types


Name Value Description
ResetFullRotation 0 Fully reset the orientation of the HMD. Regardless of what direction the user is looking to in the real world. The user will look dead ahead in the virtual world.
ResetButKeepTilt 1 Resets the orientation but keeps the tilt of the device. So if we’re looking down, we keep looking down but heading will be reset.
DontResetRotation 2 Does not reset the orientation of the HMD, only the position of the player gets centered.


Name Value Description
Controller 1 The tracker tracks the location of a controller.
Basestation 2 The tracker tracks the location of a base station.
Anchor 4 The tracker tracks the location and size of an AR anchor.
AnyKnown 127 Used internally to filter trackers of any known type.
Unknown 128 Used internally if we haven’t set the tracker type yet.
Any 255 Used internally to select all trackers.