Worker Inspector

The Worker Inspector is a Unity Editor window which allows you to inspect the state of your workers in-Editor. The window allows you to view the set of entities each worker is interested in, as well as the data and authority state of components on each entity.

Usage

To open the window, ensure the Debug package is added to your project and select SpatialOS > Window > Worker Inspector from the Unity Editor menu.

Enter Play mode to start inspecting workers.

Workers

Worker selector

You can find the worker selector at the top of the window. It lets you choose which worker running in your Editor to inspect the state of. In the example below we are running a scene with a client-worker and a server-worker, choosing to inspect the state of the client.

Worker information

Underneath the worker selector, you can see the selected worker's worker type, worker ID and any worker flags set for the given worker type.

Note that worker flags are unordered and may appear in a different order to that specified in your launch configurations.

Entities

Entity list

On the left side of the window you should see a list of entities that are in a worker's view, with each entity's type and ID listed for easy navigation. You can use the search bar to filter for specified entity types.

The search bar also lets you search by entity ID.

Entity information

At the top of the panel containing entity details, you can find the entity type and entity ID of the selected entity. The type is extracted from the entity's Metadata component.

Component data

Each component is displayed on a collapsible panel containing its field's values, updated live. The values shown are those as each worker understands for that entity's component.

You can also view each component's authority state with the Is Authoritative? checkbox, which is ticked if the chosen worker is authoritative over a given component on the selected entity.

Component metadata

To get metadata on a particular component, such as which schema file it was generated from, select the icon to the right of the component name.

The name and ID of the component, in addition to the schema file it was generated from should now be logged to the Editor console. For the TransformInternal component above, the below details are logged.

TransformInternal generated from 'improbable/gdk/transform_synchronization/transform_internal.schema' with Component ID '11000'

Miscellaneous

Pagination

When lists or dictionaries contain more than 5 elements, the collection data is split across multiple pages. To flick between pages, select either the forward or back buttons.

Hide empty collections

To reduce the space taken up to display components with numerous collections, you can optionally hide empty collections. Do this by right-clicking on the component panel in Worker Inspector and selecting "Hide Empty Collections".

This feature is particularly useful when viewing components that have option<T> types, such as Interest.

Updated about a year ago


Worker Inspector


Suggested Edits are limited on API Reference Pages

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