Spectator.h

Go to the documentation of this file.

// Copyright (c) 2023 FrostBit Software Lab at the Lapland University of Applied Sciences
//
// This work is licensed under the terms of the MIT license.
// For a copy, see <https://opensource.org/licenses/MIT>.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/DefaultPawn.h"
#include "NiagaraComponent.h"
#include "Agrarsense/Spectator/LevelTeleportLocation.h"
 
#include "Spectator.generated.h"
 
class AOverlapSensor;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FFollowTargetChanged, bool, IsFollowing, AActor*, TargetActor);
 
class UFloatingPawnMovement;
 
UCLASS()
class AGRARSENSE_API ASpectator : public ADefaultPawn
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintCallable)
    void TeleportSpectator(const FTransform& Transform);
 
    UFUNCTION(BlueprintCallable)
    void TeleportToActorLocation(const AActor* Actor);
 
    UFUNCTION(BlueprintCallable)
    void FollowActor(AActor* Actor, bool DisableInputs = true, const float DistanceToActor = 150.0f, const float HeightOffset = 10.0f);
 
 
    UFUNCTION(BlueprintCallable)
    void TeleportToFollowLocation(FVector TargetLocation, const float DistanceToLocation, const float HeightOffset);
 
    UFUNCTION(BlueprintCallable)
    void TeleportToActorFollowLocation(AActor* Actor, const float DistanceToActor = 1500.0f, const float HeightOffset = 500.0f);
 
    UFUNCTION(BlueprintCallable)
    void StopFollowingAnyActor(bool EnableInputs = true);
 
    UFUNCTION(BlueprintCallable)
    void SetNiagaraComponentVisibility(bool Visible);
 
    UFUNCTION(BlueprintCallable)
    void SetMaxSpeed(float MaxSpeed = 1500.0f);
 
    UFUNCTION(BlueprintCallable)
    float GetMaxSpeed();
 
    UFUNCTION(BlueprintCallable)
    AActor* GetTargetActor()
    {
        return Target.Get();
    }
 
    UFUNCTION(BlueprintCallable)
    bool IsNiagaraComponentVisible()
    {
        if (NiagaraComponent)
        {
            return NiagaraComponent->IsVisible();
        }
 
        return false;
    }
 
    UFUNCTION(BlueprintCallable)
    bool IsSpectatorFollowingAnyActor()
    {
        return GetTargetActor() != nullptr;
    }
 
    UFUNCTION(BlueprintCallable)
    AOverlapSensor* GetOverlapSensor() const
    {
        return OverlapSensor;
    }
 
    UFUNCTION(BlueprintCallable)
    UFloatingPawnMovement* GetFloatingPawnMovement();
 
    UFUNCTION(BlueprintCallable)
    void TeleportToLevelTeleportLocation(FLevelTeleportLocation TeleportLocation);
 
    UPROPERTY(BlueprintAssignable)
    FFollowTargetChanged OnFollowTargetChanged;
 
protected:
 
    virtual void BeginPlay() override;
 
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
    UNiagaraComponent* NiagaraComponent = nullptr;
 
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly)
    AOverlapSensor* OverlapSensor = nullptr;
 
private:
 
    TWeakObjectPtr<AActor> Target;
 
};