FAIResourceLock

Structure used to define which subsystem requested locking of a specific AI resource (like movement, logic, etc.)

Windows
MacOS
Linux

References

Module

AIModule

Header

/Engine/Source/Runtime/AIModule/Classes/AITypes.h

Include

#include "AITypes.h"

Syntax

struct FAIResourceLock

Remarks

Structure used to define which subsystem requested locking of a specific AI resource (like movement, logic, etc.)

Constructors

Name Description

Public function

FAIResourceLock()

Functions

Name Description

Public function

void

 

ClearLock

(
    EAIRequestPriority::Type LockPriori...
)

Public function

void

 

ForceClearAllLocks()

Force-clears all locks

Public function Const

FString

 

GetLockPriorityName()

Public function Const

bool

 

IsAvailableFor

(
    EAIRequestPriority::Type LockPriori...
)

Answers the question if given priority is allowed to use this resource.

Public function Const

bool

 

IsLocked()

Public function Const

bool

 

IsLockedBy

(
    EAIRequestPriority::Type LockPriori...
)

Public function

void

 

SetLock

(
    EAIRequestPriority::Type LockPriori...
)

Public function

void

 

SetUseResourceLockCount

(
    bool inUseResourceLockCount
)

Set whether we should use resource lock count. clears all existing locks.

Operators

Name Description

Public function

void

 

operator+=

(
    const FAIResourceLock& Other
)

Public function

bool

 

operator==

(
    const FAIResourceLock& Other
)

Typedefs

Name

Description

FLockFlags

@note feel free to change the type if you need to support more then 16 lock sources
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss