World, entities, components

SpatialOS concepts: World, entities, components

Tip: Before you read this page, you should read What is SpatialOS?

The SpatialOS game world

In a game running on SpatialOS, the SpatialOS game world is a core concept. It’s the canonical source of truth about things in your game.

Entities and components

Entities are the objects in your game. All of the data that you want to share between SpatialOS game servers has to be stored in entities. Each entity is made up of SpatialOS components; it's the components which store this data, in their properties.

Entities equate to replicated Actors in Unreal. SpatialOS components’ properties equate to replicated properties in Unreal. Note that SpatialOS components are not the same as Components in Unreal.

For example, in a world with rabbits and lettuces, you'd have the entities Rabbit and Lettuce, each with certain SpatialOS components. These components in turn would have certain properties:

Image: Entities, components, and component properties

The value of a component’s property forms part of the data about an entity. This data is stored in the SpatialOS Runtime.

Why is a SpatialOS game world necessary?

The SpatialOS game world, with its entities and their components, stores the state of the game world in a way that enables many servers and game clients to access and change it, without needing to communicate directly with each other.

2019-05-21 Page added with editorial review

Updated about a year ago

World, entities, components

Suggested Edits are limited on API Reference Pages

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