Show / Hide Table of Contents

Class MyParallelEntityUpdateOrchestrator

Inheritance
System.Object
MyParallelEntityUpdateOrchestrator
Implements
IMyUpdateOrchestrator
Namespace: Sandbox.Game.Entities
Assembly: Sandbox.Game.dll
Syntax
public class MyParallelEntityUpdateOrchestrator : Object, IMyUpdateOrchestrator

Constructors

MyParallelEntityUpdateOrchestrator()

Declaration
public MyParallelEntityUpdateOrchestrator()

Fields

ForceSerialUpdate

Global switch to force serial execution.

Declaration
public static bool ForceSerialUpdate
Field Value
Type Description
System.Boolean

STATS_SPLIT_CHARACTER

Declaration
public static readonly string STATS_SPLIT_CHARACTER
Field Value
Type Description
System.String

WorkerPriority

Priority of the worker threads where work is scheduled.

Declaration
public static WorkPriority WorkerPriority
Field Value
Type Description
ParallelTasks.WorkPriority

Properties

ParallelUpdateInProgress

Declaration
public static bool ParallelUpdateInProgress { get; }
Property Value
Type Description
System.Boolean

StatsFilter

Declaration
public string StatsFilter { get; set; }
Property Value
Type Description
System.String

StatsViewDirFilter

Declaration
public bool StatsViewDirFilter { get; set; }
Property Value
Type Description
System.Boolean

Methods

AddEntity(MyEntity)

Declaration
public void AddEntity(MyEntity entity)
Parameters
Type Name Description
MyEntity entity

ClearStats()

Declaration
public void ClearStats()

DebugDraw()

Declaration
public void DebugDraw()

DispatchAfterSimulation()

Declaration
public void DispatchAfterSimulation()

DispatchBeforeSimulation()

Declaration
public void DispatchBeforeSimulation()

DispatchOnceBeforeFrame()

Declaration
public void DispatchOnceBeforeFrame()

DispatchSimulate()

Declaration
public void DispatchSimulate()

DispatchUpdatingStopped()

Declaration
public void DispatchUpdatingStopped()

EntityFlagsChanged(MyEntity)

Declaration
public void EntityFlagsChanged(MyEntity entity)
Parameters
Type Name Description
MyEntity entity

GetStats()

Declaration
public StringBuilder GetStats()
Returns
Type Description
System.Text.StringBuilder

InvokeLater(Action, String)

Schedule a callback to be invoked in the update thread at a later time.

Declaration
public void InvokeLater(Action action, string debugName = null)
Parameters
Type Name Description
System.Action action
System.String debugName
Remarks

This callback will be invoked as soon as possible (possibly even on the same frame).

ProcessInvokeLater()

Process all queued invoke later callbacks.

Declaration
public void ProcessInvokeLater()

RemoveEntity(MyEntity, Boolean)

Declaration
public void RemoveEntity(MyEntity entity, bool immediate)
Parameters
Type Name Description
MyEntity entity
System.Boolean immediate

Unload()

Declaration
public void Unload()

Implements

IMyUpdateOrchestrator
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾