Navigation
API > API/Runtime > API/Runtime/Engine
UWorldSubsystem Base class for auto instanced and initialized systems that share the lifetime of a UWorldFWorldSubsystemCollection handles calling PostInitialize and OnWorldBeginPlay for already initialized worlds
| Name | UWorldSubsystem |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Subsystems/WorldSubsystem.h |
| Include Path | #include "Subsystems/WorldSubsystem.h" |
Syntax
UCLASS (Abstract, MinimalAPI)
class UWorldSubsystem : public USubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UWorldSubsystem
Derived Classes
UWorldSubsystem derived class hierarchy
- UActionableMessageSubsystem
- UActorPartitionSubsystem
- UAsyncMessageWorldSubsystem
- UAudioGameplayTagCacheSubsystem
- UTickableWorldSubsystem
- UAvaCameraSubsystem
- UAvaEditorSubsystem
- UAvaOutlinerSubsystem
- UAvaSceneRigSubsystem
- UAvaSelectionProviderSubsystem
- UAvaSequencerSubsystem
- UAvaSequenceSubsystem
- UAvaTransitionRenderingSubsystem
- UAvaTransitionSubsystem
- UAvaViewportDataSubsystem
- UCameraAnimationSequenceSubsystem
- UChaosDebugDrawSubsystem
- UMassSubsystemBase
- UConversationRegistry
- UCsvMetricsSubsystem
- UDataLayerSubsystem
- UDaySequenceSubsystem
- UDisplayClusterWorldSubsystem
- UDMWorldSubsystem
- UDynamicWindSubsystem
- UEngineCamerasSubsystem
- UEnhancedInputWorldSubsystem
- UGameplayBehaviorSubsystem
- UGeometryCollectionISMPoolSubSystem
- UGeometryMaskWorldSubsystem
- UGPULightmassSubsystem
- UISMPoolSubSystem
- ULevelInstanceSubsystem
- ULevelStreamingPersistenceManager
- ULevelStreamingProfilingSubsystem
- UMassTestWorldSubsystem
- UMetaSoundOutputSubsystem
- UMovieGraphRenderLayerSubsystem
- UNetworkPhysicsSystem
- UNetworkPredictionWorldManager
- UNetworkSubsystem
- UObjectTraceWorldSubsystem
- UPreLoginAsyncManager
- URegisterServerManager
- URestartServerManager
- USmartObjectSubsystem
- USubtitlesSubsystem
- UViewportStatsSubsystem
- UWorldPartitionHLODRuntimeSubsystem
- UWorldPartitionStandaloneHLODSubsystem
- UWorldStreamingTraceSubsystem
- USpatialReadiness
- UWorldMetricsSubsystem
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnsureHasCalledBeginPlay() |
Subsystems/WorldSubsystem.h | ||
void EnsureHasCalledPostInitialize() |
Called during initialization to ensure the correct callbacks have happened | Subsystems/WorldSubsystem.h | |
UWorld & GetWorldRef () |
Returns a reference to the UWorld this subsystem is contained within. | Subsystems/WorldSubsystem.h | |
bool HasCalledBeginPlay() |
Returns true once the subsystem has executed OnWorldBeginPlay | Subsystems/WorldSubsystem.h | |
bool HasCalledPostInitialize() |
Returns true once the subsystem has executed PostInitialize | Subsystems/WorldSubsystem.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Returns a pointer to the UWorld this subsystem is contained within. | Subsystems/WorldSubsystem.h | ||
virtual void OnWorldBeginPlay
(
UWorld& InWorld |
Called when world is ready to start gameplay before the game mode transitions to the correct state and call BeginPlay on all actors | Subsystems/WorldSubsystem.h | |
virtual void OnWorldComponentsUpdated
(
UWorld& World |
Called after world components (e.g. line batcher and all level components) have been updated | Subsystems/WorldSubsystem.h | |
virtual void OnWorldEndPlay
(
UWorld& InWorld |
Called when world is ready to stop gameplay before the game mode transitions to the correct state and call EndPlay on all actors | Subsystems/WorldSubsystem.h | |
virtual void PostInitialize() |
Called once all UWorldSubsystems have been initialized | Subsystems/WorldSubsystem.h | |
virtual void PreDeinitialize() |
Called once all UWorldSubsystems are about to be deinitialized | Subsystems/WorldSubsystem.h |
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ShouldCreateSubsystem
(
UObject* Outer |
Calls DoesSupportWorldType to check if this subsystem should be created | Subsystems/WorldSubsystem.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool DoesSupportWorldType
(
const EWorldType::Type WorldType |
Override this to change what types of worlds support this subsystem. | Subsystems/WorldSubsystem.h |