SCR_CallsignCompanyData Class Reference

Protected Member Functions
Init Company creating all the platoons within which in turn create the availible squads within param factionCallsignInfo specific callsign info for faction *void	Init (SCR_FactionCallsignInfo factionCallsignInfo)
Gets platoon and squad index randomly from availible callsigns param[out] platoon index param[out] squad index return bool true if succesfully found a callsign *void	GetRandomCallsign (out int platoon, out int squad)
Goes through all availible platoons and squads and gets the first availible Meaning if platoon is taken it will get next not param[out] platoon index param[out] squad index return bool true if succesfully found a callsign *void	GetFirstAvailibleCallsign (out int firstAvailiblePlatoon, out int firstAvailibleSquad)
bool	GetFirstAvailableSquadCallsign (out int firstAvailablePlatoon, out int firstAvailableSquad)
Adds callsign back to availible callsign pool param platoon index param squad index *void	AddCallsign (int platoonIndex, int squadIndex)
Removes callsign from availible callsign pool param platoon index param squad index *bool	RemoveCallsign (int plattonIndex, int squadIndex)

Protected Attributes
ref map< int, ref SCR_CallsignPlatoonData >	m_mPlatoonCallsigns = new map<int, ref SCR_CallsignPlatoonData>
Init Company	data

Detailed Description

For each company, holds availible platoons, which in turn holds availible squads

Definition at line 4 of file SCR_CallsignCompanyData.c.

Member Function Documentation

AddCallsign()

Adds callsign back to availible callsign pool param platoon index param squad index *void SCR_CallsignCompanyData::AddCallsign ( int platoonIndex, int squadIndex )

inlineprotected

Definition at line 102 of file SCR_CallsignCompanyData.c.

GetFirstAvailableSquadCallsign()

bool SCR_CallsignCompanyData::GetFirstAvailableSquadCallsign ( out int firstAvailablePlatoon, out int firstAvailableSquad )

inlineprotected

Finds a platoon with the most available squad callsigns and gets the first available callsign in the platoon. Meaning if platoon 1 has 2 (out of 4) squads taken and platoon 2 has only one (out of 4) taken, it will pick the first available squad of the second platoon.

Parameters

[out]	platoon	index
[out]	squad	index

Returns

bool true if successfully found an available callsign

Definition at line 72 of file SCR_CallsignCompanyData.c.

GetFirstAvailibleCallsign()

Goes through all availible platoons and squads and gets the first availible Meaning if platoon is taken it will get next not param[out] platoon index param[out] squad index return bool true if succesfully found a callsign *void SCR_CallsignCompanyData::GetFirstAvailibleCallsign ( out int firstAvailiblePlatoon, out int firstAvailibleSquad )

inlineprotected

Definition at line 50 of file SCR_CallsignCompanyData.c.

GetRandomCallsign()

Gets platoon and squad index randomly from availible callsigns param[out] platoon index param[out] squad index return bool true if succesfully found a callsign *void SCR_CallsignCompanyData::GetRandomCallsign ( out int platoon, out int squad )

inlineprotected

Definition at line 34 of file SCR_CallsignCompanyData.c.

Init()

Init Company creating all the platoons within which in turn create the availible squads within param factionCallsignInfo specific callsign info for faction *void SCR_CallsignCompanyData::Init ( SCR_FactionCallsignInfo factionCallsignInfo )

inlineprotected

Definition at line 13 of file SCR_CallsignCompanyData.c.

RemoveCallsign()

Removes callsign from availible callsign pool param platoon index param squad index *bool SCR_CallsignCompanyData::RemoveCallsign ( int plattonIndex, int squadIndex )

inlineprotected

Definition at line 124 of file SCR_CallsignCompanyData.c.

Member Data Documentation

data

Init Company SCR_CallsignCompanyData::data

protected

Definition at line 10 of file SCR_CallsignCompanyData.c.

m_mPlatoonCallsigns

ref map<int, ref SCR_CallsignPlatoonData> SCR_CallsignCompanyData::m_mPlatoonCallsigns = new map<int, ref SCR_CallsignPlatoonData>

protected

Definition at line 6 of file SCR_CallsignCompanyData.c.

---

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

• scripts/Game/Callsign/SCR_CallsignCompanyData.c