SCR_FactionCallsignInfo Interface Reference

Stores the Callsign information data for the faction. More...

Public Member Functions
string	GetCallsignFormat (bool includeCharacter, int characterRole=-1)
	Get callsign format.
bool	GetIsAssignedRandomly ()
	Get callsign format.
void	GetCompanyArray (notnull array< ref SCR_CallsignInfo > companyArray)
	Get Company array.
void	GetPlatoonArray (notnull array< ref SCR_CallsignInfo > platoonArray)
	Get Platoon array.
void	GetSquadArray (notnull array< ref SCR_CallsignInfo > squadArray)
	Get Squad array.
string	GetCompanyCallsignName (int index)
	Get the company name using index.
int	GetCompanyOverflowIndex ()
	Gets the index at which overflow companies start.
string	GetPlatoonCallsignName (int index)
	Get the Platoon name using index.
string	GetSquadCallsignName (int index)
	Get the Squad name using index.
string	GetCharacterRoleCallsignName (int index)
	Get the character role callsign using index.
bool	GetRandomCallsign (out int company, out int platoon, out int squad)
	Get random call sign.
bool	GetCharacterRoleCallsign (IEntity character, int playerID, SCR_AIGroup group, inout int roleCallsignIndex, out bool isUnique)
	Loops through all availible roles for the faction and grabs the first availible role for that character.

Protected Attributes
bool	m_bIsAssignedRandomly
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

Detailed Description

Stores the Callsign information data for the faction.

Member Function Documentation

GetCallsignFormat()

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

Get callsign format.

Returns

string callsign Format

GetCharacterRoleCallsign()

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

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

GetCharacterRoleCallsignName()

string SCR_FactionCallsignInfo.GetCharacterRoleCallsignName

(

int

index

)

Get the character role callsign using index.

Parameters

index

of character role

Returns

string character role callsign name

GetCompanyArray()

void SCR_FactionCallsignInfo.GetCompanyArray

(

notnull array< ref SCR_CallsignInfo >

companyArray

)

Get Company array.

Returns

array<ref SCR_CallsignInfo> companyArray

GetCompanyCallsignName()

string SCR_FactionCallsignInfo.GetCompanyCallsignName

(

int

index

)

Get the company name using index.

Parameters

index

of company name

Returns

string company name

GetCompanyOverflowIndex()

int SCR_FactionCallsignInfo.GetCompanyOverflowIndex

(

)

Gets the index at which overflow companies start.

Returns

int m_iCompanyOverflowIndex

GetIsAssignedRandomly()

bool SCR_FactionCallsignInfo.GetIsAssignedRandomly

(

)

Get callsign format.

Returns

bool if callsigns are assigned in order or randomly

GetPlatoonArray()

void SCR_FactionCallsignInfo.GetPlatoonArray

(

notnull array< ref SCR_CallsignInfo >

platoonArray

)

Get Platoon array.

Returns

array<ref SCR_CallsignInfo> platoonArray

GetPlatoonCallsignName()

string SCR_FactionCallsignInfo.GetPlatoonCallsignName

(

int

index

)

Get the Platoon name using index.

Parameters

index

of Platoon name

Returns

string Platoon name

GetRandomCallsign()

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

Get random call sign.

Parameters

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

GetSquadArray()

void SCR_FactionCallsignInfo.GetSquadArray

(

notnull array< ref SCR_CallsignInfo >

squadArray

)

Get Squad array.

Returns

array<ref SCR_CallsignInfo> squadArray

GetSquadCallsignName()

string SCR_FactionCallsignInfo.GetSquadCallsignName

(

int

index

)

Get the Squad name using index.

Parameters

index

of Squad name

Returns

string Squad name

Member Data Documentation

m_aCharacterRoleCallsigns

ref array<ref SCR_BaseRoleCallsign> SCR_FactionCallsignInfo.m_aCharacterRoleCallsigns

protected

m_aCompanyNames

ref array<ref SCR_CallsignInfo> SCR_FactionCallsignInfo.m_aCompanyNames

protected

m_aPlatoonNames

ref array<ref SCR_CallsignInfo> SCR_FactionCallsignInfo.m_aPlatoonNames

protected

m_aSquadNames

ref array<ref SCR_CallsignInfo> SCR_FactionCallsignInfo.m_aSquadNames

protected

m_bIsAssignedRandomly

bool SCR_FactionCallsignInfo.m_bIsAssignedRandomly

protected

m_iCompanyOverflowIndex

int SCR_FactionCallsignInfo.m_iCompanyOverflowIndex

protected

m_sCallsignCharacterFormat

LocalizedString SCR_FactionCallsignInfo.m_sCallsignCharacterFormat

protected

m_sCallsignCharacterWithRoleFormat

LocalizedString SCR_FactionCallsignInfo.m_sCallsignCharacterWithRoleFormat

protected

m_sCallsignGroupFormat

LocalizedString SCR_FactionCallsignInfo.m_sCallsignGroupFormat

protected

---

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

• Game/Callsign/SCR_FactionCallsignInfo.c