Class NetworkScenario

Base class to implement network scenarios, used to start, pause, and resume their behavior at runtime.

Inheritance

object

NetworkScenario

NetworkScenarioBehaviour

NetworkScenarioTask

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Multiplayer.Tools.NetworkSimulator.Runtime

Assembly: solution.dll

Syntax

[Serializable]
public abstract class NetworkScenario

Remarks

This base class should be used for custom scenarios. If an frame update is desired, NetworkScenarioBehaviour instead. If an asynchronous task-based implementation is desired, NetworkScenarioTask instead.

Properties

Name	Description
IsPaused	Pause state of the scenario. Returns true when the scenario is paused, false otherwise. Set to true to pause, set to false when paused to resume.

Methods

Name	Description
Dispose()	Disposes the scenario.
OnPause()	Implement to define custom behaviour to be called when the scenario is paused.
OnResume()	Implement to define custom behaviour to be called when the scenario is resumed.
Start(INetworkEventsApi)	Starts running the underlying network scenario.