Program Listing for File ZagalaSpecScenario.h#

↰ Return to documentation for file (ZagalaSpec/Public/Scenario/ZagalaSpecScenario.h)

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

#pragma once

#include "CoreMinimal.h"
#include "UObject/NoExportTypes.h"
#include "Core/Interface/Testable/ZagalaSpecTestabilityIndicator.h"
#include "Core/Interface/Descriptor/ZagalaSpecDescriptor.h"
#include "Core/Interface/Scenario/ZagalaSpecScenarioInterface.h"
#include "Core/Interface/Editable/ZagalaSpecEditController.h"
#include "Core/Interface/PropertyNames/ZagalaSpecScenarioPropertyNames.h"
#include "GameplayTagContainer.h"
#include "ZagalaSpecScenario.generated.h"


DECLARE_LOG_CATEGORY_EXTERN(LogZagalaSpecScenario, Log, All);

UCLASS(Blueprintable, EditInlineNew, DefaultToInstanced, CollapseCategories, meta = (DisplayName = "ZagalaSpec Scenario"))
class ZAGALASPEC_API UZagalaSpecScenario : public UObject, public IZagalaSpecTestabilityIndicator, public IZagalaSpecDescriptor, public IZagalaSpecScenarioInterface, public IZagalaSpecEditController, public IZagalaSpecScenarioPropertyNames
{
    GENERATED_BODY()

public:
    UZagalaSpecScenario(const FObjectInitializer& ObjectInitializer = FObjectInitializer::Get());


    virtual const TArray<TObjectPtr<UObject>>& GetExpectationsReference() const override;
    virtual const TArray<TObjectPtr<UObject>>& GetContextExtensionsReference() const override;


    virtual FName GetIdentifierPropertyName() const override;
    virtual FName GetDescriptionPropertyName() const override;
    virtual FName GetIncludeInTestsPropertyName() const override;
    virtual FName GetContextExtensionsPropertyName() const override;
    virtual FName GetExpectationsPropertyName() const override;
    virtual FName GetFilterTagsPropertyName() const override;

#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    virtual EDataValidationResult IsDataValid(class FDataValidationContext& Context) const override;
#endif

protected:
    UPROPERTY(EditDefaultsOnly, meta = (Multiline = true, EditCondition = "bIsEditingAllowed", HideEditConditionToggle, DisplayAfter="Identifier"), Category = "Scenario")
    FString Description;

    UPROPERTY(EditDefaultsOnly, meta = (EditCondition = "bIsEditingAllowed", HideEditConditionToggle, DisplayAfter="Description"), Category = "Scenario")
    bool bIncludeInTests = true;

    UPROPERTY(NoClear, EditDefaultsOnly, Instanced, meta = (EditCondition = "bIsEditingAllowed", HideEditConditionToggle, DisplayAfter="bIncludeInTests"), Category = "Scenario")
    TArray<TObjectPtr<UObject>> ContextExtensions;

    UPROPERTY(NoClear, EditDefaultsOnly, Instanced, meta = (EditCondition = "bIsEditingAllowed", HideEditConditionToggle, DisplayAfter="ContextExtensions"), Category = "Scenario")
    TArray<TObjectPtr<UObject>> Expectations;

    UPROPERTY(EditDefaultsOnly, AdvancedDisplay, meta = (Categories = "ZagalaSpec.ScenarioFilter", EditCondition = "bIsEditingAllowed", HideEditConditionToggle), Category = "Scenario")
    FGameplayTagContainer FilterTags;

    bool IsIncludedInTests_Implementation() const override;

    virtual FGameplayTagContainer GetFilterTags_Implementation() const override;

    virtual FGameplayTag GetTag_Implementation() const override;
    virtual FString GetDescription_Implementation() const override;


    virtual bool DoesAllowEditing_Implementation() override;
    virtual void AllowEditing_Implementation() override;
    virtual void DisallowEditing_Implementation() override;

private:

    UPROPERTY(EditDefaultsOnly, meta = (EditCondition = "bIsEditingAllowed", HideEditConditionToggle), Category = "Scenario")
    FGameplayTag Identifier;

    UPROPERTY(Transient)
    bool bIsEditingAllowed = true;
};