NavMovementComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "NavMovementInterface.h"
#include "UObject/ObjectMacros.h"
#include "Engine/EngineTypes.h"
#include "GameFramework/Actor.h"
#include "AI/Navigation/NavigationTypes.h"
#include "AI/Navigation/NavAgentInterface.h"
#include "AI/Navigation/PathFollowingAgentInterface.h"
#include "GameFramework/MovementComponent.h"
#include "NavMovementComponent.generated.h"
 
class UCapsuleComponent;
 
UCLASS(abstract, config=Engine, MinimalAPI)
class UNavMovementComponent : public UMovementComponent, public INavMovementInterface
{
    GENERATED_UCLASS_BODY()
 
protected:
    UE_DEPRECATED(5.5, "FixedPathBrakingDistance is deprecated, please use NavMovementProperties.FixedPathBrakingDistance instead.")
    UPROPERTY(meta = (DeprecatedProperty, DeprecationMessage = "FixedPathBrakingDistance is deprecated, please use NavMovementProperties.FixedPathBrakingDistance instead."))
    float FixedPathBrakingDistance_DEPRECATED;
 
    UE_DEPRECATED(5.5, "bUpdateNavAgentWithOwnersCollision is deprecated, please use NavMovementProperties.bUpdateNavAgentWithOwnersCollision instead.")
    UPROPERTY(meta = (DeprecatedProperty, DeprecationMessage = "bUpdateNavAgentWithOwnersCollision is deprecated, please use NavMovementProperties.bUpdateNavAgentWithOwnersCollision instead."))
    uint8 bUpdateNavAgentWithOwnersCollision_DEPRECATED:1;
 
    UE_DEPRECATED(5.5, "bUseAccelerationForPaths is deprecated, please use NavMovementProperties.bUseAccelerationForPaths instead.")
    UPROPERTY(GlobalConfig, meta = (DeprecatedProperty, DeprecationMessage = "bUseAccelerationForPaths is deprecated, please use NavMovementProperties.bUseAccelerationForPaths instead."))
    uint8 bUseAccelerationForPaths_DEPRECATED : 1;
 
    UE_DEPRECATED(5.5, "bUseFixedBrakingDistanceForPaths is deprecated, please use NavMovementProperties.bUseFixedBrakingDistanceForPaths instead.")
    UPROPERTY(meta = (DeprecatedProperty, DeprecationMessage = "bUseFixedBrakingDistanceForPaths is deprecated, please use NavMovementProperties.bUseFixedBrakingDistanceForPaths instead."))
    uint8 bUseFixedBrakingDistanceForPaths_DEPRECATED : 1;
 
    UE_DEPRECATED(5.5, "bStopMovementAbortPaths is deprecated, please use NavMovementProperties.bStopMovementAbortPaths instead.")
    uint8 bStopMovementAbortPaths_DEPRECATED:1;
    
    UPROPERTY(EditAnywhere, Category = NavMovement)
    FNavMovementProperties NavMovementProperties;
 
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = NavMovement, meta = (DisplayName = "Movement Capabilities", Keywords = "Nav Agent"))
    FNavAgentProperties NavAgentProps;
 
    UPROPERTY()
    FMovementProperties MovementState;
 
private:
    UPROPERTY()
    TObjectPtr<UObject> PathFollowingComp;
 
public:
    virtual UObject* GetOwnerAsObject() const override { return GetOwner(); }
    
    virtual TObjectPtr<UObject> GetUpdatedObject() const override { return UpdatedComponent; }
 
    ENGINE_API virtual void GetSimpleCollisionCylinder(float& CollisionRadius, float& CollisionHalfHeight) const override;
 
    ENGINE_API virtual FVector GetSimpleCollisionCylinderExtent() const override;
    
    ENGINE_API virtual FVector GetForwardVector() const override;
    
    UFUNCTION(BlueprintCallable, Category="AI|Components|NavMovement")
    virtual FVector GetVelocityForNavMovement() const override { return Velocity; }
 
    virtual float GetMaxSpeedForNavMovement() const override { return GetMaxSpeed(); }
 
    // Overridden to also call StopActiveMovement().
    virtual void StopMovementImmediately() override;
 
    ENGINE_API void SetUpdateNavAgentWithOwnersCollisions(bool bUpdateWithOwner);
    inline bool ShouldUpdateNavAgentWithOwnersCollision() const { return NavMovementProperties.bUpdateNavAgentWithOwnersCollision != 0; }
 
    inline FVector GetActorLocation() const { return UpdatedComponent ? UpdatedComponent->GetComponentLocation() : FVector(FLT_MAX); }
    virtual FVector GetActorFeetLocation() const { return UpdatedComponent ? (UpdatedComponent->GetComponentLocation() - FVector(0,0,UpdatedComponent->Bounds.BoxExtent.Z)) : FNavigationSystem::InvalidLocation; }
    ENGINE_API virtual FBasedPosition GetActorFeetLocationBased() const;
    inline FVector GetActorNavLocation() const { INavAgentInterface* MyOwner = Cast<INavAgentInterface>(GetOwner()); return MyOwner ? MyOwner->GetNavAgentLocation() : FNavigationSystem::InvalidLocation; }
    inline FTransform GetActorTransform() const { return UpdatedComponent ? UpdatedComponent->GetComponentTransform() : FTransform(); }
 
    inline virtual FVector GetLocation() const override { return GetActorLocation(); }
    virtual FVector GetFeetLocation() const override { return GetActorFeetLocation(); }
    virtual FBasedPosition GetFeetLocationBased() const override { return GetActorFeetLocationBased(); };
 
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
 
#if WITH_EDITOR 
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    
    ENGINE_API virtual void UpdateNavAgent(const UObject& ObjectToUpdateFrom) override;
    
    ENGINE_API virtual void RequestDirectMove(const FVector& MoveVelocity, bool bForceMaxSpeed) override;
 
    ENGINE_API virtual void RequestPathMove(const FVector& MoveInput) override;
 
    ENGINE_API virtual bool CanStopPathFollowing() const override;
 
    virtual FNavMovementProperties* GetNavMovementProperties() override { return &NavMovementProperties; }
    virtual const FNavMovementProperties& GetNavMovementProperties() const override{ return NavMovementProperties; } 
 
    ENGINE_API void ClearFixedBrakingDistance();
 
    virtual void SetPathFollowingAgent(IPathFollowingAgentInterface* InPathFollowingAgent) override { PathFollowingComp = Cast<UObject>(InPathFollowingAgent); }
    virtual IPathFollowingAgentInterface* GetPathFollowingAgent() override { return Cast<IPathFollowingAgentInterface>(PathFollowingComp); }
    virtual const IPathFollowingAgentInterface* GetPathFollowingAgent() const override { return Cast<const IPathFollowingAgentInterface>(PathFollowingComp); }
 
    inline const FNavAgentProperties& GetNavAgentPropertiesRef() const  override { return NavAgentProps; }
    inline FNavAgentProperties& GetNavAgentPropertiesRef()  override { return NavAgentProps; }
 
    virtual void ResetMoveState() override { MovementState = NavAgentProps; }
 
    virtual bool CanStartPathFollowing() const override { return true; }
 
    inline bool IsJumpAllowed() const { return CanEverJump() && MovementState.bCanJump; }
 
    inline void SetJumpAllowed(bool bAllowed) { MovementState.bCanJump = bAllowed; }
 
    UFUNCTION(BlueprintCallable, Category="AI|Components|NavMovement")
    virtual bool IsCrouching() const override;
 
    UFUNCTION(BlueprintCallable, Category="AI|Components|NavMovement")
    virtual bool IsFalling() const override;
 
    UFUNCTION(BlueprintCallable, Category="AI|Components|NavMovement")
    virtual bool IsMovingOnGround() const override;
    
    UFUNCTION(BlueprintCallable, Category="AI|Components|NavMovement")
    virtual bool IsSwimming() const override;
 
    UFUNCTION(BlueprintCallable, Category="AI|Components|NavMovement")
    virtual bool IsFlying() const override;
};
 
 
inline bool UNavMovementComponent::IsCrouching() const
{
    return false;
}
 
inline bool UNavMovementComponent::IsFalling() const
{
    return false;
}
 
inline bool UNavMovementComponent::IsMovingOnGround() const
{
    return false;
}
 
inline bool UNavMovementComponent::IsSwimming() const
{
    return false;
}
 
inline bool UNavMovementComponent::IsFlying() const
{
    return false;
}
 
inline void UNavMovementComponent::StopMovementImmediately()
{
    Super::StopMovementImmediately();
    StopActiveMovement();
}