Namespace SpatialSys.UnitySDK

Defines all the animation clips that are part of the avatar animation controller

This component enables a GameObject to be synchronized across the network. A network object handles synchronizing the transform, rigidbody, and custom variables defined through visual scripting or NetworkVariables within SpatialNetworkBehaviour.

Network objects can be either embedded in a scene or instantiated from a prefab.

To spawn a network object for all clients, use SpatialBridge.spaceContentService.Spawn. Note that GameObject.Instantiate will only create a network object for the local client.

To despawn a network object you can simply Object.Destroy the GameObject, or use SpatialBridge.spaceContentService.DestroySpaceObject. This will despawn the object for all clients.

The main interface that provides access to Spatial services. This acts like a bridge between user code and Spatial core functionality.

void Start()
{
    SpatialBridge.coreGUIService.DisplayToastMessage("Hello World");
}

void Start()
{
    SpatialBridge.coreGUIService.DisplayToastMessage("Hello World");
}

Arguments for the onCustomPropertiesChanged event.

Arguments for the onActorJoined event.

Arguments for the onActorLeft event.

The result of a request to get an actor's profile picture.

An actor in the space. This represents a user who has joined the server instance.

Service for interacting with actors and users in the space.

The local actor (user on the current machine).

Operation to request an ad to show up

Service to handle ads integration

Type of ad to show.

Service for playing audio.

Service to handle badges

This service provides access to all camera related functionality: Main camera state, player camera settings, camera shake, and target overrides.

The method of rotation for the actor camera with respect to player inputs. How should the camera be controlled?

The camera's point of view for a player in an XR headset

Service for handling all UI related functionality.

Interface for world-shop specific functionality. This only controls the world shop GUI, not the universal shop GUI.

This service provides alternative methods to subscribe to events, since the Creator Toolkit prohibits direct access events outside of the SpatialSDK namespace.

This service provides access to all render pipeline asset related functionality: Lighting, shadows, quality, etc.

Interface for listening to avatar input capture events. Only events overridden with StartAvatarInputCapture will be triggered.

Interface for listening to input capture events.

Service for handling all input related functionality.

Interface for listening to vehicle input capture events. Only events overridden with StartVehicleInputCapture will be triggered.

Phase of the input event.

Represents an item in the user's inventory / backpack.

Service to handle inventory and currency

This currently simply logs errors to the console, but in the future we may provide a service that logs to a remote server which can be viewed by the developer.

This interface allows sending and receiving custom network messages.

Supported event argument types: byte, bool, short, int, long, float, double, string, Vector2, Vector3, Quaternion, Color, Color32, Vector4, DateTime

This service provides access to all the networking functionality in Spatial: connectivity, server management, matchmaking, remove events (RPCs/Messaging), etc.

Arguments for the onEvent callback in INetworkingRemoteEventsService

The connection status to the current server

Basic interface Quest component

Service for managing Quests on the space.

Interface that represents a task for a ISpatialQuest.

Interface that represents a reward for a ISpatialQuest.

The status of the quest.

The type of task.

The type of reward.

A prefab object interface that allows for read and write access to the object. Setting values on the object requires the local client to have ownership of the object.

The data-model for a prefab objects as it exists on the server. Prefab object's are a component of SpaceObjects.

The data-model for an object as it exists on the server. Space objects can be created, destroyed, and modified by actors in the space.

A component of a space object.

Service for interacting with a space's synchronized content.

A space object interface that allows for read and write access to the object. Setting values on the object requires the local client to have ownership of the object.

A component of a space object.

Arguments for the ISpaceObject.onOwnerChanged event.

An enum used to describe what type of visual component a space object has.

Arguments for the ISpaceObject.onVariablesChanged event.

Service for interacting with the current space.

Request to dump all variables in the data store as a JSON string.

Request to get a variable from the data store.

Request to check if the data store has any variables.

Request to check if a variable exists in the data store.

Operation to be performed on the data store.

Response code for data store operations.

This service provides access to the Users datastore for the current world. Spaces that belong to the same world share the same user world datastore.

Handles Visual Effects on the spatial platform

This attribute is used for marking documentation categories for the SDK.

To be used in conjunction with SpatialNetworkBehaviour. This allows you to define a variable that will be synchronized across the network.

Base class for all Spatial's async operations. This class is yieldable and can be used in coroutines.

Extension methods for SpatialAsyncOperation.

This component allows you to define custom behaviour for a network object. It must always be accompanied by a SpatialNetworkObject component on the same GameObject or on one of its parents.

A utility class that assists with communicating between Visual Scripting and C#.

Arguments for the OnOwnershipChanged.

Arguments for the OnVariablesChanged.

To be used in conjunction with SpatialNetworkBehaviour. Called right after Spawned and when the ownership of the network object changes.