SpatialOS Network Options

In this drop-down menu, you specify whether your Play In Editor (PIE) sessions connect to a local or cloud deployment, and other deployment options.

Open the drop-down menu

To open the drop-down menu, select the arrow next to Start Deployment or Stop Deployment on the GDK toolbar:

Image: The SpatialOS Network Options icon on the GDK toolbar

Image: The SpatialOS Network Options drop-down menu

Set the network options

To set the network options, complete the following information in the relevant fields.

  • SpatialOS Networking: Switch between native Unreal and SpatialOS networking.
  • Connect to a local deployment: Use this option when you want to start a local deployment on your machine, or if you want other machines on your LAN to connect to a local deployment on your machine (see Local Deployment IP below).
    If you select this option, the Play button in the Unreal toolbar will do the following:
    • start a local deployment on your development machine
    • begin a Play In Editor (PIE) session connecting to that deployment
  • Connect to a cloud deployment: Use this option when you are working with a cloud deployment and want to connect clients running locally in the Unreal Editor (Play In Editor).
    If you select this option, the Play button in the Unreal toolbar will do the following:
    • start the cloud deployment specified in Cloud Deployment Name
    • begin a Play In Editor (PIE) session connecting to that deployment
      Note: The Connect to a cloud deployment workflow for PIE uses authentication for development environments to authenticate your connection.
  • Local Deployment IP: Available when Connect to a local deployment is selected. Use this option if you want to run a local deployment on your computer that other computers on your LAN connect to. Enter the IPv4 address of your computer’s main Ethernet or Wireless LAN adaptor.
    You can also set the IP address in Editor Settings > Launch > Exposed local runtime IP address.
  • Cloud Deployment Name: Available when Connect to a cloud deployment is selected. Enter the name of the cloud deployment you want to connect to.
    If you have already started a cloud deployment, this field is automatically populated with the deployment name you specified.
  • Build Client Worker: Available when Connect to a cloud deployment is selected. If you select this option, the GDK builds and uploads a client worker before it starts the cloud deployment.
  • Build Simulated Player: Available when Connect to a cloud deployment is selected. If you select this option, the GDK builds and uploads a simulated player before it starts the cloud deployment.
  • Editor Settings: Takes you to the GDK for Unreal Editor Settings. This is equivalent to Edit > Project Settings > Editor Settings. See SpatialOS Editor Settings panel.
  • Runtime Settings: Takes you to the GDK for Unreal Runtime Settings. This is equivalent to Edit > Project Settings > Runtime Settings. See SpatialOS Runtime Settings panel.

2020-09-14 Page added with editorial review.

Updated about a year ago


SpatialOS Network Options


Suggested Edits are limited on API Reference Pages

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