Skip to main content

Unity.Multiplayer.Tools.NetworkSimulator.Runtime.NetworkScenarioTask

Base class to use network scenarios with asynchronous Tasks.

Inheritance#

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

System.Dynamic.ExpandoObject

Inherited Members#

NetworkScenario.IsPaused

NetworkScenario.OnPause()

NetworkScenario.OnResume()

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: System.Dynamic.ExpandoObject#
Assembly: Tools.dll#
Syntax#
public abstract class NetworkScenarioTask : NetworkScenario

Methods#

Dispose()#

Declaration#

public override void Dispose()

Overrides#

NetworkScenario.Dispose()

Run(INetworkEventsApi, CancellationToken)#

Starts running the underlying network scenario. Make sure to handle when IsPaused and the cancellation token.

Declaration#

protected abstract Task Run(INetworkEventsApi networkEventsApi, CancellationToken cancellationToken)

Parameters#

TypeNameDescription
INetworkEventsApinetworkEventsApiAPI to trigger network simulation events.
CancellationTokencancellationTokenCancellation token to handle cancellation requests to the underlying task.

Returns#

TypeDescription
TaskTask simulating the scenario

Start(INetworkEventsApi)#

Declaration#

public override void Start(INetworkEventsApi networkEventsApi)

Parameters#

TypeNameDescription
INetworkEventsApinetworkEventsApi

Overrides#

NetworkScenario.Start(INetworkEventsApi)