PawnInitStateComponent.h

Go to the documentation of this file.

// Copyright (c) 2026 Nelaric

 
#pragma once
 
#include "Pawn/NelaricPawnComponent.h"
#include "Pawn/InitStateParticipantInterface.h"
 
#include "PawnInitStateComponent.generated.h"

UCLASS(Abstract, MinimalAPI)
class UPawnInitStateComponent : public UNelaricPawnComponent, public IInitStateParticipantInterface
{
    GENERATED_BODY()
 
public:
    GAMEPLAYRUNTIME_API virtual bool IsInitApplicable() const override;

    GAMEPLAYRUNTIME_API virtual bool TryChangeInitState() final override;

    GAMEPLAYRUNTIME_API virtual bool CanEnterReady() final override;

    GAMEPLAYRUNTIME_API virtual bool CommitReadyWithoutNotification() override;

    GAMEPLAYRUNTIME_API virtual void NotifyReadyCommitted(const Nelaric::FInitStateSnapshot& Previous) override;

    GAMEPLAYRUNTIME_API void RequestInitRefresh();

    GAMEPLAYRUNTIME_API virtual Nelaric::EInitState GetInitState() const override;

    GAMEPLAYRUNTIME_API virtual Nelaric::FInitGeneration GetInitGeneration() const override;

    GAMEPLAYRUNTIME_API virtual bool HasTerminalInitFailure() const override;

    GAMEPLAYRUNTIME_API bool CanApplyInitResult(const UWorld* ExpectedWorld,
                                                Nelaric::FInitGeneration ExpectedGeneration) const;

    GAMEPLAYRUNTIME_API static UPawnInitStateComponent*
    ResolveInitResult(const TWeakObjectPtr<UPawnInitStateComponent>& WeakComponent, const UWorld* ExpectedWorld,
                      Nelaric::FInitGeneration ExpectedGeneration);

    GAMEPLAYRUNTIME_API virtual void InvalidateInitGeneration() override;

    GAMEPLAYRUNTIME_API virtual void MarkTerminalInitFailure() override;
 
public:
    GAMEPLAYRUNTIME_API UPawnInitStateComponent(const FObjectInitializer& ObjectInitializer);
    GAMEPLAYRUNTIME_API virtual void OnRegister() override;
    GAMEPLAYRUNTIME_API virtual void OnUnregister() override;
 
protected:
    GAMEPLAYRUNTIME_API virtual bool CanEntryDataAvailable();

    GAMEPLAYRUNTIME_API virtual bool CanEntryDataInitialized();

    GAMEPLAYRUNTIME_API virtual bool CanEntryReady();

    GAMEPLAYRUNTIME_API virtual void OnInitReady();

    GAMEPLAYRUNTIME_API virtual void OnInitGenerationInvalidated(const Nelaric::FInitStateSnapshot& Previous);

    GAMEPLAYRUNTIME_API virtual void CancelInitGenerationWork();
 
private:
    bool CommitInitState(Nelaric::EInitState NextState);
    Nelaric::EInitState InitState = Nelaric::EInitState::Registered;
    Nelaric::FInitGeneration InitGeneration{1};
    bool bTerminalInitFailure = false;
    bool bCommittingInitState = false;
    bool bReadyNotificationPending = false;
    bool bLocalReadyPrepared = false;
    bool bLeavingWorld = false;
    bool bRefreshRequestedDuringTransition = false;
    void NotifyInitChanged(const Nelaric::FInitStateSnapshot& Previous);
    void FlushDeferredInitRefresh();
};