WorldSubsystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Subsystem.h"
#include "Engine/EngineTypes.h"
#include "Tickable.h"
#include "WorldSubsystem.generated.h"
 
UCLASS(Abstract, MinimalAPI)
class UWorldSubsystem : public USubsystem
{
    GENERATED_BODY()
 
public:
    ENGINE_API UWorldSubsystem();
 
    ENGINE_API virtual UWorld* GetWorld() const override final;
 
    ENGINE_API UWorld& GetWorldRef() const;
 
    ENGINE_API virtual bool ShouldCreateSubsystem(UObject* Outer) const override;
 
    ENGINE_API virtual void Initialize(FSubsystemCollectionBase& Collection) override;
 
    ENGINE_API virtual void PostInitialize();
 
    virtual void PreDeinitialize() {}
    
    ENGINE_API virtual void OnWorldBeginPlay(UWorld& InWorld);
 
    virtual void OnWorldEndPlay(UWorld& InWorld) {}
 
    virtual void OnWorldComponentsUpdated(UWorld& World) {}
 
    ENGINE_API void EnsureHasCalledPostInitialize() const;
 
    ENGINE_API void EnsureHasCalledBeginPlay() const;
 
    UE_DEPRECATED(5.5, "Implement IStreamingWorldSubsystemInterface instead.")
    ENGINE_API virtual void UpdateStreamingState();
 
protected:
    ENGINE_API virtual bool DoesSupportWorldType(const EWorldType::Type WorldType) const;
 
    bool bHasCalledPostInitialize : 1 = false;
    bool bHasCalledBeginPlay : 1 = false;
};
 
UCLASS(Abstract, MinimalAPI)
class UTickableWorldSubsystem : public UWorldSubsystem, public FTickableGameObject
{
    GENERATED_BODY()
 
public:
    ENGINE_API UTickableWorldSubsystem();
 
    // FTickableGameObject implementation Begin
    ENGINE_API UWorld* GetTickableGameObjectWorld() const override;
    ENGINE_API virtual ETickableTickType GetTickableTickType() const override;
    ENGINE_API virtual bool IsAllowedToTick() const override final;
    ENGINE_API virtual void Tick(float DeltaTime) override;
    virtual TStatId GetStatId() const override PURE_VIRTUAL(UTickableWorldSubsystem::GetStatId, return TStatId(););
    // FTickableGameObject implementation End
 
    // USubsystem implementation Begin
    ENGINE_API virtual void Initialize(FSubsystemCollectionBase& Collection) override;
    ENGINE_API virtual void Deinitialize() override;
    ENGINE_API virtual void BeginDestroy() override;
    // USubsystem implementation End
 
    bool IsInitialized() const { return bInitialized; }
 
private:
    bool bInitialized = false;
};