UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UGameplayTask Class Reference

#include <GameplayTask.h>

+ Inheritance diagram for UGameplayTask:

Public Member Functions

 DECLARE_DYNAMIC_MULTICAST_DELEGATE (FGenericGameplayTaskDelegate)
 
GAMEPLAYTASKS_API UGameplayTask (const FObjectInitializer &ObjectInitializer)
 
GAMEPLAYTASKS_API void ReadyForActivation ()
 
virtual GAMEPLAYTASKS_API void InitSimulatedTask (UGameplayTasksComponent &InGameplayTasksComponent)
 
virtual void TickTask (float DeltaTime)
 
virtual GAMEPLAYTASKS_API void ExternalConfirm (bool bEndTask)
 
virtual GAMEPLAYTASKS_API void ExternalCancel ()
 
void MarkOwnerFinished ()
 
virtual GAMEPLAYTASKS_API FString GetDebugString () const
 
virtual GAMEPLAYTASKS_API UWorldGetWorld () const override
 
GAMEPLAYTASKS_API AActorGetOwnerActor () const
 
GAMEPLAYTASKS_API AActorGetAvatarActor () const
 
GAMEPLAYTASKS_API void TaskOwnerEnded ()
 
GAMEPLAYTASKS_API void EndTask ()
 
virtual bool IsSupportedForNetworking () const override
 
FName GetInstanceName () const
 
bool IsTickingTask () const
 
bool IsSimulatedTask () const
 
bool IsSimulating () const
 
bool IsPausable () const
 
bool HasOwnerFinished () const
 
uint8 GetPriority () const
 
bool RequiresPriorityOrResourceManagement () const
 
FGameplayResourceSet GetRequiredResources () const
 
FGameplayResourceSet GetClaimedResources () const
 
EGameplayTaskState GetState () const
 
bool IsActive () const
 
bool IsPaused () const
 
bool IsFinished () const
 
UGameplayTaskGetChildTask () const
 
IGameplayTaskOwnerInterfaceGetTaskOwner () const
 
UGameplayTasksComponent * GetGameplayTasksComponent ()
 
UGameplayTasksComponent * GetGameplayTasksComponent () const
 
bool IsOwnedByTasksComponent () const
 
template<class T >
void AddRequiredResource ()
 
template<class T >
void AddClaimedResource ()
 
GAMEPLAYTASKS_API void AddRequiredResource (TSubclassOf< UGameplayTaskResource > RequiredResource)
 
GAMEPLAYTASKS_API void AddRequiredResourceSet (const TArray< TSubclassOf< UGameplayTaskResource > > &RequiredResourceSet)
 
GAMEPLAYTASKS_API void AddRequiredResourceSet (FGameplayResourceSet RequiredResourceSet)
 
GAMEPLAYTASKS_API void AddClaimedResource (TSubclassOf< UGameplayTaskResource > ClaimedResource)
 
GAMEPLAYTASKS_API void AddClaimedResourceSet (const TArray< TSubclassOf< UGameplayTaskResource > > &AdditionalResourcesToClaim)
 
GAMEPLAYTASKS_API void AddClaimedResourceSet (FGameplayResourceSet AdditionalResourcesToClaim)
 
ETaskResourceOverlapPolicy GetResourceOverlapPolicy () const
 
virtual bool IsWaitingOnRemotePlayerdata () const
 
virtual bool IsWaitingOnAvatar () const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 
- Public Member Functions inherited from IGameplayTaskOwnerInterface
virtual void OnGameplayTaskActivated (UGameplayTask &Task)
 

Static Public Member Functions

template<class T >
static T * NewTask (UObject *WorldContextObject, FName InstanceName=FName())
 
template<class T >
static T * NewTask (TScriptInterface< IGameplayTaskOwnerInterface > TaskOwner, FName InstanceName=FName())
 
template<class T >
static T * NewTask (UObject &WorldContextObject, FName InstanceName=FName())
 
template<class T >
static T * NewTask (IGameplayTaskOwnerInterface &TaskOwner, FName InstanceName=FName())
 
template<class T >
static T * NewTaskUninitialized ()
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Protected Member Functions

virtual GAMEPLAYTASKS_API void Activate ()
 
GAMEPLAYTASKS_API void InitTask (IGameplayTaskOwnerInterface &InTaskOwner, uint8 InPriority)
 
virtual GAMEPLAYTASKS_API void OnDestroy (bool bInOwnerFinished)
 
virtual GAMEPLAYTASKS_API void Pause ()
 
virtual GAMEPLAYTASKS_API void Resume ()
 
virtual GAMEPLAYTASKS_API UGameplayTasksComponent * GetGameplayTasksComponent (const UGameplayTask &Task) const override
 
virtual GAMEPLAYTASKS_API AActorGetGameplayTaskOwner (const UGameplayTask *Task) const override
 
virtual GAMEPLAYTASKS_API AActorGetGameplayTaskAvatar (const UGameplayTask *Task) const override
 
virtual GAMEPLAYTASKS_API uint8 GetGameplayTaskDefaultPriority () const override
 
virtual GAMEPLAYTASKS_API void OnGameplayTaskInitialized (UGameplayTask &Task) override
 
virtual GAMEPLAYTASKS_API void OnGameplayTaskDeactivated (UGameplayTask &Task) override
 
virtual GAMEPLAYTASKS_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags) override
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Static Protected Member Functions

static GAMEPLAYTASKS_API IGameplayTaskOwnerInterfaceConvertToTaskOwner (UObject &OwnerObject)
 
static GAMEPLAYTASKS_API IGameplayTaskOwnerInterfaceConvertToTaskOwner (AActor &OwnerActor)
 

Protected Attributes

FName InstanceName
 
uint8 Priority
 
EGameplayTaskState TaskState
 
ETaskResourceOverlapPolicy ResourceOverlapPolicy
 
uint32 bTickingTask: 1
 
uint32 bSimulatedTask: 1
 
uint32 bIsSimulating: 1
 
uint32 bIsPausable: 1
 
uint32 bCaresAboutPriority: 1
 
uint32 bOwnedByTasksComponent: 1
 
uint32 bClaimRequiredResources: 1
 
uint32 bOwnerFinished: 1
 
FGameplayResourceSet RequiredResources
 
FGameplayResourceSet ClaimedResources
 
TWeakInterfacePtr< IGameplayTaskOwnerInterfaceTaskOwner
 
TWeakObjectPtr< UGameplayTasksComponent > TasksComponent
 
TObjectPtr< UGameplayTaskChildTask
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Public Attributes inherited from IGameplayTaskOwnerInterface
virtual UGameplayTasksComponent * GetGameplayTasksComponent (const UGameplayTask &Task) const PURE_VIRTUAL(IGameplayTaskOwnerInterface
 
virtual AActorGetGameplayTaskOwner (const UGameplayTask *Task) const PURE_VIRTUAL(IGameplayTaskOwnerInterface
 

Constructor & Destructor Documentation

◆ UGameplayTask()

UGameplayTask::UGameplayTask ( const FObjectInitializer ObjectInitializer)

Member Function Documentation

◆ Activate()

void UGameplayTask::Activate ( )
protectedvirtual

Called to trigger the actual task once the delegates have been set up Note that the default implementation does nothing and you don't have to call it

Reimplemented in UAITask, UAITask_MoveTo, UAITask_RunEQS, UGameplayTask_TimeLimitedExecution, and UGameplayTask_WaitDelay.

◆ AddClaimedResource() [1/2]

template<class T >
void UGameplayTask::AddClaimedResource ( )
inline

◆ AddClaimedResource() [2/2]

void UGameplayTask::AddClaimedResource ( TSubclassOf< UGameplayTaskResource ClaimedResource)

◆ AddClaimedResourceSet() [1/2]

void UGameplayTask::AddClaimedResourceSet ( const TArray< TSubclassOf< UGameplayTaskResource > > &  AdditionalResourcesToClaim)

◆ AddClaimedResourceSet() [2/2]

void UGameplayTask::AddClaimedResourceSet ( FGameplayResourceSet  AdditionalResourcesToClaim)

◆ AddRequiredResource() [1/2]

template<class T >
void UGameplayTask::AddRequiredResource ( )
inline

◆ AddRequiredResource() [2/2]

void UGameplayTask::AddRequiredResource ( TSubclassOf< UGameplayTaskResource RequiredResource)

Marks this task as requiring specified resource which has a number of consequences, like task not being able to run if the resource is already taken.

Note
: Calling this function makes sense only until the task is being passed over to the GameplayTasksComponent. Once that's that resources data is consumed and further changes won't get applied

◆ AddRequiredResourceSet() [1/2]

void UGameplayTask::AddRequiredResourceSet ( const TArray< TSubclassOf< UGameplayTaskResource > > &  RequiredResourceSet)

◆ AddRequiredResourceSet() [2/2]

void UGameplayTask::AddRequiredResourceSet ( FGameplayResourceSet  RequiredResourceSet)

◆ ConvertToTaskOwner() [1/2]

IGameplayTaskOwnerInterface * UGameplayTask::ConvertToTaskOwner ( AActor OwnerActor)
staticprotected

◆ ConvertToTaskOwner() [2/2]

IGameplayTaskOwnerInterface * UGameplayTask::ConvertToTaskOwner ( UObject OwnerObject)
staticprotected

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE()

UGameplayTask::DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FGenericGameplayTaskDelegate  )

◆ EndTask()

void UGameplayTask::EndTask ( )

Called explicitly to end the task (usually by the task itself). Calls OnDestroy. @NOTE: you need to call EndTask before sending out any "on completed" delegates. If you don't the task will still be in an "active" state while the event receivers may assume it's already "finished"

◆ ExternalCancel()

void UGameplayTask::ExternalCancel ( )
virtual

Called when the task is asked to cancel from an outside node. What this means depends on the individual task. By default, this does nothing other than ending the task.

◆ ExternalConfirm()

void UGameplayTask::ExternalConfirm ( bool  bEndTask)
virtual

Called when the task is asked to confirm from an outside node. What this means depends on the individual task. By default, this does nothing other than ending if bEndTask is true.

◆ GetAvatarActor()

AActor * UGameplayTask::GetAvatarActor ( ) const

Proper way to get the avatar actor associated with the task owner (usually a pawn, tower, etc)

◆ GetChildTask()

UGameplayTask * UGameplayTask::GetChildTask ( ) const
inline

◆ GetClaimedResources()

FGameplayResourceSet UGameplayTask::GetClaimedResources ( ) const
inline

◆ GetDebugString()

FString UGameplayTask::GetDebugString ( ) const
virtual

Return debug string describing task

Reimplemented in UGameplayTask_TimeLimitedExecution, and UGameplayTask_WaitDelay.

◆ GetGameplayTaskAvatar()

AActor * UGameplayTask::GetGameplayTaskAvatar ( const UGameplayTask Task) const
overrideprotectedvirtual

Get "body" of task's owner / default, having location in world (e.g. Owner = AIController, Avatar = Pawn)

Reimplemented from IGameplayTaskOwnerInterface.

◆ GetGameplayTaskDefaultPriority()

uint8 UGameplayTask::GetGameplayTaskDefaultPriority ( ) const
overrideprotectedvirtual

Get default priority for running a task

Reimplemented from IGameplayTaskOwnerInterface.

◆ GetGameplayTaskOwner()

AActor * UGameplayTask::GetGameplayTaskOwner ( const UGameplayTask Task) const
overrideprotectedvirtual

◆ GetGameplayTasksComponent() [1/3]

UGameplayTasksComponent * UGameplayTask::GetGameplayTasksComponent ( )
inline

◆ GetGameplayTasksComponent() [2/3]

UGameplayTasksComponent * UGameplayTask::GetGameplayTasksComponent ( ) const
inline

◆ GetGameplayTasksComponent() [3/3]

UGameplayTasksComponent * UGameplayTask::GetGameplayTasksComponent ( const UGameplayTask Task) const
overrideprotectedvirtual

◆ GetInstanceName()

FName UGameplayTask::GetInstanceName ( ) const
inline

◆ GetOwnerActor()

AActor * UGameplayTask::GetOwnerActor ( ) const

Proper way to get the owning actor of task owner. This can be the owner itself since the owner is given as a interface

◆ GetPriority()

uint8 UGameplayTask::GetPriority ( ) const
inline

◆ GetRequiredResources()

FGameplayResourceSet UGameplayTask::GetRequiredResources ( ) const
inline

◆ GetResourceOverlapPolicy()

ETaskResourceOverlapPolicy UGameplayTask::GetResourceOverlapPolicy ( ) const
inline

◆ GetState()

EGameplayTaskState UGameplayTask::GetState ( ) const
inline

◆ GetTaskOwner()

IGameplayTaskOwnerInterface * UGameplayTask::GetTaskOwner ( ) const
inline

◆ GetWorld()

UWorld * UGameplayTask::GetWorld ( ) const
overridevirtual

Helper function for getting UWorld off a task

◆ HasOwnerFinished()

bool UGameplayTask::HasOwnerFinished ( ) const
inline

◆ InitSimulatedTask()

void UGameplayTask::InitSimulatedTask ( UGameplayTasksComponent &  InGameplayTasksComponent)
virtual

◆ InitTask()

void UGameplayTask::InitTask ( IGameplayTaskOwnerInterface InTaskOwner,
uint8  InPriority 
)
protected

Initializes the task with the task owner interface instance but does not activate until Activate() is called

◆ IsActive()

bool UGameplayTask::IsActive ( ) const
inline

◆ IsFinished()

bool UGameplayTask::IsFinished ( ) const
inline

◆ IsOwnedByTasksComponent()

bool UGameplayTask::IsOwnedByTasksComponent ( ) const
inline

◆ IsPausable()

bool UGameplayTask::IsPausable ( ) const
inline

◆ IsPaused()

bool UGameplayTask::IsPaused ( ) const
inline

◆ IsSimulatedTask()

bool UGameplayTask::IsSimulatedTask ( ) const
inline

◆ IsSimulating()

bool UGameplayTask::IsSimulating ( ) const
inline

◆ IsSupportedForNetworking()

virtual bool UGameplayTask::IsSupportedForNetworking ( ) const
inlineoverridevirtual

IsSupportedForNetworking means an object can be referenced over the network

Reimplemented from UObject.

◆ IsTickingTask()

bool UGameplayTask::IsTickingTask ( ) const
inline

◆ IsWaitingOnAvatar()

virtual bool UGameplayTask::IsWaitingOnAvatar ( ) const
inlinevirtual

◆ IsWaitingOnRemotePlayerdata()

virtual bool UGameplayTask::IsWaitingOnRemotePlayerdata ( ) const
inlinevirtual

◆ MarkOwnerFinished()

void UGameplayTask::MarkOwnerFinished ( )
inline

Called when a task owner wants to inform the task that it's done and don't want to get notified on task deactivation (i.e. OnGameplayTaskDeactivated).

◆ NewTask() [1/4]

template<class T >
T * UGameplayTask::NewTask ( IGameplayTaskOwnerInterface TaskOwner,
FName  InstanceName = FName() 
)
inlinestatic

◆ NewTask() [2/4]

template<class T >
static T * UGameplayTask::NewTask ( TScriptInterface< IGameplayTaskOwnerInterface TaskOwner,
FName  InstanceName = FName() 
)
inlinestatic

◆ NewTask() [3/4]

template<class T >
T * UGameplayTask::NewTask ( UObject WorldContextObject,
FName  InstanceName = FName() 
)
inlinestatic

◆ NewTask() [4/4]

template<class T >
static T * UGameplayTask::NewTask ( UObject WorldContextObject,
FName  InstanceName = FName() 
)
inlinestatic

Helper function for instantiating and initializing a new task

◆ NewTaskUninitialized()

template<class T >
static T * UGameplayTask::NewTaskUninitialized ( )
inlinestatic

Added for consistency with NewTask, but to indicate that a task requires manual call to InitTask This path is used to manually configure some aspects of the task, like Priority

◆ OnDestroy()

void UGameplayTask::OnDestroy ( bool  bInOwnerFinished)
protectedvirtual

End and CleanUp the task - may be called by the task itself or by the task owner if the owner is ending. IMPORTANT! Do NOT call directly! Call EndTask() or TaskOwnerEnded() IMPORTANT! When overriding this function make sure to call Super::OnDestroy(bOwnerFinished) as the last thing, since the function internally marks the task as "Pending Kill", and this may interfere with internal BP mechanics

Reimplemented in UAITask_MoveTo.

◆ OnGameplayTaskDeactivated()

void UGameplayTask::OnGameplayTaskDeactivated ( UGameplayTask Task)
overrideprotectedvirtual

Notify called after GameplayTask changes state from Active (finishing or pausing)

Reimplemented from IGameplayTaskOwnerInterface.

Reimplemented in UGameplayTask_TimeLimitedExecution.

◆ OnGameplayTaskInitialized()

void UGameplayTask::OnGameplayTaskInitialized ( UGameplayTask Task)
overrideprotectedvirtual

Notify called after GameplayTask finishes initialization (not active yet)

Reimplemented from IGameplayTaskOwnerInterface.

◆ Pause()

void UGameplayTask::Pause ( )
protectedvirtual

Reimplemented in UAITask_MoveTo.

◆ ReadyForActivation()

void UGameplayTask::ReadyForActivation ( )

Called to trigger the actual task once the delegates have been set up

◆ RegisterReplicationFragments()

void UGameplayTask::RegisterReplicationFragments ( UE::Net::FFragmentRegistrationContext Context,
UE::Net::EFragmentRegistrationFlags  RegistrationFlags 
)
overrideprotectedvirtual

Register all replication fragments

Reimplemented from UObject.

◆ RequiresPriorityOrResourceManagement()

bool UGameplayTask::RequiresPriorityOrResourceManagement ( ) const
inline

◆ Resume()

void UGameplayTask::Resume ( )
protectedvirtual

Reimplemented in UAITask_MoveTo.

◆ TaskOwnerEnded()

void UGameplayTask::TaskOwnerEnded ( )

Called when task owner has "ended" (before the task ends) kills the task. Calls OnDestroy.

◆ TickTask()

virtual void UGameplayTask::TickTask ( float  DeltaTime)
inlinevirtual

Tick function for this task, if bTickingTask == true

Member Data Documentation

◆ bCaresAboutPriority

uint32 UGameplayTask::bCaresAboutPriority
protected

◆ bClaimRequiredResources

uint32 UGameplayTask::bClaimRequiredResources
protected

◆ bIsPausable

uint32 UGameplayTask::bIsPausable
protected

◆ bIsSimulating

uint32 UGameplayTask::bIsSimulating
protected

Am I actually running this as a simulated task. (This will be true on clients that simulating. This will be false on the server and the owning client)

◆ bOwnedByTasksComponent

uint32 UGameplayTask::bOwnedByTasksComponent
protected

this is set to avoid duplicate calls to task's owner and TasksComponent when both are the same object

◆ bOwnerFinished

uint32 UGameplayTask::bOwnerFinished
protected

◆ bSimulatedTask

uint32 UGameplayTask::bSimulatedTask
protected

Should this task run on simulated clients? This should only be used in rare cases, such as movement tasks. Simulated Tasks do not broadcast their end delegates.

◆ bTickingTask

uint32 UGameplayTask::bTickingTask
protected

If true, this task will receive TickTask calls from TasksComponent

◆ ChildTask

TObjectPtr<UGameplayTask> UGameplayTask::ChildTask
protected

child task instance

◆ ClaimedResources

FGameplayResourceSet UGameplayTask::ClaimedResources
protected

Resources that are going to be locked when this task gets activated, but are not required to get this task started

◆ InstanceName

FName UGameplayTask::InstanceName
protected

This name allows us to find the task later so that we can end it.

◆ Priority

uint8 UGameplayTask::Priority
protected

This controls how this task will be treated in relation to other, already running tasks, provided GameplayTasksComponent is configured to care about priorities (the default behavior)

◆ RequiredResources

FGameplayResourceSet UGameplayTask::RequiredResources
protected

Abstract "resource" IDs this task needs available to be able to get activated.

◆ ResourceOverlapPolicy

ETaskResourceOverlapPolicy UGameplayTask::ResourceOverlapPolicy
protected

◆ TaskOwner

TWeakInterfacePtr<IGameplayTaskOwnerInterface> UGameplayTask::TaskOwner
protected

Task Owner that created us

◆ TasksComponent

TWeakObjectPtr<UGameplayTasksComponent> UGameplayTask::TasksComponent
protected

◆ TaskState

EGameplayTaskState UGameplayTask::TaskState
protected

You should never access it directly. We'll make it private once we have a good way of "deprecating: direct access


The documentation for this class was generated from the following files: