1. Epic GamesDeveloper
  3. APawn

APawn

Pawn is the base class of all actors that can be possessed by players or AI.

Unreal Engine C++ API Reference > Runtime > Engine > GameFramework

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/GameFramework/Pawn.h
Include #include "GameFramework/Pawn.h"

Syntax

UCLASS (Config=Game, BlueprintType, Blueprintable, HideCategories=(Navigation),  
       Meta=(ShortTooltip="A Pawn is an actor that can be 'possessed' and receive input from a controller."),  
       MinimalAPI)  
class APawn :  
    public AActor ,  
    public INavAgentInterface

Remarks

Pawn is the base class of all actors that can be possessed by players or AI. They are the physical representations of players and creatures in a level.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TSubclassOf< AController > AIControllerClass Default class to use when pawn is controlled by AI.
Public variable float AllowedYawError Max difference between pawn's Rotation.Yaw and GetDesiredRotation().Yaw for pawn to be considered as having reached its desired rotation
Public variable UProperty Category, EditAnywhere EAutoPossessAI AutoPossessAI Determines when the Pawn creates and is possessed by an AI Controller (on level start, when spawned, etc).
Public variable UProperty Category, EditAnywhere TEnumAsByte< EAutoReceiveInput::Type > AutoPossessPlayer Determines which PlayerController, if any, should automatically possess the pawn when the level starts or when the pawn is spawned.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float BaseEyeHeight Base eye height above collision center.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly uint32: 1 bCanAffectNavigationGeneration If set to false (default) given pawn instance will never affect navigation generation (but components could).
Protected variable UProperty Transient uint32: 1 bIsLocalViewTarget  
Public variable float BlendedReplayViewPitch Playback of replays writes blended pitch to this, rather than the RemoteViewPitch.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bUseControllerRotationPitch If true, this Pawn's pitch will be updated to match the Controller's ControlRotation pitch, if controlled by a PlayerController.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bUseControllerRotationRoll If true, this Pawn's roll will be updated to match the Controller's ControlRotation roll, if controlled by a PlayerController.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bUseControllerRotationYaw If true, this Pawn's yaw will be updated to match the Controller's ControlRotation yaw, if controlled by a PlayerController.
Protected variable UProperty Transient FVector ControlInputVector Accumulated control input vector, stored in world space.
Public variable UProperty replicatedusing TObjectPtr< AController > Controller Controller currently possessing this Actor
Protected variable UProperty Transient FVector LastControlInputVector The last control input vector that was processed by ConsumeMovementInputVector().
Public variable UProperty Category BlueprintReadOnly Transient TObjectPtr< AController > LastHitBy Controller of the last Actor that caused us damage.
Protected variable UProperty Category, EditDefaultsOnly TSubclassOf< UInputComponent > OverrideInputComponentClass If set, then this InputComponent class will be used instead of the Input Settings' DefaultInputComponentClass
Public variable UProperty Transient TObjectPtr< AController > PreviousController Previous controller that was controlling this pawn since the last controller change notification
Public variable UProperty Category BlueprintAssignable FPawnControllerChangedSignature ReceiveControllerChangedDelegate Event called after a pawn's controller has changed, on the server and owning client.
Public variable UProperty Category BlueprintAssignable FPawnRestartedSignature ReceiveRestartedDelegate Event called after a pawn has been restarted, usually by a possession change.
Public variable UProperty Replicated uint8 RemoteViewPitch Replicated so we can see where remote clients are looking.

Constructors

  Type Name Description
Public function  

APawn ( const FObjectInitializer& ObjectInitializer
)

 Default UObject constructor.

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category, Meta void

AddControllerPitchInput ( float Val
)

 Add input (affecting Pitch) to the Controller's ControlRotation, if it is a local PlayerController.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

AddControllerRollInput ( float Val
)

 Add input (affecting Roll) to the Controller's ControlRotation, if it is a local PlayerController.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

AddControllerYawInput ( float Val
)

 Add input (affecting Yaw) to the Controller's ControlRotation, if it is a local PlayerController.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

AddMovementInput ( FVector WorldDirection,
float ScaleValue,
bool bForce
)

 Add movement input along the given world direction vector (usually normalized) scaled by 'ScaleValue'.
Public function Virtual UFunction BlueprintCallable, Category, Meta FVector Returns the pending input vector and resets it to zero.
Protected function Virtual UInputComponent * Creates an InputComponent that can be used for custom input bindings.
Protected function Virtual void Destroys the player input component and removes any references to it.
Public function Virtual UFunction BlueprintCallable, Category, Meta void Call this function to detach safely pawn from its controller, knowing that we will be destroyed soon.
Public function void

DispatchRestart ( bool bCallClientRestart
)

 Wrapper function to call correct restart functions, enable bCallClientRestart if this is a locally owned player pawn or equivalent
Public function Virtual void

DisplayDebug ( UCanvas* Canvas,
const FDebugDisplayInfo& DebugDisplay,
float& YL,
float& YPos
)

  
Public function Virtual void

FaceRotation ( FRotator NewControlRotation,
float DeltaTime
)

 Updates Pawn's rotation to the given rotation, assumed to be the Controller's ControlRotation.
Public function Virtual Const UFunction BlueprintCallable, Category FRotator Return the aim rotation for the Pawn.
Public function Const UFunction BlueprintCallable, Category AController * Returns controller for this actor.
Public function Const T * Returns controller for this actor cast to the template type. May return NULL is the cast fails.
Public function Const UFunction BlueprintCallable, Category FRotator Get the rotation of the Controller, often the 'view' rotation of this Pawn.
Protected function Virtual Const AController *

GetDamageInstigator ( AController* InstigatedBy,
const UDamageType& DamageType
)

 Get the controller instigating the damage.
Public function Virtual Const float Returns The half-height of the default Pawn, scaled by the component scale.
Public function Virtual Const FVector Returns vector direction of gravity
Public function Virtual Const FQuat Returns a quaternion transforming from world space into gravity relative space
Public function Const UFunction BlueprintCallable, Category, Meta FVector Return the last input vector in world space that was processed by ConsumeMovementInputVector(), which is usually done by the Pawn or PawnMovementComponent.
Public function Const UFunction BlueprintCallable, Category APlayerController * Returns local Player Controller viewing this pawn, whether it is controlling or spectating
Public function Virtual Const UPrimitiveComponent * Return PrimitiveComponent we are based on (standing on, attached to, and moving on).
Public function Static UFunction BlueprintPure, Category AActor *

GetMovementBaseActor ( const APawn* Pawn
)

 Gets the owning actor of the Movement Base Component on which the pawn is standing.
Public function Virtual Const UFunction BlueprintCallable, Category, Meta UPawnMovementComponent * Return our PawnMovementComponent, if we have one.
Public function Const UFunction BlueprintCallable, Category TSubclassOf< UInputComponent >  
Public function Virtual Const UPawnNoiseEmitterComponent * Return our PawnNoiseEmitterComponent, if any.
Public function Virtual Const APhysicsVolume * Return Physics Volume for this Pawn
Public function Virtual Const FVector Returns Pawn's eye location
Public function Const UFunction BlueprintCallable, Category, Meta FVector Return the pending input vector in world space.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category FPlatformUserId Returns the Platform User ID of the PlayerController that is controlling this character.
Public function Const APlayerState * If Pawn is possessed by a player, returns its Player State.
Public function Const T * Templated convenience version of GetPlayerState.
Public function Const T * Templated convenience version of GetPlayerState which checks the type is as presumed.
Public function Virtual Const FRotator Get the view rotation of the Pawn (direction they are looking, normally Controller->ControlRotation).
Public function Virtual Const bool Returns true if player is viewing this Pawn in FreeCam
Public function Const bool Whether this Pawn's input handling is enabled.
Public function void

Internal_AddMovementInput ( FVector WorldAccel,
bool bForce
)

 Internal function meant for use only within Pawn or by a PawnMovementComponent.
Public function FVector Internal function meant for use only within Pawn or by a PawnMovementComponent.
Public function Const FVector Internal function meant for use only within Pawn or by a PawnMovementComponent.
Public function Const FVector Internal function meant for use only within Pawn or by a PawnMovementComponent.
Public function Virtual Const UFunction BlueprintPure, Category bool Returns true if controlled by a bot.
Public function Const UFunction BlueprintCallable, Category bool See if this actor is currently being controlled
Public function Virtual Const UFunction BlueprintPure, Category bool Returns true if controlled by a local (not network) Controller.
Public function Const UFunction BlueprintCallable, Category bool Is this pawn the ViewTarget of a local PlayerController? Helpful for determining whether the pawn is visible/critical for any VFX.
Public function Const bool  
Public function Virtual Const UFunction BlueprintCallable, Category bool Helper to see if move input is ignored.
Public function Virtual Const UFunction BlueprintCallable, Category bool Check if this actor is currently being controlled at all (the actor has a valid Controller, which will be false for remote clients)
Public function Virtual Const UFunction BlueprintPure, Category bool Returns true if controlled by a human player (possessed by a PlayerController).
Public function void

MoveIgnoreActorAdd ( AActor* ActorToIgnore
)

 Add an Actor to ignore by Pawn's movement collision
Public function void

MoveIgnoreActorRemove ( AActor* ActorToIgnore
)

 Remove an Actor to ignore by Pawn's movement collision
Public function Virtual void Call to notify about a change in controller, on both the server and owning client.
Public function Virtual void Notifies other systems that a pawn has been restarted.
Protected function Virtual void

OnPlayerStateChanged ( APlayerState* NewPlayerState,
APlayerState* OldPlayerState
)

 Called on both the clientand server when ever SetPlayerState is called on this pawn.
Public function Virtual UFunction void Called when Controller is replicated
Public function Virtual UFunction void PlayerState Replication Notification Callback
Public function Virtual void Called on the owning client of a player-controlled Pawn when it is restarted, this calls Restart()
Public function UFunction BlueprintCallable, BlueprintAuthorityOnly, Category void

PawnMakeNoise ( float Loudness,
FVector NoiseLocation,
bool bUseNoiseMakerLocation,
AActor* NoiseMaker
)

 Inform AIControllers that you've made a noise they might hear (they are sent a HearNoise message if they have bHearNoises==true) The instigator of this sound is the pawn which is used to call MakeNoise.
Public function Virtual void

PawnStartFire ( uint8 FireModeNum
)

 Handle StartFire() passed from PlayerController
Public function Virtual void

PossessedBy ( AController* NewController
)

 Called when this Pawn is possessed. Only called on the server (or in standalone).
Public function Virtual bool Return true if yaw is within AllowedYawError of desired yaw
Public function Virtual void Set BaseEyeHeight based on current state.
Public function UFunction BlueprintImplementableEvent void

ReceiveControllerChanged ( AController* OldController,
AController* NewController
)

 Event called after a pawn's controller has changed, on the server and owning client.
Public function UFunction BlueprintAuthorityOnly, Meta, BlueprintImplementableEvent void

ReceivePossessed ( AController* NewController
)

 Event called when the Pawn is possessed by a Controller.
Public function UFunction BlueprintImplementableEvent void Event called after a pawn has been restarted, usually by a possession change.
Public function UFunction BlueprintAuthorityOnly, Meta, BlueprintImplementableEvent void

ReceiveUnpossessed ( AController* OldController
)

 Event called when the Pawn is no longer possessed by a Controller.
Public function Virtual void

Restart ()

 Called when the Pawn is being restarted (usually by being possessed by a Controller).
Public function UFunction BlueprintCallable, Category, Meta void

SetCanAffectNavigationGeneration ( bool bNewValue,
bool bForceUpdate
)

 Use SetCanAffectNavigationGeneration to change this value at runtime.
Public function Virtual void Make sure pawn properties are back to default.
Public function void

SetPlayerState ( APlayerState* NewPlayerState
)

 Set the Pawn's Player State.
Public function void

SetRemoteViewPitch ( float NewRemoteViewPitch
)

 Set Pawn ViewPitch, so we can see where remote clients are looking. Maps 360.0 degrees into a byte
Protected function Virtual void

SetupPlayerInputComponent ( UInputComponent* PlayerInputComponent
)

 Allows a Pawn to set up custom input bindings.
Public function Virtual Const bool

ShouldTakeDamage ( float Damage,
FDamageEvent const& DamageEvent,
AController* EventInstigator,
AActor* DamageCauser
)

 Return true if we are in a state to take damage (checked at the start of TakeDamage. Subclasses may check this as well if they override TakeDamage and don't want to potentially trigger TakeDamage actions by checking if it returns zero in the super class.
Public function Virtual UFunction BlueprintCallable, Category void Spawn default controller for this Pawn, and get possessed by it.
Public function Virtual void

TurnOff ()

 Freeze pawn - stop sounds, animations, physics, weapon firing
Public function Virtual void Called when our Controller no longer possesses us. Only called on the server (or in standalone).
Public function void Updates MovementComponent's parameters used by navigation system
Public function Virtual void Update all components relevant for navigation generators to match bCanAffectNavigationGeneration flag

Overridden from AActor

  Type Name Description
Public function Virtual void Called when this actor becomes the given PlayerController's ViewTarget.
Public function Virtual void Overridable native event for when play begins for this actor.
Public function Virtual Const bool Overridden to defer to the RootComponent's CanCharacterStepUpOn setting if it is explicitly Yes or No.
Public function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
Public function Virtual void

DisableInput ( APlayerController* PlayerController
)

 Removes this actor from the stack of input being handled by a PlayerController.
Public function Virtual void

EditorApplyRotation ( const FRotator& DeltaRotation,
bool bAltDown,
bool bShiftDown,
bool bCtrlDown
)

 Called by ApplyDeltaToActor to perform an actor class-specific operation based on widget manipulation.
Public function Virtual void

EnableInput ( APlayerController* PlayerController
)

 Pushes this actor on to the stack of input being handled by a PlayerController.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Public function Virtual void Called when this actor is no longer the given PlayerController's ViewTarget.
Public function Virtual Const void

GetActorEyesViewPoint ( FVector& OutLocation,
FRotator& OutRotation
)

 Returns the point of view of the actor.
Public function Virtual Const FString Returns the human readable string representation of an object.
Public function Virtual Const UNetConnection * Get the owning connection used for communicating between client/server
Public function Virtual Const const AActor * Return the actor responsible for replication, if any. Typically the player controller
Public function Virtual UPlayer * Return the owning UPlayer (if any) of this actor.
Public function Virtual Const APhysicsVolume * Return Physics Volume for this Pawn
Public function Virtual Const FVector Returns velocity (in cm/s (Unreal Units/second) of the rootcomponent if it is either using physics or has an associated MovementComponent
Public function Virtual Const bool

IsBasedOnActor ( const AActor* Other
)

 Iterates up the movement base chain to see whether or not this Actor is based on the given Actor, defaults to checking attachment
Public function Virtual Const bool

IsNetRelevantFor ( const AActor* RealViewer,
const AActor* ViewTarget,
const FVector& SrcLocation
)

 Checks to see if this actor is relevant for a specific network connection
Public function Virtual void Called when the Actor is outside the hard limit on world bounds
Public function Virtual void Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay
Public function Virtual void Update location and rotation from ReplicatedMovement. Not called for simulated physics!
Public function Virtual void

PostNetReceiveVelocity ( const FVector& NewVelocity
)

 Update velocity - typically from ReplicatedMovement, not called for simulated physics!
Public function Virtual void Called after all the components in the Components array are registered, called both in editor and during gameplay.
Public function Virtual void Called right before components are initialized, only called during gameplay
Public function Virtual void

PreReplication ( IRepChangedPropertyTracker& ChangedPropertyTracker
)

 Called on the actor right before replication occurs.
Public function Virtual void

Reset ()

 Reset actor to initial state - used when restarting level without reloading.
Public function Virtual Const bool If true, actor is ticked even if TickType==LEVELTICK_ViewportsOnly
Public function Virtual float

TakeDamage ( float DamageAmount,
FDamageEvent const& DamageEvent,
AController* EventInstigator,
AActor* DamageCauser
)

 Apply damage to this actor.
Public function Virtual void

TeleportSucceeded ( bool bIsATest
)

 Called from TeleportTo() when teleport succeeds

Overridden from UObject

  Type Name Description
Public function Virtual Const void Returns the properties used for network replication, this needs to be overridden by all actor classes with native replicated properties
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Overridden from INavAgentInterface

  Type Name Description
Public function Virtual Const UFunction BlueprintCallable, Category void

GetMoveGoalReachTest ( const AActor* MovingActor,
const FVector& MoveOffset,
FVector& GoalOffset,
float& GoalRadius,
float& GoalHalfHeight
)

 Get cylinder for testing if actor has been reached
Public function Virtual Const UFunction BlueprintCallable, Category FVector Basically retrieved pawn's location on navmesh
Public function Virtual Const const FNavAgentProperties & Retrieves FNavAgentProperties expressing navigation props and caps of represented agent @NOTE the function will be renamed to GetNavAgentProperties in 4.8.

Constants

Name Description
OnPawnBeginPlay A delegate that broadcasts a notification whenever BeginPlay() is called

See Also

https://docs.unrealengine.com/latest/INT/Gameplay/Framework/Pawn/

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page