NavMovementInterface.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/ObjectMacros.h"
#include "UObject/Interface.h"
#include "Engine/EngineTypes.h"
#include "AI/Navigation/NavigationTypes.h"
 
#include "NavMovementInterface.generated.h"
 
#define UE_API ENGINE_API
 
class IPathFollowingAgentInterface;
 
UINTERFACE(MinimalAPI, NotBlueprintable)
class UNavMovementInterface : public UInterface
{
    GENERATED_BODY()
};
 
class INavMovementInterface
{
    GENERATED_BODY()
 
public:
    // Begin: Functions to be implemented by objects inheriting this interface
    virtual bool CanStartPathFollowing() const = 0;
 
    virtual bool CanStopPathFollowing() const = 0;
 
    virtual FNavMovementProperties* GetNavMovementProperties() = 0;
    virtual const FNavMovementProperties& GetNavMovementProperties() const = 0;
 
    virtual FNavAgentProperties& GetNavAgentPropertiesRef() = 0;
    virtual const FNavAgentProperties& GetNavAgentPropertiesRef() const = 0;
    
    virtual void SetPathFollowingAgent(IPathFollowingAgentInterface* InPathFollowingAgent) = 0;
    virtual IPathFollowingAgentInterface* GetPathFollowingAgent() = 0;
    virtual const IPathFollowingAgentInterface* GetPathFollowingAgent() const = 0;
    
    UFUNCTION(BlueprintCallable, Category="AI|NavMovement")
    virtual void RequestDirectMove(const FVector& MoveVelocity, bool bForceMaxSpeed) = 0;
 
    UFUNCTION(BlueprintCallable, Category="AI|NavMovement")
    virtual void RequestPathMove(const FVector& MoveInput) = 0;
 
    virtual void StopMovementImmediately() = 0;
 
    virtual void ResetMoveState() = 0;
    
    // Movement specific code but not specific to nav movement - could probably be pulled out into a separate interface if desired
    virtual FVector GetLocation() const = 0;
    
    virtual FVector GetFeetLocation() const = 0;
 
    virtual FBasedPosition GetFeetLocationBased() const = 0;
 
    virtual UObject* GetOwnerAsObject() const = 0;
    
    virtual TObjectPtr<UObject> GetUpdatedObject() const = 0;
 
    virtual void GetSimpleCollisionCylinder(float& CollisionRadius, float& CollisionHalfHeight) const = 0;
 
    virtual FVector GetSimpleCollisionCylinderExtent() const = 0;
    
    virtual FVector GetForwardVector() const = 0;
    
    virtual void UpdateNavAgent(const UObject& ObjectToUpdateFrom) = 0;
    
    UFUNCTION(BlueprintCallable, Category="AI|NavMovement")
    virtual FVector GetVelocityForNavMovement() const = 0;
 
    UFUNCTION(BlueprintCallable, Category="AI|NavMovement")
    virtual float GetMaxSpeedForNavMovement() const = 0;
 
    UFUNCTION(BlueprintCallable, Category="Movement")
    virtual bool IsCrouching() const = 0;
 
    UFUNCTION(BlueprintCallable, Category="Movement")
    virtual bool IsFalling() const = 0;
 
    UFUNCTION(BlueprintCallable, Category="Movement")
    virtual bool IsMovingOnGround() const = 0;
    
    UFUNCTION(BlueprintCallable, Category="Movement")
    virtual bool IsSwimming() const = 0;
 
    UFUNCTION(BlueprintCallable, Category="Movement")
    virtual bool IsFlying() const = 0;
    // End: Functions to be implemented by objects inheriting this interface
    
    
    // Begin: Functions to be implemented here for shared functionality
    UFUNCTION(BlueprintCallable, Category="AI|Movement")
    UE_API virtual void StopActiveMovement();
 
    UFUNCTION(BlueprintCallable, Category="AI|Movement")
    UE_API virtual void StopMovementKeepPathing();
    
    UE_API FVector GetNavLocation() const;
 
    UE_API virtual float GetPathFollowingBrakingDistance(float MaxSpeed) const;
 
    UE_API void SetFixedBrakingDistance(float DistanceToEndOfPath);
 
    UE_API bool UseAccelerationForPathFollowing() const;
 
    inline virtual bool CanEverCrouch() const { return GetNavAgentPropertiesRef().bCanCrouch; }
 
    inline virtual bool CanEverJump() const { return GetNavAgentPropertiesRef().bCanJump; }
 
    inline virtual bool CanEverMoveOnGround() const { return GetNavAgentPropertiesRef().bCanWalk; }
 
    inline virtual bool CanEverSwim() const { return GetNavAgentPropertiesRef().bCanSwim; }
 
    inline virtual bool CanEverFly() const { return GetNavAgentPropertiesRef().bCanFly; }
    // End: Functions to be implemented here for shared functionality
};
 
#undef UE_API