SoundManager.h

Go to the documentation of this file.

// Copyright(c) Pixo Group. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "EventSystem/BaseManager.h"
#include "Sound/SoundCue.h"
#include "Engine/DataTable.h"
#include "SoundManager.generated.h"
 
USTRUCT(BlueprintType)
struct FStepVO : public FTableRowBase
{
    GENERATED_BODY()
    UPROPERTY(EditAnywhere, BlueprintReadOnly)
    FText StepName;
    UPROPERTY(EditAnywhere, BlueprintReadOnly)
    USoundCue* SoundCue;
};
 
USTRUCT(BlueprintType)
struct FSoundManagerParameter
{
    GENERATED_BODY()
    UPROPERTY(EditAnywhere, BlueprintReadOnly)
    TArray<FText> ParametersName;
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly)
    int32 StoryIndex;
    UPROPERTY(EditAnywhere, BlueprintReadOnly)
    UDataTable* DependentSoundTable;
};
 
USTRUCT(BlueprintType)
struct FBackgroundSound
{
    GENERATED_BODY()
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Background Sound")  
    USoundBase* Sound;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Background Sound")  
    TArray<FText> AppropriateStoryParams;
};
 
UCLASS()
class USoundManagerParametersData : public UDataAsset
{
    GENERATED_BODY()
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadOnly)
    TArray<FSoundManagerParameter> Data;
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnVOEndPlaying);
 
UCLASS(Blueprintable)
class PIXOCORE_API USoundManager : public UBaseManager
{
    GENERATED_BODY()
 
public:
    //Manager event declaration
    DECLARE_EVENT_HANDLER(UPlaySoundEvent);
    DECLARE_EVENT_HANDLER(UNewStepLoadedEvent);
    DECLARE_EVENT_HANDLER(UNewStoryLoadedEvent);
    DECLARE_EVENT_HANDLER(UHintActivatedEvent);
    DECLARE_EVENT_HANDLER(UInitializationEvent);
 
public:
    USoundManager();
 
    UFUNCTION(BlueprintCallable)
    USoundCue* GetSoundBasedOnStep(FText stepName, UDataTable* DataTable);
    UFUNCTION(BlueprintCallable, Category = "Play Sound")
    void PlaySound(USoundCue* soundToPlay);
    UFUNCTION(BlueprintCallable, meta = (AdvancedDisplay = 1), Category = "Play Sound")
    void PlayBackgroundSound(
        USoundBase* soundToPlay,
        float volumeMultiplier = 1.f,
        float pitchMultiplier = 1.f,
        float startTime = 0.f,
        USoundConcurrency* concurrencySettings = nullptr,
        AActor* owningActor = nullptr,
        bool bIsUISound = false);
    UFUNCTION(BlueprintCallable, Category = "Play Sound")
    void PlaySFXSound(USoundBase* soundToPlay);
    UFUNCTION(BlueprintCallable)
    void OnStepChange(FText stepName);
    UFUNCTION()
    void OnAudioEndPlaying();
 
    UPROPERTY(BlueprintReadWrite, Category = "Components")
    UAudioComponent* AudioComponent; 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    TArray<UDataTable*> StepVODataTablesArray; 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")
    TArray<UDataTable*> StepHintVODataTablesArray; 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, meta = (ClampMin = 0.f), Category = "SoundManager")
    float GeneralSoundVolumeMultiplier = 1.f; 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, meta = (ClampMin = 0.f), Category = "SoundManager")
    float SFXVolumeMultiplier = 1.f; 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "SoundManager")
    USoundManagerParametersData* SoundManagerParametersData;
    // Background Sound parameters
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "SoundManager")
    bool bPlayBackgroundSound = false; 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (EditCondition="bPlayBackgroundSound", EditConditionHides="bPlayBackgroundSound"), Category = "SoundManager")
    TArray<FBackgroundSound> BackgroundSounds {}; 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, meta = (ClampMin = 0.f, EditCondition="bPlayBackgroundSound", EditConditionHides="bPlayBackgroundSound"), Category = "SoundManager")
    float BackgroundVolumeMultiplier = 1.f; 
    UPROPERTY(BlueprintReadWrite, Category = "Components")
    UDataTable* CurrentStepVODataTable; 
    UPROPERTY(BlueprintReadWrite, Category = "Components")
    UDataTable* CurrentStepHintVODataTable; 
    UPROPERTY(BlueprintAssignable)
    FOnVOEndPlaying OnVoEndPlaying; 
 
protected:
    UPROPERTY()
    USoundCue* ActiveSound;
    FText CurrentStep;
};