Sites

Menu

SpatialdManager Class

Namespace: Improbable.Gdk.TestUtils.Editor
GDK package: TestUtils
Source

Manages the lifecycle of SpatialD and provides methods to interact with it.

Inheritance

IDisposable

Child types

LocalDeployment Represents a local deployment.


Static Methods

Start Source
async Task<SpatialdManager> Start()

Starts SpatialD.

Notes:
  • If SpatialD is already running, it will stop that instance and start a new one.

Exceptions:
  • Exception : Thrown if this fails to start SpatialD.


Methods

StartLocalDeployment Source
async Task<LocalDeployment> StartLocalDeployment(string name, string deploymentJsonPath, string snapshotFileName = "default.snapshot")

Starts a local deployment asynchronously.

Returns:
A task which represents the deployment that was started.

Parameters
  • string name : The name for the local deployment.
  • string deploymentJsonPath : The path to the launch configuration JSON relative to the root of the SpatialOS project.
  • string snapshotFileName : The name of the snapshot to use for this deployment. Must be in the snapshots directory of your SpatialOS project.

Exceptions:
  • ArgumentException : Thrown if deploymentJsonPath does not exist.
  • Exception : Thrown if the deployment fails to start.
StopLocalDeployment Source
async Task StopLocalDeployment(LocalDeployment deployment)

Stops a local deployment asynchronously.

Returns:
A task which represents the operation to stop the deployment.

Parameters

Exceptions:
  • Exception : Thrown if the deployment fails to be stopped.
GetRunningDeployments Source
async Task<List<LocalDeployment>> GetRunningDeployments()

Gets the details of currently running deployments asynchronously.

Returns:
A task which represents list of
Dispose Source
void Dispose()

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums