CharacterVolume.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "CharacterVolume.generated.h"
 
class AProjectXCharacter;
 
UENUM(BlueprintType, meta = (Bitflags))
enum class EVolumeEffectsTriggerType : uint8 
{
    NONE = 0,
    Enter = (1<<0),
    Exit = (1<<1),
    Constant = (1<<2),
};
 
ENUM_CLASS_FLAGS(EVolumeEffectsTriggerType)
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FCharacterEventSignature,AProjectXCharacter*, Character);
 
UCLASS()
class PROJECTX_API ACharacterVolume : public AActor
{
    GENERATED_BODY()
    
public: 
    ACharacterVolume();
 
    UPROPERTY(BlueprintAssignable)
    FCharacterEventSignature CharacterEnteredVolumeEvent;
    UPROPERTY(BlueprintAssignable)
    FCharacterEventSignature CharacterLeftVolumeEvent;
 
    UFUNCTION(BlueprintCallable,BlueprintAuthorityOnly)
    void ToggleActive(bool bNewActiveState);
 
    UFUNCTION(BlueprintCallable,BlueprintPure)
    FORCEINLINE bool IsActive() const { return bActiveVolume; }
 
protected:
    UFUNCTION(BlueprintImplementableEvent)
    void OnCharacterEnteredVolume(AProjectXCharacter* Character);
    UFUNCTION(BlueprintImplementableEvent)
    void OnCharacterLeftVolume(AProjectXCharacter* Character);
    UFUNCTION(BlueprintImplementableEvent)
    void OnCharacterInVolume(AProjectXCharacter* Character);
    UFUNCTION(BlueprintImplementableEvent)
    void OnToggleActivation(bool bActive);
 
    virtual void CharacterEnteredVolume(AProjectXCharacter* Character);
    virtual void CharacterLeftVolume(AProjectXCharacter* Character);
 
    virtual void BeginPlay() override;
    virtual void Tick(float DeltaTime) override;
 
    UFUNCTION()
    void OnRep_Active();
    UFUNCTION()
    void OnCharacterOverlapStart(AActor* OverlappedActor, AActor* OtherActor);
    UFUNCTION()
    void OnCharacterOverlapEnd(AActor* OverlappedActor, AActor* OtherActor);
 
protected:
    /* Is the volume Active*/
    UPROPERTY(EditAnywhere, ReplicatedUsing = OnRep_Active)
    bool bActiveVolume = true;
 
    /*What triggers effects*/
    UPROPERTY(EditDefaultsOnly, Category = Volume, meta = (Bitmask, BitmaskEnum = EVolumeEffectsTriggerType))
    uint8 TriggerConditions = 0;
 
    TSet<TWeakObjectPtr<AProjectXCharacter>> Characters;
 
};