Class SimulationModule

Manages play in-editor feature (game simulation).

Inheritance

System.Object

FlaxEditor.Modules.EditorModule

SimulationModule

Namespace: FlaxEditor.Modules

Assembly: FlaxEngine.CSharp.dll

Syntax

public sealed class SimulationModule : EditorModule

Properties

IsDuringBreakpointHang

Gets a value indicating whether Editor is during breakpoint hit hang (eg. Visual Script breakpoint).

Declaration

public bool IsDuringBreakpointHang { get; set; }

Property Value

System.Boolean

IsPlayModeRequested

Returns true if play mode has been requested.

Declaration

public bool IsPlayModeRequested { get; }

Property Value

System.Boolean

Methods

DelegatePlayOrStopPlayInEditor()

Delegates between playing game and playing scenes in editor based on the user's editor preference.

Declaration

public void DelegatePlayOrStopPlayInEditor()

OnPlayBegin()

Declaration

public override void OnPlayBegin()

Overrides

FlaxEditor.Modules.EditorModule.OnPlayBegin()

OnPlayEnd()

Declaration

public override void OnPlayEnd()

Overrides

FlaxEditor.Modules.EditorModule.OnPlayEnd()

OnUpdate()

Declaration

public override void OnUpdate()

Overrides

FlaxEditor.Modules.EditorModule.OnUpdate()

RequestPausePlay()

Requests pause in playing.

Declaration

public void RequestPausePlay()

RequestPlayGameOrStopPlay()

Requests playing game start or stop in editor from the project's configured FirstScene.

Declaration

public void RequestPlayGameOrStopPlay()

RequestPlayOneFrame()

Requests playing single frame in advance.

Declaration

public void RequestPlayOneFrame()

RequestPlayScenesOrStopPlay()

Requests the playing scenes start or stop in editor.

Declaration

public void RequestPlayScenesOrStopPlay()

RequestResumeOrPause()

Requests the playing mode resume or pause if already running.

Declaration

public void RequestResumeOrPause()

RequestResumePlay()

Request resume in playing.

Declaration

public void RequestResumePlay()

RequestStartPlayGame()

Requests start playing in editor from the project's configured FirstScene.

Declaration

public void RequestStartPlayGame()

RequestStartPlayScenes()

Requests start playing in editor.

Declaration

public void RequestStartPlayScenes()

RequestStopPlay()

Requests stop playing in editor.

Declaration

public void RequestStopPlay()

Events

BreakpointHangBegin

Occurs when breakpoint hang begins (on eg. Visual Script breakpoint hit).

Declaration

public event Action BreakpointHangBegin

Event Type

System.Action

BreakpointHangEnd

Occurs when breakpoint hang ends (eg. Visual Script debugging tools continue game execution).

Declaration

public event Action BreakpointHangEnd

Event Type

System.Action

Extension Methods

Extensions.ReflectiveCompare<T>(T, T)

Extensions.RawClone<T>(T)

See Also

FlaxEditor.Modules.EditorModule