Protected Member Functions
string	GetCallsignFormat (bool includeCharacter, int characterRole=-1)
bool	GetIsAssignedRandomly ()
bool	GetAssignCallsignBasedOnGroupRole ()
void	GetCompanyArray (notnull array< ref SCR_CallsignInfo > companyArray)
void	GetPlatoonArray (notnull array< ref SCR_CallsignInfo > platoonArray)
void	GetSquadArray (notnull array< ref SCR_CallsignInfo > squadArray)
string	GetCompanyCallsignName (int index)
int	GetCompanyOverflowIndex ()
string	GetPlatoonCallsignName (int index)
string	GetSquadCallsignName (int index)
string	GetCharacterRoleCallsignName (int index)
bool	GetRandomCallsign (out int company, out int platoon, out int squad)
bool	GetCharacterRoleCallsign (IEntity character, int playerID, SCR_AIGroup group, inout int roleCallsignIndex, out bool isUnique)
bool	GetGroupRoleSpecificCompanies (SCR_EGroupRole groupRole, notnull out array< int > companyIndexes)

Protected Attributes
bool	m_bIsAssignedRandomly
bool	m_bAssignCallsignBasedOnGroupRole
ref array< ref SCR_CallsignInfo >	m_aCompanyNames
int	m_iCompanyOverflowIndex
ref array< ref SCR_CallsignInfo >	m_aPlatoonNames
ref array< ref SCR_CallsignInfo >	m_aSquadNames
LocalizedString	m_sCallsignGroupFormat
LocalizedString	m_sCallsignCharacterFormat
LocalizedString	m_sCallsignCharacterWithRoleFormat
ref array< ref SCR_BaseRoleCallsign >	m_aCharacterRoleCallsigns
ref array< ref SCR_FactionGroupRoleSpecificCallsignInfo >	m_aGroupRoleSpecificCallsigns

Detailed Description

Stores the Callsign information data for the faction.

Definition at line 5 of file SCR_FactionCallsignInfo.c.

Member Function Documentation

◆ GetAssignCallsignBasedOnGroupRole()

bool SCR_FactionCallsignInfo::GetAssignCallsignBasedOnGroupRole ( )

inlineprotected

Definition at line 64 of file SCR_FactionCallsignInfo.c.

◆ GetCallsignFormat()

string SCR_FactionCallsignInfo::GetCallsignFormat	(	bool	includeCharacter,
		int	characterRole = -1 )

inlineprotected

Get callsign format

Returns: string callsign Format

Definition at line 44 of file SCR_FactionCallsignInfo.c.

◆ GetCharacterRoleCallsign()

bool SCR_FactionCallsignInfo::GetCharacterRoleCallsign	(	IEntity	character,
		int	playerID,
		SCR_AIGroup	group,
		inout int	roleCallsignIndex,
		out bool	isUnique )

inlineprotected

Loops through all availible roles for the faction and grabs the first availible role for that character

Parameters

	character	IEntity of character to assign callsign
	playerID	if entity is a player then ID is also given
	group	SCR_AIGroup group of which character is a part of
	occupiedAIRoles	roles already occupied by AI for the group the character is part of
	occupiedPlayerRoles	roles already occupied by Player for the group the character is part of
[out]	roleCallsignIndex	the return index of the found character role. Can be given a value to look for a specific role to assign
[out]	isUnique	If true than only one character can have the role in the group (as well as any attached master and slave groups)

Returns: bool true if callsign found, else it returns false

Definition at line 207 of file SCR_FactionCallsignInfo.c.

◆ GetCharacterRoleCallsignName()

string SCR_FactionCallsignInfo::GetCharacterRoleCallsignName ( int index )

inlineprotected

Get the character role callsign using index

Parameters

index of character role

Returns: string character role callsign name

Definition at line 158 of file SCR_FactionCallsignInfo.c.

◆ GetCompanyArray()

void SCR_FactionCallsignInfo::GetCompanyArray ( notnull array< ref SCR_CallsignInfo > companyArray )

inlineprotected

Get Company array

Returns: array<ref SCR_CallsignInfo> companyArray

Definition at line 73 of file SCR_FactionCallsignInfo.c.

◆ GetCompanyCallsignName()

string SCR_FactionCallsignInfo::GetCompanyCallsignName ( int index )

inlineprotected

Get the company name using index

Parameters

index of company name

Returns: string company name

Definition at line 110 of file SCR_FactionCallsignInfo.c.

◆ GetCompanyOverflowIndex()

int SCR_FactionCallsignInfo::GetCompanyOverflowIndex ( )

inlineprotected

Gets the index at which overflow companies start

Returns: int m_iCompanyOverflowIndex

Definition at line 122 of file SCR_FactionCallsignInfo.c.

◆ GetGroupRoleSpecificCompanies()

bool SCR_FactionCallsignInfo::GetGroupRoleSpecificCompanies	(	SCR_EGroupRole	groupRole,
		notnull out array< int >	companyIndexes )

inlineprotected

Gets indexes of all the assignable company callsigns based on the inputted group role.

Parameters

[in]	group	role
[out]	company	indexes

Returns: true if specific group role has any assignable company callsigns

Definition at line 223 of file SCR_FactionCallsignInfo.c.

◆ GetIsAssignedRandomly()

bool SCR_FactionCallsignInfo::GetIsAssignedRandomly ( )

inlineprotected

Get callsign format

Returns: bool if callsigns are assigned in order or randomly

Definition at line 58 of file SCR_FactionCallsignInfo.c.

◆ GetPlatoonArray()

void SCR_FactionCallsignInfo::GetPlatoonArray ( notnull array< ref SCR_CallsignInfo > platoonArray )

inlineprotected

Get Platoon array

Returns: array<ref SCR_CallsignInfo> platoonArray

Definition at line 85 of file SCR_FactionCallsignInfo.c.

◆ GetPlatoonCallsignName()

string SCR_FactionCallsignInfo::GetPlatoonCallsignName ( int index )

inlineprotected

Get the Platoon name using index

Parameters

index of Platoon name

Returns: string Platoon name

Definition at line 132 of file SCR_FactionCallsignInfo.c.

◆ GetRandomCallsign()

bool SCR_FactionCallsignInfo::GetRandomCallsign	(	out int	company,
		out int	platoon,
		out int	squad )

inlineprotected

Get random call sign

Parameters

[out]	company	random company name index
[out]	platoon	random platoon name index
[out]	squad	random squad name index

Definition at line 179 of file SCR_FactionCallsignInfo.c.

◆ GetSquadArray()

void SCR_FactionCallsignInfo::GetSquadArray ( notnull array< ref SCR_CallsignInfo > squadArray )

inlineprotected

Get Squad array

Returns: array<ref SCR_CallsignInfo> squadArray

Definition at line 97 of file SCR_FactionCallsignInfo.c.

◆ GetSquadCallsignName()

string SCR_FactionCallsignInfo::GetSquadCallsignName ( int index )

inlineprotected

Get the Squad name using index

Parameters

index of Squad name

Returns: string Squad name

Definition at line 145 of file SCR_FactionCallsignInfo.c.

Member Data Documentation

◆ m_aCharacterRoleCallsigns

ref array<ref SCR_BaseRoleCallsign> SCR_FactionCallsignInfo::m_aCharacterRoleCallsigns

protected

Definition at line 35 of file SCR_FactionCallsignInfo.c.

◆ m_aCompanyNames

ref array<ref SCR_CallsignInfo> SCR_FactionCallsignInfo::m_aCompanyNames

protected

Definition at line 14 of file SCR_FactionCallsignInfo.c.

◆ m_aGroupRoleSpecificCallsigns

ref array<ref SCR_FactionGroupRoleSpecificCallsignInfo> SCR_FactionCallsignInfo::m_aGroupRoleSpecificCallsigns

protected

Definition at line 38 of file SCR_FactionCallsignInfo.c.

◆ m_aPlatoonNames

ref array<ref SCR_CallsignInfo> SCR_FactionCallsignInfo::m_aPlatoonNames

protected

Definition at line 20 of file SCR_FactionCallsignInfo.c.

◆ m_aSquadNames

ref array<ref SCR_CallsignInfo> SCR_FactionCallsignInfo::m_aSquadNames

protected

Definition at line 23 of file SCR_FactionCallsignInfo.c.

◆ m_bAssignCallsignBasedOnGroupRole

bool SCR_FactionCallsignInfo::m_bAssignCallsignBasedOnGroupRole

protected

Definition at line 11 of file SCR_FactionCallsignInfo.c.

◆ m_bIsAssignedRandomly

bool SCR_FactionCallsignInfo::m_bIsAssignedRandomly

protected

Definition at line 8 of file SCR_FactionCallsignInfo.c.

◆ m_iCompanyOverflowIndex

int SCR_FactionCallsignInfo::m_iCompanyOverflowIndex

protected

Definition at line 17 of file SCR_FactionCallsignInfo.c.

◆ m_sCallsignCharacterFormat

LocalizedString SCR_FactionCallsignInfo::m_sCallsignCharacterFormat

protected

Definition at line 29 of file SCR_FactionCallsignInfo.c.

◆ m_sCallsignCharacterWithRoleFormat

LocalizedString SCR_FactionCallsignInfo::m_sCallsignCharacterWithRoleFormat

protected

Definition at line 32 of file SCR_FactionCallsignInfo.c.

◆ m_sCallsignGroupFormat

LocalizedString SCR_FactionCallsignInfo::m_sCallsignGroupFormat

protected

Definition at line 26 of file SCR_FactionCallsignInfo.c.

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

scripts/Game/Callsign/SCR_FactionCallsignInfo.c

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ GetAssignCallsignBasedOnGroupRole()

◆ GetCallsignFormat()

◆ GetCharacterRoleCallsign()

◆ GetCharacterRoleCallsignName()

◆ GetCompanyArray()

◆ GetCompanyCallsignName()

◆ GetCompanyOverflowIndex()

◆ GetGroupRoleSpecificCompanies()

◆ GetIsAssignedRandomly()

◆ GetPlatoonArray()

◆ GetPlatoonCallsignName()

◆ GetRandomCallsign()

◆ GetSquadArray()

◆ GetSquadCallsignName()

Member Data Documentation

◆ m_aCharacterRoleCallsigns

◆ m_aCompanyNames

◆ m_aGroupRoleSpecificCallsigns

◆ m_aPlatoonNames

◆ m_aSquadNames

◆ m_bAssignCallsignBasedOnGroupRole

◆ m_bIsAssignedRandomly

◆ m_iCompanyOverflowIndex

◆ m_sCallsignCharacterFormat

◆ m_sCallsignCharacterWithRoleFormat

◆ m_sCallsignGroupFormat