StoryManager.h

Go to the documentation of this file.

// Copyright(c) Pixo Group. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Engine/DataAsset.h"
#include "EventSystem/BaseManager.h"
#include "StoryManager.generated.h"
 
class UStoryComponent;
 
DECLARE_LOG_CATEGORY_EXTERN(LogStoryManager, Log, All);
 
USTRUCT(BlueprintType)
struct PIXOCORE_API FStoryStep
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere)
    FText StepName;
    UPROPERTY(BlueprintReadWrite, EditAnywhere)
    bool Completed;
 
    bool operator==(const FStoryStep& Step) const;
};
 
USTRUCT(BlueprintType)
struct PIXOCORE_API FStepData
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere)
    FStoryStep Step;
    UPROPERTY(BlueprintReadWrite, EditAnywhere)
    TArray<FStoryStep> SubStep;
};
 
USTRUCT(BlueprintType)
struct PIXOCORE_API FPassedExperiences
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadWrite)
    TArray<FStepData> PassedStepData;
    UPROPERTY(BlueprintReadWrite)
    int32 StoryIndex;
};
 
UCLASS()
class PIXOCORE_API UStoryData : public UDataAsset
{
    GENERATED_BODY()
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    TArray<FStepData> StepData;
};
 
USTRUCT(BlueprintType)
struct FInteractiveObjectData
{
    GENERATED_BODY()
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    TSubclassOf<AActor> InteractiveObject;
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    TArray<FText> StorySteps;
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    TArray<FText> HighlightSteps;
};
 
UCLASS()
class UInteractiveObjectDataBase : public UDataAsset
{
    GENERATED_BODY()
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    TArray<FInteractiveObjectData> InteractiveObjectData;
};
 
class UStoryScriptClassData;
 
USTRUCT(BlueprintType)
struct PIXOCORE_API FDynamicStoryData
{
    GENERATED_BODY()
 
    UPROPERTY(BlueprintReadWrite)
    TArray<UStoryData*> DynamicStoryData;
 
    UPROPERTY(BlueprintReadWrite)
    TArray<UStoryScriptClassData*> StoryScripts;
 
    UPROPERTY(BlueprintReadWrite)
    TArray<UInteractiveObjectDataBase*> InteractiveObjectData;
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnNewStep, FStoryStep, newStep, bool, isForward);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnNewSubStep, FStoryStep, newSubStep);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnStepCompleted, FStoryStep, completedStep);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnRecordStepScore, FStoryStep, step, float, score);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnStepSkipped, FStoryStep, skippedStep, bool, isForward);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnStoryLoaded);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnEndOfStory);
 
UCLASS(Blueprintable)
class PIXOCORE_API UStoryManager : public UBaseManager
{
    GENERATED_BODY()
 
public:
    //Manager event declaration
    DECLARE_EVENT_HANDLER(UInitializationEvent);
 
public:
    UStoryManager();
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    TArray<UStoryData*> StoryDataArray;
    UPROPERTY(BlueprintReadWrite)
    TArray<FPassedExperiences> PassedExperiencesArray;
 
    UPROPERTY(BlueprintReadWrite, Replicated)
    TArray<FStepData> StepData;
 
    UPROPERTY(BlueprintReadWrite, Replicated)
    FStoryStep CurrentStep;
    UPROPERTY(BlueprintReadWrite, Replicated)
    FStoryStep CurrentSubStep;
    UPROPERTY(BlueprintReadWrite, Replicated)
    int StepIndex;
    UPROPERTY(BlueprintReadWrite, Replicated)
    int SubStepIndex;
    UPROPERTY(BlueprintReadWrite, Replicated)
    FStoryStep PreviousStep;
 
    UPROPERTY(BlueprintReadWrite, Replicated)
    int StoryIndex = -1; 
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool BlockStory;
 
    UPROPERTY(BlueprintReadOnly)
    bool StoryFinished = true;
 
    UPROPERTY(EditInstanceOnly, Category = "StoryManager|Properties")
    bool IsAutoSwitchingToNextStoryActive = false;
 
    UFUNCTION(BlueprintCallable)
    bool InitNewStory(int newStoryIndex);
 
    UFUNCTION(BlueprintCallable)
    bool GoToNextStep(); 
    UFUNCTION(BlueprintCallable)
    bool GoToNextSubStep(); 
    UFUNCTION(BlueprintCallable)
    void CompleteSubStep(FStoryStep completedStep); 
    UFUNCTION(BlueprintCallable)
    bool JumpToStepByIndex(int index); 
    UFUNCTION(BlueprintCallable)
    bool JumpToStepByName(FText stepId); 
 
    UFUNCTION(BlueprintCallable)
    void StepCompleted(FText stepToUpdate, bool goToNext = true);
 
    void AddStoryComponent(UStoryComponent* storyComponent);
 
    // Setup story static parameters
    UFUNCTION(BlueprintCallable)
    static void SetupNextStory(int newNextStoryIndex, TArray<FText> newStoryParameters);
 
    UFUNCTION(BlueprintCallable)
    static int GetNextStoryIndex() { return NextStoryIndex; }
 
    UFUNCTION(BlueprintCallable)
    static TArray<FText> GetStoryParameters() { return StoryParameters; }
 
    UFUNCTION(BlueprintCallable)
    static bool IsSpecificParametersExist(TArray<FText> SpecificParameters);
 
    //Misc
    UFUNCTION(BlueprintCallable, Category = "StoryManager|Misc")
    float GetCurrentStepDuration() const;
 
    // Delegates
 
    UPROPERTY(BlueprintAssignable, Category = "Story Delegate")
    FOnNewStep OnNewStep; 
    UPROPERTY(BlueprintAssignable, Category = "Story Delegate")
    FOnNewSubStep OnNewSubStep; 
    UPROPERTY(BlueprintAssignable, Category = "Story Delegate")
    FOnStepCompleted OnStepCompleted; 
    UPROPERTY(BlueprintAssignable, Category = "Story Delegate")
    FOnRecordStepScore OnRecordStepScore; 
    UPROPERTY(BlueprintAssignable, Category = "Story Delegate")
    FOnStoryLoaded OnStoryLoaded; 
    UPROPERTY(BlueprintAssignable, Category = "Story Delegate")
    FOnEndOfStory OnEndOfStory; 
    UPROPERTY(BlueprintAssignable, Category = "Story Delegate")
    FOnStepSkipped OnStepSkipped; 
 
protected:
    UFUNCTION()
    bool IsAllSubStepsCompleted();
    UFUNCTION()
    void RecordStoryStepData();
 
    UPROPERTY(BlueprintReadWrite, Replicated)
    UStoryData* StoryData; 
 
    static int NextStoryIndex; 
    static TArray<FText> StoryParameters;
 
    virtual void GetLifetimeReplicatedProps(TArray<FLifetimeProperty>& OutLifetimeProps) const override;
 
private:
    UPROPERTY()
    TArray<UStoryComponent*> StoryComponents;
 
    FDateTime StepStartingTime;
};