Navigation
API > API/Plugins > API/Plugins/MassSimulation
| Name | UMassSimulationSubsystem |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MassGameplay/Source/MassSimulation/Public/MassSimulationSubsystem.h |
| Include Path | #include "MassSimulationSubsystem.h" |
Syntax
UCLASS (Config=Game, defaultconfig, MinimalAPI)
class UMassSimulationSubsystem : public UMassSubsystemBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UWorldSubsystem → UMassSubsystemBase → UMassSimulationSubsystem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMassSimulationSubsystem
(
const FObjectInitializer& ObjectInitializer |
MassSimulationSubsystem.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnSimulationPauseEvent | TMulticastDelegate_OneParam< void, TNotNull< UMassSimulationSubsystem * > > | MassSimulationSubsystem.h | |
| FOnSimulationStarted | TMulticastDelegate_OneParam< void, UWorld * > | MassSimulationSubsystem.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OnSimulationStarted | FOnSimulationStarted | MassSimulationSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMassProcessingPhaseManager & GetMutablePhaseManager() |
MassSimulationSubsystem.h | ||
FMassProcessingPhase::FOnPhaseEvent & GetOnProcessingPhaseFinished
(
const EMassProcessingPhase Phase |
MassSimulationSubsystem.h | ||
FMassProcessingPhase::FOnPhaseEvent & GetOnProcessingPhaseStarted
(
const EMassProcessingPhase Phase |
MassSimulationSubsystem.h | ||
FOnSimulationPauseEvent & GetOnSimulationPaused() |
INLINES. | MassSimulationSubsystem.h | |
FOnSimulationPauseEvent & GetOnSimulationResumed() |
MassSimulationSubsystem.h | ||
const FMassProcessingPhaseManager & GetPhaseManager() |
MassSimulationSubsystem.h | ||
bool IsDuringMassProcessing() |
MassSimulationSubsystem.h | ||
bool IsSimulationPaused () |
Determine if this Simulation is currently paused. | MassSimulationSubsystem.h | |
bool IsSimulationStarted() |
MassSimulationSubsystem.h | ||
void PauseSimulation() |
Pause the simulation from executing processors during phase ticks | MassSimulationSubsystem.h | |
void RegisterDynamicProcessor
(
UMassProcessor& Processor |
MassSimulationSubsystem.h | ||
void ResumeSimulation() |
Resume the simulation executing processors during phase ticks | MassSimulationSubsystem.h | |
void UnregisterDynamicProcessor
(
UMassProcessor& Processor |
MassSimulationSubsystem.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnMassEntitySettingsChange
(
const FPropertyChangedEvent& PropertyChangedEvent |
MassSimulationSubsystem.h | ||
void OnPieBegin
(
const bool bIsSimulation |
MassSimulationSubsystem.h | ||
void OnPieEnded
(
const bool bIsSimulation |
MassSimulationSubsystem.h | ||
void OnProcessingPhaseStarted
(
const float DeltaSeconds, |
MassSimulationSubsystem.h | ||
virtual void OnReleasingEventHandles() |
Override to add more handle cleanup. Will get automatically called by ReleaseEventHandles | MassSimulationSubsystem.h | |
void RebuildTickPipeline() |
MassSimulationSubsystem.h | ||
void ReleaseEventHandles () |
Called when it's time to clean up all the delegate handles. | MassSimulationSubsystem.h | |
void StartSimulation
(
UWorld& InWorld |
MassSimulationSubsystem.h | ||
void StopSimulation() |
MassSimulationSubsystem.h |
Overridden from UWorldSubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnWorldBeginPlay
(
UWorld& InWorld |
MassSimulationSubsystem.h | ||
virtual void PostInitialize() |
MassSimulationSubsystem.h |
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
MassSimulationSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
UWorldSubsystem BEGIN. | MassSimulationSubsystem.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
UWorldSubsystem END. | MassSimulationSubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FOnSimulationStarted & GetOnSimulationStarted() |
MassSimulationSubsystem.h | ||
static void HandleSimulationTickingEnabledCVarChange
(
IConsoleVariable* |
Starts/stops simulation ticking for all worlds, based on new `mass.SimulationTickingEnabled_ cvar value | MassSimulationSubsystem.h |