XRTracker
Base XR tracker name, category and description.
XRTracker is a base metadata object, not a gameplay-world Entity. XRPositionalTracker holds poses; XRControllerTracker represents a controller. Base defaults are Name=Unknown, an empty Description and Type=Unknown; subclasses can select another category.
Name is the XRServer key. Assign it before AddTracker and keep it stable while registered. The setter changes only the field and does not rekey the registry: after an incorrect rename, the old key still returns the object and the new key returns nothing. For a tracker you manage, unregister first, change the name, then add it again. Real-device trackers should remain managed by their XR interface.
Type is a category, not a device-connection request or a change of C# subclass. Description is human-readable text, not a lookup name or profile. Metadata setters register nothing automatically. For standard head, left_hand and right_hand names, use interface-provided trackers rather than creating conflicting names.
Base defaults and the name constraint were checked through a separate XRPositionalTracker in the installed runtime. This does not establish real-device behavior, hardware-connection events or every specialized subclass. Gameplay rig setup: XR components.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Properties3
DescriptionProperty
public string Description { get; set; }Free-form human-readable description, initially empty. Not an XRServer lookup key, device profile or automatic translation. The setter stores the string without registering the tracker.
NameProperty
public StringName Name { get; set; }Tracker name, initially Unknown with a capital U in the base implementation. Assign a unique name before XRServer.AddTracker. The setter does not move a registered tracker entry to a new key; unregister before changing and add again after configuration. Do not replace real XR-interface tracker names.
TypeProperty
public XRServer.TrackerType Type { get; set; }Tracker category. The base implementation starts with Unknown and stores the supplied value without hardware-capability validation. Changing Type does not turn the object into another subclass or connect a device; use XRControllerTracker for a controller.
Methods6
GetTrackerDescstring
public string GetTrackerDesc();Returns the stored human-readable description, initially empty. Not used for tracker lookup.
stringStored tracker description.
GetTrackerNameStringName
public StringName GetTrackerName();Returns the stored tracker name. It can differ from the XRServer key if changed incorrectly after registration.
StringNameConfigured tracker name, not a registration check.
GetTrackerTypeXRServer.TrackerType
public XRServer.TrackerType GetTrackerType();Returns the stored category. It establishes neither connection, pose availability nor actual device capabilities.
XRServer.TrackerTypeStored tracker category.
SetTrackerDescvoid
public void SetTrackerDesc(string description);Free-form human-readable description, initially empty. Not an XRServer lookup key, device profile or automatic translation. The setter stores the string without registering the tracker.
| Name | Type | Default |
|---|---|---|
description | string | — |
descriptionHuman-readable text, not a tracker lookup key.
SetTrackerNamevoid
public void SetTrackerName(StringName name);Tracker name, initially Unknown with a capital U in the base implementation. Assign a unique name before XRServer.AddTracker. The setter does not move a registered tracker entry to a new key; unregister before changing and add again after configuration. Do not replace real XR-interface tracker names.
| Name | Type | Default |
|---|---|---|
name | StringName | — |
nameUnique tracker name to assign before XRServer registration.
SetTrackerTypevoid
public void SetTrackerType(XRServer.TrackerType type);Tracker category. The base implementation starts with Unknown and stores the supplied value without hardware-capability validation. Changing Type does not turn the object into another subclass or connect a device; use XRControllerTracker for a controller.
| Name | Type | Default |
|---|---|---|
type | XRServer.TrackerType | — |
typeTracker category; not a way to create another device type.