Class LoadSceneEffector

Inheritance
object
AFunction
AEffector
AUnityEffector
LoadSceneEffector
Inherited Members
Namespace: Xareus.Scenarios.Unity
Assembly: Xareus.Unity.Libraries.dll
Syntax
[Renamed("SEVEN.Unity.LoadSceneEffector", "Assembly-CSharp")]
[Renamed("Xareus.Scenarios.Unity.LoadSceneEffector", "Xareus.Unity.Librairies")]
[Renamed("Xareus.Scenarios.Unity.LoadSceneEffector", "Xareus.Unity.Libraries", typeof(LoadSceneEffector.LegacyParameterConverter))]
[ParametersConverter(typeof(LoadSceneEffector.LegacyParameterConverter))]
public class LoadSceneEffector : AUnityEffector

Constructors

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

Declaration
public LoadSceneEffector(Event @event, Dictionary<string, Parameter> parameters, ContextHolder contexts)
Parameters
Type Name Description
Event event
Dictionary<string, Parameter> parameters
ContextHolder contexts

Fields

ASYNC_PARAMETER_NAME

Declaration
public const string ASYNC_PARAMETER_NAME = "Asynchronous Load"
Field Value
Type Description
string

OLD_SCENE_PARAMETER_NAME

Declaration
public const string OLD_SCENE_PARAMETER_NAME = "SceneID"
Field Value
Type Description
string

OLD_SYNC_PARAMETER_NAME

Declaration
public const string OLD_SYNC_PARAMETER_NAME = "Use Sync Unload"
Field Value
Type Description
string

SCENE_PARAMETER_NAME

Declaration
public const string SCENE_PARAMETER_NAME = "Scene"
Field Value
Type Description
string

WAIT_FOR_LOAD_PARAMETER_NAME

Declaration
public const string WAIT_FOR_LOAD_PARAMETER_NAME = "Wait for load to finish"
Field Value
Type Description
string

asyncLoad

Declaration
[ConfigurationParameter("Asynchronous Load", true, "Asynchronous loading will have less impact on perfomances while synchronous loading will halt the rendering loop.", Necessity.Required)]
protected bool asyncLoad
Field Value
Type Description
bool

finished

Declaration
protected bool finished
Field Value
Type Description
bool

loadMode

Declaration
[ConfigurationParameter("Load Option", Necessity.Required)]
protected LoadSceneMode loadMode
Field Value
Type Description
LoadSceneMode

scene

Declaration
[ConfigurationParameter("Scene", "Scene to load.", Necessity.Required)]
protected SceneReference scene
Field Value
Type Description
SceneReference

waitForSceneToLoad

Declaration
[ConfigurationParameter("Wait for load to finish", Necessity.Required)]
protected bool waitForSceneToLoad
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

Methods

SafeEffectorUpdate()

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

Declaration
public override void SafeEffectorUpdate()
Overrides