Program Listing for File ZagalaSpecPDWaitForTicks.h#

↰ Return to documentation for file (ZagalaSpecToolkit/Public/ProtocolDriver/ZagalaSpecPDWaitForTicks.h)

// Copyright (c) 2026, Zagala Game Solutions. All rights reserved.

#pragma once

#include "CoreMinimal.h"
#include "Core/Chain/ZagalaSpecDefaultChainLink.h"
#include "Core/Interface/Data/ZagalaSpecTaggedDataCacher.h"
#include "Engine/EngineBaseTypes.h"
#include "ZagalaSpecPDWaitForTicks.generated.h"

DECLARE_LOG_CATEGORY_EXTERN(LogZagalaSpecPDWaitForTicks, Log, All);

class UWorld;

UENUM(BlueprintType, meta = (DisplayName = "ZagalaSpec Tick Check Result"))
enum class EZagalaSpecTickCheckResult : uint8
{
    Continue,
    Succeed,
    Fail
};

UCLASS()
class ZAGALASPECTOOLKIT_API UZagalaSpecPDWaitForTicks : public UZagalaSpecDefaultChainLink
{
    GENERATED_BODY()

protected:
    virtual void InternalExecute_Implementation(const TScriptInterface<IZagalaSpecTaggedDataCacher>& AssignedCacher) override;
    virtual void InternalTeardown_Implementation() override;

    void RemoveTickListener();

    bool IsWaitingForTicks() const;

    void FinishWithSuccess();

    void FinishWithFailure(const FString& Reason);

    virtual EZagalaSpecTickCheckResult OnTickCheck(
        IZagalaSpecTaggedDataCacher* Cacher,
        int32 TicksSoFar,
        FString& OutFailureReason);

    IZagalaSpecTaggedDataCacher* CachedCacher = nullptr;

    int32 CachedWaitTicks = 0;

    int32 CachedTickLimit = 0;

    int32 GetElapsedTicks();

private:
    void OnWorldPostActorTick(UWorld* World, ELevelTick TickType, float DeltaTime);
    void OnWorldCleanup(UWorld* World, bool bSessionEnded, bool bCleanupResources);

    TWeakObjectPtr<UWorld> CachedWorld;
    FDelegateHandle TickHandle;
    FDelegateHandle WorldCleanupHandle;
    int32 ElapsedTicks = 0;
};