Class UnloadSceneEffector

Inheritance

object

AFunction

AEffector

AUnityEffector

UnloadSceneEffector

Inherited Members

AUnityEffector.Reset()

AUnityEffector.Init()

AUnityEffector.SafeReset()

AUnityEffector.EffectorUpdate()

AUnityEffector.FillParameters()

AUnityEffector.UnityThreadFillParameters()

AUnityEffector.UpdateScenario()

AEffector.Event

AEffector.externalContext

AEffector.scenarioContext

AEffector.sequenceContext

AEffector.eventContext

AFunction.UpdateContexts(ContextHolder)

AFunction.SetParameters(Dictionary<string, Parameter>)

AFunction.Parameters

AFunction.Contexts

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Xareus.Scenarios.Unity

Assembly: Xareus.Unity.Libraries.dll

Syntax

public class UnloadSceneEffector : AUnityEffector

Constructors

UnloadSceneEffector(Event, Dictionary<string, Parameter>, ContextHolder)

Declaration

public UnloadSceneEffector(Event @event, Dictionary<string, Parameter> parameters, ContextHolder contexts)

Parameters

Type	Name	Description
Event	event
Dictionary<string, Parameter>	parameters
ContextHolder	contexts

Fields

finished

Declaration

protected bool finished

Field Value

Type	Description
bool

scene

Declaration

[ConfigurationParameter("Scene", "Scene to unload.", Necessity.Required)]
protected SceneReference scene

Field Value

Type	Description
SceneReference

unloadMode

Declaration

[ConfigurationParameter("Unload Option", Necessity.Required)]
protected UnloadSceneOptions unloadMode

Field Value

Type	Description
UnloadSceneOptions

waitForSceneToUnload

Declaration

[ConfigurationParameter("Wait for Scene to Unload", Necessity.Required)]
protected bool waitForSceneToUnload

Field Value

Type	Description
bool

Properties

Finished

Override to have a non-ponctual effector

Declaration

public override bool Finished { get; }

Property Value

Type	Description
bool

Overrides

AEffector.Finished

Methods

SafeEffectorUpdate()

Actual effector code. Note that this code will be executed in unity's thread

Declaration

public override void SafeEffectorUpdate()

Overrides

AUnityEffector.SafeEffectorUpdate()