AmbianceComponent.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/ActorComponent.h"
#include "AmbianceComponent.generated.h"
 
class APawn;
class USoundBase;
 
UCLASS(ClassGroup = (Custom), meta = (BlueprintSpawnableComponent))
class PROJECTX_API UAmbianceComponent : public UActorComponent
{
    GENERATED_BODY()
 
public:
    /* Distance form the player in which to play the one shot sounds. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sounds")
    FVector2D RandomSoundPlayDistance = FVector2D(1000.0f, 10000.0f);
    /* Delay between oneshots. This is per Oneshot layer. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sounds")
    FVector2D RandomSoundPlayDelay = FVector2D(1.0f, 3.0f);
    /* Looping sound to glue the ambiance together. Typically wind. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sounds")
    USoundBase* AmbianceLooping;
    /* These sounds will play sporadically around the player. More of them will give you a layering effect. These sounds play randomly around the player in a circle. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sounds")
    TArray<USoundBase*> AmbianceOneShots;
    /* If transitioning between two volumes that use the same looping sound. The system will do nothing. This makes transitions sound seamless*/
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sounds", meta = (EditCondition="!bOverrideDefaultAmbiance"))
    bool bIgnoreIfSameLoopingSound = false;
    /* Overrides the default ambiance if the player enters this volume and will persist until another override volume has been entered.
    *  Leaving any other ambiance volumes will return the ambiance to this one. Used to create regional ambiance that still has caves/buildings/other changes within it. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Sounds", meta = (EditCondition = "!bIgnoreIfSameLoopingSound"))
    bool bOverrideDefaultAmbiance = false;
 
    UPROPERTY()
    class UAudioComponent* AmbianceLoopingComponent;
 
    bool bIsPlaying;
 
    UAmbianceComponent();
 
    virtual void BeginPlay() override;
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
 
    UAmbianceComponent* GetDefaultAmbiance(const APawn* Pawn);
    bool StopAllOtherAmbiance();
    bool StopAmbiance(UAmbianceComponent* Ambiance = nullptr);
    void PlayAmbiance(APawn* Listener, bool bStopOtherAmbiance = false);
    void PlayRandomSound(USoundBase* SoundToPlay);
    void OverrideDefaultAmbiance(APawn* Pawn);
 
    UFUNCTION()
    void OnAmbianceRegionEnter(AActor* OverlappedActor, AActor* OtherActor);
    UFUNCTION()
    void OnAmbianceRegionExit(AActor* OverlappedActor, AActor* OtherActor);
 
    FVector GetRandomSoundLocation() const;
    FORCEINLINE float GetRandomSoundDelay() const { return FMath::FRandRange(RandomSoundPlayDelay.X, RandomSoundPlayDelay.Y); }
 
private:
    static uint8 VolumeSemaphore;
    static TWeakObjectPtr<UAmbianceComponent> DefaultAmbiance;
 
    UPROPERTY()
    APawn* AmbianceCenter;
};