Core

Classes

Name
Description

Represents an error that occurs when the player fails to authenticate via the anonymous authentication flow.

Removes components with attribute RemoveAtEndOfTick from all entities

Represents an object which can initialize the ReceptionistFlow, LocatorFlow, and LocatorFlow connection flows from the command line.

Represents an error that occurs when a connection attempt failed.

Represents an error when an Option's contained value is attempted to be accessed when the option is empty.

Utility class to help build SpatialOS entities. An EntityTemplate can be mutated be used multiple times.

Forwards logEvents and exceptions to the SpatialOS Console and logs locally.

Represents the Alpha Locator connection flow.

Logs to the Unity Console.

Represents the Receptionist connection flow.

Any component with this attribute will be removed from all entities by the CleanTemporaryComponentSystem Can be added to components extending IComponentData or ISharedComponentData

Default values for connection parameters.

Command line argument names for worker and connection configuration.

Convenience wrapper around the WorkerSDK Snapshot API.

Receives incoming messages from the SpatialOS runtime.

Provides a helper method for calling Object.DestroyImmediate() instead of Object.Destroy() in EditMode unit tests.

Represents a SpatialOS worker.

Connect workers via Monobehaviours.

Enables users to add a callback onto the disconnection event.

Represents a SpatialOS worker that is coupled with an ECS World.

A SpatialOS worker instance.

Structs

Name
Description

A unique identifier used to look up an entity in SpatialOS.

A snapshot of a SpatialOS entity.

Represents a single log. Can contain data used for structured logging.

Tag component for marking SpatialOS entities that were just checked-out and still require setup. This component is automatically added to an entity upon its creation and automatically removed at the end of the same frame.

ECS Component added to the worker entity immediately after establishing a connection to a SpatialOS deployment.

ECS Component added to the worker entity immediately after disconnecting from SpatialOS

An implementation of Option which is compatible with Unity's ECS.

ECS component which contains the SpatialOS Entity ID.

ECS Component denoting a worker entity

Interfaces

Name
Description

Represents an implementation of a flow to connect to SpatialOS.

Represents an object which can initialize a connection flow of a certain type.

Represents a handler for a SpatialOS connection.

Intermediate object for building a IConnectionHandler object.

Represents an object which can initialize the connection parameters.

The ILogDispatcher interface is used to implement different types of loggers. By default, the ILogDispatcher supports structured logging.

Denotes that an object can be snapshotted.

Denotes that an object is a SpatialOS component.

Denotes that an object represents a SpatialOS component update.

Enums

Name
Description

Describes why the connection failed.

An enum listing the available connection services.

Core.CodegenAdapters

Interfaces

Name
Description

Core.Collections

Structs

Name
Description

A type to represent a result. Can either have a success value or an error, but not both.

Core.Commands

Classes

Structs

Name
Description

An object that is the response of a CreateEntity command from the SpatialOS runtime.

An object that is the response of a DeleteEntity command from the SpatialOS runtime.

An object that is the response of an EntityQuery command from the SpatialOS runtime.

An object that is the response of a ReserveEntityIds command from the SpatialOS runtime.

An object that is a CreateEntity command request.

An object that is a DeleteEntity command request.

An object that is a EntityQuery command request.

An object that is a ReserveEntityIds command request.

Interfaces

Core.Editor

Classes

Name
Description

Base object for a singleton scriptable object.

Unity's GUIUtility.GetStateObject changes based on the structure of the GUI, for example when expanding or collapsing foldouts. Even with hints, tracking the state objects goes awry. This is a simpler implementation, meant to be used with object hashes generated by the call site, which at least has insight into what parts of the object will be stable enough to track.

Core.Editor.SceneAuthoring

Classes

Name
Description

Core.Editor.UIElements

Classes

Name
Description

Core.NetworkStats

Classes

Name
Description

Represents a single frame's data for either incoming or outgoing network messages.

Storage object for network data for a fixed number of frames.

Structs

Name
Description

Describes a type of a message.

Enums

Core.Representation

Classes

Name
Description

Structs

Name
Description

Interfaces

Core.Representation.Editor

Classes

Name
Description

A prefab processor which disables any Monobehaviours on top-level GameObjects in the Resources folder which have fields with the RequireAttribute on them.

Core.Representation.Types

Classes

Name
Description

Core.SceneAuthoring

Classes

Name
Description

Structs

Name
Description

Interfaces

Core.SceneAuthoring.AuthoringComponents

Classes

Updated about a year ago


Core


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.