SCR_AIGroupFireteamLock Class Reference

Inheritance diagram for SCR_AIGroupFireteamLock:

Protected Member Functions
void	SCR_AIGroupFireteamLock (SCR_AIGroupFireteam ft)
void	~SCR_AIGroupFireteamLock ()
SCR_AIGroupFireteam	GetFireteam ()

Static Protected Member Functions
static int	FindFireteamLock (notnull TFireteamLockRefArray locksArray, SCR_AIGroupFireteam ft)
	Helper functions to manipulate fireteam locks in arrays.
static int	FindFireteamLock (notnull TFireteamLockArray locksArray, SCR_AIGroupFireteam ft)
static int	FindFireteamLock (notnull TFireteamLockRefArray locksArray, SCR_AIGroupFireteamLock ft)
static int	FindFireteamLock (notnull TFireteamLockArray locksArray, SCR_AIGroupFireteamLock ft)
static bool	RemoveFireteamLock (TFireteamLockRefArray locksArray, SCR_AIGroupFireteam ft)
static bool	RemoveFireteamLock (TFireteamLockArray locksArray, SCR_AIGroupFireteam ft)
static void	TryLockFireteams (notnull array< SCR_AIGroupFireteam > fireteams, notnull TFireteamLockRefArray locks, bool clearLockArray)
	Tries to lock all fireteams, returns a new array of locks for those fireteams it was able to lock.
static TFireteamLockRefArray	CopyLockArray (TFireteamLockRefArray other)
	Creates a copy of locks array.

Protected Attributes
ref SCR_AIGroupFireteam	m_Fireteam

Detailed Description

Definition at line 9 of file SCR_AIGroupFireteamLock.c.

Constructor & Destructor Documentation

SCR_AIGroupFireteamLock()

void SCR_AIGroupFireteamLock::SCR_AIGroupFireteamLock ( SCR_AIGroupFireteam ft )

inlineprotected

Definition at line 14 of file SCR_AIGroupFireteamLock.c.

~SCR_AIGroupFireteamLock()

void SCR_AIGroupFireteamLock::~SCR_AIGroupFireteamLock ( )

inlineprotected

Definition at line 20 of file SCR_AIGroupFireteamLock.c.

Member Function Documentation

CopyLockArray()

TFireteamLockRefArray SCR_AIGroupFireteamLock::CopyLockArray ( TFireteamLockRefArray other )

inlinestaticprotected

Creates a copy of locks array.

Definition at line 121 of file SCR_AIGroupFireteamLock.c.

FindFireteamLock() [1/4]

int SCR_AIGroupFireteamLock::FindFireteamLock ( notnull TFireteamLockArray locksArray, SCR_AIGroupFireteam ft )

inlinestaticprotected

Definition at line 49 of file SCR_AIGroupFireteamLock.c.

FindFireteamLock() [2/4]

int SCR_AIGroupFireteamLock::FindFireteamLock ( notnull TFireteamLockArray locksArray, SCR_AIGroupFireteamLock ft )

inlinestaticprotected

Definition at line 71 of file SCR_AIGroupFireteamLock.c.

FindFireteamLock() [3/4]

int SCR_AIGroupFireteamLock::FindFireteamLock ( notnull TFireteamLockRefArray locksArray, SCR_AIGroupFireteam ft )

inlinestaticprotected

Helper functions to manipulate fireteam locks in arrays.

Returns ID of fireteam lock which references the passed fireteam Two functions, for TFireteamLockRefArray and TFireteamLockArray

Definition at line 40 of file SCR_AIGroupFireteamLock.c.

FindFireteamLock() [4/4]

int SCR_AIGroupFireteamLock::FindFireteamLock ( notnull TFireteamLockRefArray locksArray, SCR_AIGroupFireteamLock ft )

inlinestaticprotected

Returns ID of fireteam lock Two functions, for TFireteamLockRefArray and TFireteamLockArray

Definition at line 62 of file SCR_AIGroupFireteamLock.c.

GetFireteam()

SCR_AIGroupFireteam SCR_AIGroupFireteamLock::GetFireteam ( )

inlineprotected

Definition at line 27 of file SCR_AIGroupFireteamLock.c.

RemoveFireteamLock() [1/2]

bool SCR_AIGroupFireteamLock::RemoveFireteamLock ( TFireteamLockArray locksArray, SCR_AIGroupFireteam ft )

inlinestaticprotected

Definition at line 94 of file SCR_AIGroupFireteamLock.c.

RemoveFireteamLock() [2/2]

bool SCR_AIGroupFireteamLock::RemoveFireteamLock ( TFireteamLockRefArray locksArray, SCR_AIGroupFireteam ft )

inlinestaticprotected

Removes fireteam lock which references the passed fireteam Returns true if the fireteam lock was found Two functions, for TFireteamLockRefArray and TFireteamLockArray

Definition at line 85 of file SCR_AIGroupFireteamLock.c.

TryLockFireteams()

void SCR_AIGroupFireteamLock::TryLockFireteams ( notnull array< SCR_AIGroupFireteam > fireteams, notnull TFireteamLockRefArray locks, bool clearLockArray )

inlinestaticprotected

Tries to lock all fireteams, returns a new array of locks for those fireteams it was able to lock.

Definition at line 106 of file SCR_AIGroupFireteamLock.c.

Member Data Documentation

m_Fireteam

ref SCR_AIGroupFireteam SCR_AIGroupFireteamLock::m_Fireteam

protected

Definition at line 11 of file SCR_AIGroupFireteamLock.c.

---

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

• scripts/Game/AI/Group/SCR_AIGroupFireteamLock.c