API reference

RuntimeAPIs Class

Public runtime APIs for Immersive Debugger that allow developers to dynamically add inspectors for their special needs at runtime.
These APIs provide a way to add inspectors for components at runtime without using DebugMember attributes. This is useful for debugging components that are created dynamically or for adding inspectors to components that you don't have source access to. For more info about Immersive Debugger, check out the official doc

Static Methods

AddInspector ( category , gameObjectName , componentClassName , members )
Adds a dedicated inspector for a specific component on a game object.
This will find the game object from scene, then find the component instance and create InstanceHandle, register in InstanceCache, and register inspector based on the Type and InstanceHandle. It will retrieve the members of this type based on filter. If Members filter is not supplied, it will automatically register all the public members within this class.
Signature
static RuntimeAPIOperationResult AddInspector(string category, string gameObjectName, string componentClassName, string members="")
Parameters
category: string  The category name for organizing the inspector
gameObjectName: string  The name of the GameObject to find in the scene
componentClassName: string  The class name of the component to inspect
members: string  Optional comma-separated list of member names to inspect. If empty, all public members will be included.
Returns
RuntimeAPIOperationResult  A RuntimeAPIOperationResult containing detailed operation result with message information for AI agents
AddInspectorItemWithGizmo ( category , gizmoType , color , gameObjectName , componentClassName , member )
Adds a dedicated inspector for a specific component on a game object.
This will find the game object from scene, then find the component instance and create InstanceHandle, register in InstanceCache, and register inspector based on the Type and InstanceHandle. It will retrieve the members of this type based on filter. If Members filter is not supplied, it will automatically register all the public members within this class.
Signature
static RuntimeAPIOperationResult AddInspectorItemWithGizmo(string category, string gizmoType, string color, string gameObjectName, string componentClassName, string member)
Parameters
category: string  The category name for organizing the inspector
gizmoType: string  The type of the gizmo - e.g. Axis, Box
color: string  The color of the gizmo - e.g. white, red, #ff0000ff
gameObjectName: string  The name of the GameObject to find in the scene
componentClassName: string  The class name of the component to inspect
member: string  The member name to be inspected and visualized by the gizmo, only one member and needs to be valid on the object
Returns
RuntimeAPIOperationResult  A RuntimeAPIOperationResult containing detailed operation result with message information for AI agents