PawnMovementComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "GameFramework/NavMovementComponent.h"
#include "PawnMovementComponent.generated.h"
 
class APawn;
class UPrimitiveComponent;
 
UENUM()
enum class EPhysicsStateAction : uint8
{
    AddForce,
    AddTorque,
    AddForceAtPosition,
    AddLinearVelocity,
    AddAngularVelocity,
    AddVelocityAtPosition,
    AddLinearImpulse,
    AddAngularImpulse,
    AddImpulseAtPosition,
    AddAcceleration,
    NumActions
};
  
UCLASS(abstract, MinimalAPI)
class UPawnMovementComponent : public UNavMovementComponent
{
    GENERATED_BODY()
 
public:
 
    ENGINE_API virtual void SetUpdatedComponent(USceneComponent* NewUpdatedComponent) override;
 
    UFUNCTION(BlueprintCallable, Category="Pawn|Components|PawnMovement")
    ENGINE_API virtual void AddInputVector(FVector WorldVector, bool bForce = false);
 
    UFUNCTION(BlueprintCallable, Category="Pawn|Components|PawnMovement", meta=(Keywords="GetInput"))
    ENGINE_API FVector GetPendingInputVector() const;
 
    UFUNCTION(BlueprintCallable, Category="Pawn|Components|PawnMovement", meta=(Keywords="GetInput"))
    ENGINE_API FVector GetLastInputVector() const;
 
    /* Returns the pending input vector and resets it to zero.
     * This should be used during a movement update (by the Pawn or PawnMovementComponent) to prevent accumulation of control input between frames.
     * Copies the pending input vector to the saved input vector (GetLastMovementInputVector()).
     * @return The pending input vector.
     */
    UFUNCTION(BlueprintCallable, Category="Pawn|Components|PawnMovement")
    ENGINE_API virtual FVector ConsumeInputVector();
 
    UFUNCTION(BlueprintCallable, Category="Pawn|Components|PawnMovement")
    ENGINE_API virtual bool IsMoveInputIgnored() const;
 
    UFUNCTION(BlueprintCallable, Category="Pawn|Components|PawnMovement")
    ENGINE_API class APawn* GetPawnOwner() const;
 
    virtual void NotifyBumpedPawn(APawn* BumpedPawn) {}
 
    // UNavMovementComponent override for input operations
    ENGINE_API virtual void RequestPathMove(const FVector& MoveInput) override;
 
    ENGINE_API virtual void OnTeleported() override;
 
    ENGINE_API void ApplyAsyncPhysicsStateAction(const UPrimitiveComponent* ActionComponent, const FName& BoneName, 
        const EPhysicsStateAction ActionType, const FVector& ActionDatas, const FVector& ActionPosition = FVector::Zero());
 
protected:
 
    UPROPERTY(Transient, DuplicateTransient)
    TObjectPtr<class APawn> PawnOwner;
 
    ENGINE_API virtual AController* GetController() const;
 
    ENGINE_API void MarkForClientCameraUpdate();
 
public:
 
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
 
private:
 
    UFUNCTION(Server, Reliable)
    ENGINE_API void ServerAsyncPhysicsStateAction(const UPrimitiveComponent* ActionComponent, const FName BoneName, const FAsyncPhysicsTimestamp Timestamp,
            const EPhysicsStateAction ActionType, const FVector ActionDatas, const FVector ActionPosition = FVector::Zero());
 
    UFUNCTION(NetMulticast, Reliable)
    ENGINE_API void MulticastAsyncPhysicsStateAction(const UPrimitiveComponent* ActionComponent, const FName BoneName, const FAsyncPhysicsTimestamp Timestamp,
            const EPhysicsStateAction ActionType, const FVector ActionDatas, const FVector ActionPosition = FVector::Zero());
 
    ENGINE_API void ExecuteAsyncPhysicsStateAction(const UPrimitiveComponent* ActionComponent, const FName& BoneName, const FAsyncPhysicsTimestamp& Timestamp,
        const EPhysicsStateAction ActionType, const FVector& ActionDatas, const FVector& ActionPosition = FVector::Zero());
};