SCR_AIGroupFireteam Interface Reference

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

Inheritance diagram for SCR_AIGroupFireteam:

Public Member Functions
void	AddMember (AIAgent agent)
void	RemoveMember (AIAgent agent)
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 ()
	Tries to lock the fireteam, on success returns the Lock object.

Protected Member Functions
void	RemoveMember (int id, out AIAgent outAgent)

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.

Member Function Documentation

AddMember()

void SCR_AIGroupFireteam.AddMember

(

AIAgent

agent

)

GetFirstMemberEntity()

IEntity SCR_AIGroupFireteam.GetFirstMemberEntity

(

)

GetMember()

AIAgent SCR_AIGroupFireteam.GetMember

(

int

id

)

GetMemberCount()

int SCR_AIGroupFireteam.GetMemberCount

(

)

GetMembers()

void SCR_AIGroupFireteam.GetMembers

(

notnull array< AIAgent >

outAgents

)

HasMember()

bool SCR_AIGroupFireteam.HasMember

(

AIAgent

agent

)

Internal_OnLockDestroyed()

void SCR_AIGroupFireteam.Internal_OnLockDestroyed

(

)

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

IsLocked()

bool SCR_AIGroupFireteam.IsLocked

(

)

MoveMembersFrom()

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

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

RemoveMember() [1/2]

void SCR_AIGroupFireteam.RemoveMember

(

AIAgent

agent

)

RemoveMember() [2/2]

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

protected

TryLock()

SCR_AIGroupFireteamLock SCR_AIGroupFireteam.TryLock

(

)

Tries to lock the fireteam, on success returns the Lock object.

Store the returned Lock object as strong reference.

Member Data Documentation

m_aAgents

ref array<AIAgent> SCR_AIGroupFireteam.m_aAgents = {}

protected

m_bLocked

bool SCR_AIGroupFireteam.m_bLocked = false

protected

---

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

• Game/AI/Group/SCR_AIGroupFireteam.c