SCR_CallsignPlatoonData Interface Reference

For each platoon, holds availible squads. More...

Public Member Functions
void	Init (SCR_FactionCallsignInfo factionCallsignInfo)
	Init Platoon data, creating all the squads within.
int	GetRandomSquad ()
	Gets a squad index randomly from availible callsigns.
int	GetFirstAvailibleSquad ()
	Goes through all availible squads gets the first availible.
void	AddSquad (int squadIndex)
	Adds callsign back to availible callsign pool.
bool	RemoveSquad (int squadIndex)
	Removes callsign from availible callsign pool.

Protected Attributes
ref array< int >	m_mSquadCallsigns = new array<int>

Detailed Description

For each platoon, holds availible squads.

Member Function Documentation

AddSquad()

void SCR_CallsignPlatoonData.AddSquad

(

int

squadIndex

)

Adds callsign back to availible callsign pool.

Parameters

squad

index

GetFirstAvailibleSquad()

int SCR_CallsignPlatoonData.GetFirstAvailibleSquad

(

)

Goes through all availible squads gets the first availible.

Meaning if squad 1 is taken it will get 2 next not 3.

Returns

int squad index

GetRandomSquad()

int SCR_CallsignPlatoonData.GetRandomSquad

(

)

Gets a squad index randomly from availible callsigns.

Returns

int squad index

Init()

void SCR_CallsignPlatoonData.Init

(

SCR_FactionCallsignInfo

factionCallsignInfo

)

Init Platoon data, creating all the squads within.

Parameters

factionCallsignInfo

specific callsign info for faction

RemoveSquad()

bool SCR_CallsignPlatoonData.RemoveSquad

(

int

squadIndex

)

Removes callsign from availible callsign pool.

Parameters

squad

index

Member Data Documentation

m_mSquadCallsigns

ref array<int> SCR_CallsignPlatoonData.m_mSquadCallsigns = new array<int>

protected

---

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

• Game/Callsign/SCR_CallsignPlatoonData.c