Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AIModule > Actions > UPawnAction

Light Theme

Dark Theme

UPawnAction

Things to remember: * Actions are created paused

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UPawnAction

UPawnAction_BlueprintBase

UPawnAction_Move

UPawnAction_Repeat

UPawnAction_Sequence

UPawnAction_Wait

UTestPawnAction_Log

UTestPawnAction_CallFunction

References

Module	AIModule
Header	/Engine/Source/Runtime/AIModule/Classes/Actions/PawnAction.h
Include	#include "Actions/PawnAction.h"

Syntax

class UPawnAction : public UObject

Remarks

Things to remember:

Actions are created paused

Variables

	Name	Description
uint32: 1	bAllowNewSameClassInstance	If this is FALSE and we're trying to push a new instance of a given class, but the top of the stack is already an instance of that class ignore the attempted push
uint32: 1	bAlwaysNotifyOnFinished	If set, action will call OnFinished notify even when ending as FailedToStart
UBrainComponent...	BrainComp	: THIS IS HERE ONLY BECAUSE OF THE WAY AI MESSAGING IS CURRENTLY IMPLEMENTED. WILL GO AWAY!
uint32: 1	bReplaceActiveSameClassInstance	If this is TRUE, when we try to push a new instance of an action who has the same class as the action on the top of the stack, pop the one on the stack, and push the new one NOTE: This trumps bAllowNewClassInstance (e.g. if this is true and bAllowNewClassInstance is false the active instance will still be replaced)
uint32: 1	bShouldPauseMovement	This is a temporary solution to allow having movement action running in background while there's another action on top doing its thing
uint32: 1	bWantsTick	TickAction will get called only if this flag is set.
friend	FPawnActionStack
FAIRequestID	RequestID
FAIResourcesSet	RequiredResources	Specifies which resources will be locked by this action.
friend	UPawnActionsComponent

Constructors

	Name	Description
	UPawnAction ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
EPawnActionA...	Abort ( EAIForceParam::Type ShouldForce )	Triggers aborting of an Action
bool	Activate()	Starts or resumes action, depending on internal state
UPawnAction ...	CreateActionInstance ( UObject* WorldContextObject, TSubclassOf< UPawnAction > ActionCl... )
TActionClass...	CreateActionInstance ( UWorld& World )
void	Finish ( TEnumAsByte< EPawnActionResult::Typ... )
EPawnActionA...	GetAbortState()
TEnumAsByte<...	GetActionPriority()	Blueprint inlines.
UPawnAction ...	GetChildAction()
const UPawnA...	GetChildAction()
AController ...	GetController()
FString	GetDisplayName()
UObject *...	GetInstigator()
UPawnActions...	GetOwnerComponent()
UPawnActions...	GetOwnerComponent()
const UPawnA...	GetParentAction()
APawn *	GetPawn()
EAIRequestPr...	GetPriority()
FString	GetPriorityName()
EPawnActionR...	GetResult()
FString	GetStateDescription()	Debug
UWorld *	GetWorld()	Begin UObject.
void	HandleAIMessage ( UBrainComponent*, const FAIMessage& )	This function will change its signature once AI messaging is rewritten
bool	HasActionObserver()
bool	HasBeenStarted()
bool	IsActive()
bool	IsBeingAborted()
bool	IsFinished()
bool	IsPaused()
void	OnChildFinished ( UPawnAction& Action, EPawnActionResult::Type WithResult )	Called to give Action chance to react to child action finishing.
void	OnFinished ( EPawnActionResult::Type WithResult )	Called when this action is being removed from action stacks
void	OnPopped()
bool	Pause ( const UPawnAction* PausedBy )	Called to pause action when higher priority or child action kicks in
EPawnActionA...	PerformAbort ( EAIForceParam::Type ShouldForce )	Performs actual work on aborting Action. Should be called exclusively by Abort function
bool	PushChildAction ( UPawnAction& Action )	Apart from doing regular push request copies additional values from Parent, like Priority and Instigator
bool	Resume()	Called to resume action after being paused
void	SendEvent ( EPawnActionEventType::Type Event )
void	SetActionObserver ( const FPawnActionEventDelegate& In... )
void	SetInstigator ( UObject*const InInstigator )
void	SetOwnerComponent ( UPawnActionsComponent* Compone... )
bool	ShouldPauseMovement()
bool	Start()	Called to start off the Action
void	StopWaitingForMessages()
void	Tick ( float DeltaTime )
void	TickAction ( float DeltaTime )
void	WaitForMessage ( FName MessageType, FAIRequestID RequestID )	Messaging
bool	WantsTick()

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss