DeployableMarker.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 "DeployableMarker.generated.h"
 
UENUM(BlueprintType, meta = (Bitflags))
enum class EPlacementFailureReason : uint8
{
    NONE = 0,
    Grounded = (1 << 0), //Failed because initial groundedness check did not succeed.
    Slope = (1 << 1), //Failed because the slope was too steep.
    ZDiff = (1 << 2), //Failed because the delta Z was too high between points.
    Sky = (1 << 3), //Failed because something occluded the sky.
};
ENUM_CLASS_FLAGS(EPlacementFailureReason)
 
UENUM(BlueprintType, meta = (Bitflags, UseEnumValuesAsMaskValuesInEditor = "true"))
enum class EPlacementTests : uint8
{
    NONE = 0,
    GroundCheck = (1 << 0),
    SlopeCheck = (1 << 1), 
    SkyCheck = (1 << 2),
};
ENUM_CLASS_FLAGS(EPlacementTests)
 
/*
* Marker used for local client to preview their placement of a deployable.
*/
UCLASS(Blueprintable)
class PROJECTX_API ADeployableMarker : public AActor
{
    GENERATED_UCLASS_BODY()
    
public:
    UFUNCTION(BlueprintCallable, Category = Marker)
    FORCEINLINE float GetDeployRadius() const { return DeployRadius; }
    UFUNCTION(BlueprintCallable, Category = Marker)
    FORCEINLINE float GetMaxVerticalDelta() const { return MaxDeployVerticalDelta; }
 
    UFUNCTION(BlueprintCallable, Category = Marker)
    FORCEINLINE bool IsValidPlacement() const { return PlacementFlags == 0; }
    UFUNCTION(BlueprintCallable, Category = Marker)
    FORCEINLINE bool IsNotGrounded() const { return (PlacementFlags & uint8(EPlacementFailureReason::Grounded)) != 0; }
    UFUNCTION(BlueprintCallable, Category = Marker)
    FORCEINLINE bool IsTooHighSlope() const { return (PlacementFlags & uint8(EPlacementFailureReason::Slope)) != 0; }
    UFUNCTION(BlueprintCallable, Category = Marker)
    FORCEINLINE bool IsTooMuchZDifference() const { return (PlacementFlags & uint8(EPlacementFailureReason::ZDiff)) != 0; }
    UFUNCTION(BlueprintCallable, Category = Marker)
    FORCEINLINE bool IsSkyObstructed() const { return (PlacementFlags & uint8(EPlacementFailureReason::Sky)) != 0; }
    UFUNCTION(BlueprintCallable, Category = Marker)
    FORCEINLINE bool ShouldTestBeRun(EPlacementTests DataType) const { return ((PlacementTestsToRun & uint8(DataType)) != 0); }
 
//~ Begin AActor Interface.
protected:
    virtual void BeginPlay() override;
 
public:
    virtual void Tick(float DeltaTime) override;
 
//~ End AActor Interface.
public:
    /* We'll call this on the client via tick but also from the server via CDO. */
    bool IsValidPlacement(FTransform& Transform, UWorld* World) const;
    uint8 TestPlacement(FTransform& Transform, UWorld* World, bool bFullTest = true) const;
    //Called when this marker has become a valid one.
    UFUNCTION(BlueprintImplementableEvent, Category = Marker)
    void OnMarkerSuccess();
 
    //Called when this marker has become an invalid one.
    UFUNCTION(BlueprintImplementableEvent, Category = Marker)
    void OnMarkerFailed(EPlacementFailureReason Reason);
 
protected:
    virtual void UpdatePlacementFlags(bool bForceUpdate = false);
    
    virtual bool GetGroundedTransform(FTransform& Transform, UWorld* World) const;
    virtual bool PerformTraceTest(const FTransform& Transform, FTransform& CapsuleBaseTransform, UWorld* World) const;
    virtual bool PerformCapsuleTest(const FTransform& BaseTransform, UWorld* World) const;
 
protected:
    /* Used to check placement rule results for clients. A convenient way to store them all together in one variable. */
    UPROPERTY()
    uint8 PlacementFlags = MAX_uint8;
 
    /* Radius around deploy point to check placement validity */
    UPROPERTY(EditDefaultsOnly, Category = Marker)
    float DeployRadius = 80.f;
    /* Number of points to test when performing placement validity checks */
    UPROPERTY(EditDefaultsOnly, Category = Marker)
    int32 RadialTestPoints = 8;
    /* Maximum slope (in degrees) this object can be deployed on */
    UPROPERTY(EditDefaultsOnly, Category = Marker)
    float MaxDeploySlope = 30.f;
    /* Maximum vertical distance that this deployable will allow between tested points */
    UPROPERTY(EditDefaultsOnly, Category = Marker)
    float MaxDeployVerticalDelta = 30.f;
    /* Show Debug Information*/
    UPROPERTY(EditDefaultsOnly, Category = Marker)
    bool bDebug = false;
    /*What tests should this run*/
    UPROPERTY(EditDefaultsOnly, Category = Marker,meta = (Bitmask, BitmaskEnum = EPlacementTests))
    uint8 PlacementTestsToRun;
};