Toolbars

This page assumes you have followed the Get started guide to download and build the SpatialOS fork of Unreal Engine (UE) and to download and install the GDK for Unreal plugin. At this point your Unreal Editor has:

  • SpatialOS settings in the Unreal Editor toolbar
  • An additional SpatialOS for Unreal GDK toolbar, which extends the Unreal Editor toolbar
  • SpatialOS options in the Unreal Editor's Window drop-down menu

The Unreal Editor with additional toolbar options from the SpatialOS GDK for Unreal.

Note: There is no Cloud button on macOS. You can start cloud deployments from Windows development machines only. Cloud deployments are not available from macOS development machines.

The GDK plugin adds extra functionality to the Play drop-down menu of the Unreal Editor’s toolbar:

The SpatialOS GDK for Unreal extends the Play dropdown of the Unreal Editor.

SpatialOS Networking: Switch between native Unreal and SpatialOS networking

SpatialOS Settings: Open the SpatialOS settings dialog box

Native Unreal networking and SpatialOS networking

To switch from using native Unreal networking to using SpatialOS networking, open the Play drop-down menu and ensure the following options are selected:

  • Net Mode > Play As Client
  • SpatialOS Networking

These settings are valid for Editor and command-line builds.

To switch back to native Unreal networking, clear SpatialOS Networking, so the box is unchecked. You do not need to change the setting in Net Mode to switch back to native Unreal networking.

If you switch back to native Unreal networking, you lose access to the multiserver features of SpatialOS, which may lead to erratic behavior.

GDK toolbar

The GDK toolbar provides several functions required to build and launch your client-workers (clients) and server-workers (servers) from inside the Unreal Editor.

Buttons and drop-down menus

The GDK toolbar has five features mapped to individual buttons and three associated drop-down menus. The toolbar is displayed in the main editor toolbar to the right of the Launch button:

The five features available through the GDK toolbar.

Note: There is no Cloud button on macOS. You can start cloud deployments from Windows development machines only. Cloud deployments are not available from macOS development machines.

Button Description
Start Deployment Start a cloud (Windows only) or local deployment with the launch configuration specified in the Editor settings or SpatialOS Network Options drop-down menu.
Stop Deployment Stop a running local deployment. This button replaces the Start Deployment button when a local deployment is running.
SpatialOS Network Options drop-down menu Specify whether your Play In Editor (PIE) sessions start a local or cloud deployment, and other deployment options. For information, see SpatialOS Network Options.
Inspector Open the Inspector in a browser (for your local deployment only).
Cloud (Windows only) Open the Cloud Deployment Configuration dialog box and start a cloud deployment.
Deployment Tools dropdown menu Open the Launch Configuration Editor to specify your deployment parameters and save them to a launch configuration file.
Schema Create schema for your Unreal project.
Schema Generation Options drop-down menu Schema (Full Scan): create schema for your Unreal project. Delete schema database: delete the schema database.
Snapshot Generate a SpatialOS snapshot.

You can also access the same features provided by the buttons on the GDK toolbar by using the Unreal Editor’s Window menu:

The Window menu of the Unreal Editor on Windows 10.

The Window menu of the Unreal Editor on macOS.

The Window menu of the Unreal Editor is extended to add the same features as the GDK toolbar.


2020-09-22 Page updated with full editorial review: added details of the drop-down menus in the GDK toolbar
2020-08-19 Page updated with full editorial review: updated the procedure to reflect Play menu changes in Unreal 4.25
2020-06-25 Page updated with full editorial review
2020-01-14 Page updated with full editorial review
2019-07-31 Page updated with limited editorial review

Updated 12 months ago


Toolbars


Suggested Edits are limited on API Reference Pages

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