SCR_AIGroupFireteamLock Interface Reference

Inheritance diagram for SCR_AIGroupFireteamLock:

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

Static Public 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)
	Returns ID of fireteam lock Two functions, for TFireteamLockRefArray and TFireteamLockArray.
static int	FindFireteamLock (notnull TFireteamLockArray locksArray, SCR_AIGroupFireteamLock ft)
static bool	RemoveFireteamLock (TFireteamLockRefArray locksArray, SCR_AIGroupFireteam ft)
	Removes fireteam lock which references the passed fireteam Returns true if the fireteam lock was found Two functions, for TFireteamLockRefArray and TFireteamLockArray.
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

Constructor & Destructor Documentation

SCR_AIGroupFireteamLock()

void SCR_AIGroupFireteamLock.SCR_AIGroupFireteamLock

(

SCR_AIGroupFireteam

ft

)

~SCR_AIGroupFireteamLock()

void SCR_AIGroupFireteamLock.~SCR_AIGroupFireteamLock

(

)

Member Function Documentation

CopyLockArray()

static TFireteamLockRefArray SCR_AIGroupFireteamLock.CopyLockArray ( TFireteamLockRefArray  other )

static

Creates a copy of locks array.

FindFireteamLock() [1/4]

static int SCR_AIGroupFireteamLock.FindFireteamLock ( notnull TFireteamLockArray  locksArray, SCR_AIGroupFireteam  ft  )

static

FindFireteamLock() [2/4]

static int SCR_AIGroupFireteamLock.FindFireteamLock ( notnull TFireteamLockArray  locksArray, SCR_AIGroupFireteamLock  ft  )

static

FindFireteamLock() [3/4]

static int SCR_AIGroupFireteamLock.FindFireteamLock ( notnull TFireteamLockRefArray  locksArray, SCR_AIGroupFireteam  ft  )

static

Helper functions to manipulate fireteam locks in arrays.

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

FindFireteamLock() [4/4]

static int SCR_AIGroupFireteamLock.FindFireteamLock ( notnull TFireteamLockRefArray  locksArray, SCR_AIGroupFireteamLock  ft  )

static

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

GetFireteam()

SCR_AIGroupFireteam SCR_AIGroupFireteamLock.GetFireteam

(

)

RemoveFireteamLock() [1/2]

static bool SCR_AIGroupFireteamLock.RemoveFireteamLock ( TFireteamLockArray  locksArray, SCR_AIGroupFireteam  ft  )

static

RemoveFireteamLock() [2/2]

static bool SCR_AIGroupFireteamLock.RemoveFireteamLock ( TFireteamLockRefArray  locksArray, SCR_AIGroupFireteam  ft  )

static

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

TryLockFireteams()

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

static

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

Member Data Documentation

m_Fireteam

ref SCR_AIGroupFireteam SCR_AIGroupFireteamLock.m_Fireteam

protected

---

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

• Game/AI/Group/SCR_AIGroupFireteamLock.c