Sites

Menu

Managing workspaces

In the new Inspector, a workspace is a view of a deployment, which contains a group of linked modules. By using workspaces, you can customize how you visualize the data that is relevant to your use case. Therefore, you can review your game in a more efficient and straightforward way.

Types of workspaces

The following types of workspaces are available in the new Inspector:

Default workspaces

To help you quickly start, we’ve introduced the following default workspaces with names:

  • Comprehensive view: A comprehensive view of your deployment. You can see the results of your query in a viewport, and select specific entities to view in a table. Then, you can choose which components to display in the columns. By default, this workspace is displayed.
  • Table view: A list of all the entities you’re querying. You can choose which components to display in the columns.
  • World view: A view of your deployment with the numbers of all worker instances and entities that you can keep track of.
  • Workers: A view of your workers in the deployment. You can also visualize worker write access authority and query-based interest (QBI) defined on the entities.

User-defined workspaces

To fulfill your custom requirements, we’ve also introduced user-defined workspaces to allow you to create a unique collection of modules of your own workspaces.

For example, you can create user-defined workspaces for the following purposes:

  • Debug replication issues unique to your game. You can create visualisations tailored to the specific components that are not being replicated correctly.
  • Debugging game behaviour (for example, pathfinding) on a specific type of NPC.
  • Monitoring play tests in real time. You can visualize relevant data on each player and gameplay systems such as AI entities.

To create a user-defined workspace for your deployment, complete the following steps:

  1. In the Console, open your deployment in the new Inspector.
  2. From the header on the page, click Comprehensive view and select New workspace from the workspace drop-down menu.
  3. Enter a name for your new workspace.

    Note: The name can contain only alphanumerics and underline, for example, create_new_workspace.

  4. Click Create, and then click Close.

If you delete a user-defined workspace, all the configurations for this workspace are lost and you cannot undo it.

Saving and loading workspaces

In the new Inspector, workspaces are saved automatically, but you can also manually save a workspace. You can consider a manually-saved workspace a specific version, which you can return to later:

  • Auto-saved workspaces: Any changes that you make to a workspace are saved automatically in the background.
  • Manually saved workspaces: You manually save the current workspace with a custom name.

When a workspace is saved automatically or manually, the following data is saved:

  • Modules and their locations
  • Position on the canvas
  • Connections between modules
  • Contents of modules, for example, queries in the query editor

Note: However, data from the SpatialOS Runtime or user selections made inside modules is not saved. For example, you select an entity in the viewport module, or you click a drop-down menu in the viewport settings module.

Auto-saved workspaces

All the changes that you make to a workspace are saved automatically every 5 seconds, which runs in the background. A later version of auto-saved workspace overwrites the earlier version.

So if you navigate away from and then back to the new Inspector, the workspace is reloaded into the recent state it was in. This is helpful when your web browser crashes or the page is refreshed.

With this feature, you need to set up your workspace only once and then you can retain and reuse it, so you can gain a deep insight into the current status of your game.

Note: For each workspace, a separate history is kept. For example, you can keep a separate saved version for a comprehensive workspace and a world workspace, and they don’t interfere with each other.

Manually saved workspaces

You can save either a default or a user-defined workspace manually with a custom name.

To switch to the workspace that you saved manually later, select it from the workspace drop-down menu.

Exporting and importing workspaces

By using the export and import functions that the new Inspector provides, you can download the configurations of a workspace in an .inspector file, and then reupload it to the Inspector. In this way, you can share your workspace configurations with others and save them for later re-use.

For example, you can create a user-defined workspace to analyze playtests and share this workspace with the entire development team.

When you export a workspace, you download an .inspector file, which contains the following configurations of the workspace:

  • Modules and their locations
  • Position on the canvas
  • Connections between modules
  • Contents of modules, for example, queries in the query editor

Note: However, data from the SpatialOS Runtime or user selections made inside modules is not included in the .inspector file.

To export a workspace, from the header on the page, click Save to expand drop-down menu, and select Export workspace.

To import a workspace, complete the following steps:

  1. From the workspace drop-down menu, select Import workspace.
  2. Upload a workspace in either of the following ways:
    • Drag and drop a workspace file
    • Click browse and select a workspace file from the directory
  3. Enter the name for the imported workspace.
  4. Click Import.

You’ve successfully imported the workspace, and the workspace name is displayed in the workspace drop-down menu.

Resetting workspaces

Before you reset a workspace, remember that:

  • If you reset a user-defined workspace, it returns to the last manually saved version.
  • If you reset a default workspace, its auto-saved version is cleared and it goes back to the workspace presets.

To reset a workspace, from the header on the page, click Save to expand drop-down menu, and select Reset workspace.


————
2019-11-25 Page added with limited editorial review

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums