SCR_AIGroupFireteam Class Reference

Inheritance diagram for SCR_AIGroupFireteam:

Protected Member Functions
void	AddMember (AIAgent agent)
void	RemoveMember (AIAgent agent)
void	RemoveMember (int id, out AIAgent outAgent)
AIAgent	GetMember (int id)
IEntity	GetFirstMemberEntity ()
void	GetMembers (notnull array< AIAgent > outAgents)
void	MoveMembersFrom (notnull SCR_AIGroupFireteam otherFt, int count)
	Moves 'count' members from other fireteam to this one.
bool	HasMember (AIAgent agent)
int	GetMemberCount ()
void	Internal_OnLockDestroyed ()
	Don't ever try to free a fireteam yourself, use SCR_AIGroupFireteamLock instead.
bool	IsLocked ()
SCR_AIGroupFireteamLock	TryLock ()

Protected Attributes
ref array< AIAgent >	m_aAgents = {}
bool	m_bLocked = false

Detailed Description

Fireteam base class Fireteam is like a collection of agents in a group

Definition at line 3 of file SCR_AIGroupFireteam.c.

Member Function Documentation

AddMember()

void SCR_AIGroupFireteam::AddMember ( AIAgent agent )

inlineprotected

Definition at line 10 of file SCR_AIGroupFireteam.c.

GetFirstMemberEntity()

IEntity SCR_AIGroupFireteam::GetFirstMemberEntity ( )

inlineprotected

Definition at line 43 of file SCR_AIGroupFireteam.c.

GetMember()

AIAgent SCR_AIGroupFireteam::GetMember ( int id )

inlineprotected

Definition at line 34 of file SCR_AIGroupFireteam.c.

GetMemberCount()

int SCR_AIGroupFireteam::GetMemberCount ( )

inlineprotected

Definition at line 96 of file SCR_AIGroupFireteam.c.

GetMembers()

void SCR_AIGroupFireteam::GetMembers ( notnull array< AIAgent > outAgents )

inlineprotected

Definition at line 58 of file SCR_AIGroupFireteam.c.

HasMember()

bool SCR_AIGroupFireteam::HasMember ( AIAgent agent )

inlineprotected

Definition at line 90 of file SCR_AIGroupFireteam.c.

Internal_OnLockDestroyed()

void SCR_AIGroupFireteam::Internal_OnLockDestroyed ( )

inlineprotected

Don't ever try to free a fireteam yourself, use SCR_AIGroupFireteamLock instead.

Definition at line 103 of file SCR_AIGroupFireteam.c.

IsLocked()

bool SCR_AIGroupFireteam::IsLocked ( )

inlineprotected

Definition at line 112 of file SCR_AIGroupFireteam.c.

MoveMembersFrom()

void SCR_AIGroupFireteam::MoveMembersFrom ( notnull SCR_AIGroupFireteam otherFt, int count )

inlineprotected

Moves 'count' members from other fireteam to this one.

Definition at line 67 of file SCR_AIGroupFireteam.c.

RemoveMember() [1/2]

void SCR_AIGroupFireteam::RemoveMember ( AIAgent agent )

inlineprotected

Definition at line 17 of file SCR_AIGroupFireteam.c.

RemoveMember() [2/2]

void SCR_AIGroupFireteam::RemoveMember ( int id, out AIAgent outAgent )

inlineprotected

Definition at line 26 of file SCR_AIGroupFireteam.c.

TryLock()

SCR_AIGroupFireteamLock SCR_AIGroupFireteam::TryLock ( )

inlineprotected

Tries to lock the fireteam, on success returns the Lock object. Store the returned Lock object as strong reference.

Definition at line 120 of file SCR_AIGroupFireteam.c.

Member Data Documentation

m_aAgents

ref array<AIAgent> SCR_AIGroupFireteam::m_aAgents = {}

protected

Definition at line 5 of file SCR_AIGroupFireteam.c.

m_bLocked

bool SCR_AIGroupFireteam::m_bLocked = false

protected

Definition at line 7 of file SCR_AIGroupFireteam.c.

---

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

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