SCR_PlayerCallsignData Interface Reference

Callsign Info. More...

Public Member Functions
void	SetPlayerCallsignIndexes (int company, int platoon, int squad, int character, ERoleCallsign role)
	Returns player callsigns.
bool	GetPlayerCallsignIndexes (out int company, out int platoon, out int squad, out int character, out ERoleCallsign role)
	Returns player callsigns.

Protected Attributes
int	m_iCompanyIndex = -1
int	m_iPlatoonIndex = -1
int	m_iSquadIndex = -1
int	m_iCharacterNumber = -1
ERoleCallsign	m_eCharacterRole = ERoleCallsign.NONE

Detailed Description

Callsign Info.

used for Company, Platoon and Squad. It currently holds the callsign name

Member Function Documentation

GetPlayerCallsignIndexes()

bool SCR_PlayerCallsignData.GetPlayerCallsignIndexes	(	out int	company,
		out int	platoon,
		out int	squad,
		out int	character,
		out ERoleCallsign	role )

Returns player callsigns.

Parameters

[out]	companyIndex	assigned
[out]	platoonIndex	assigned
[out]	squadIndex	assigned
[out]	character	assigned
[out]	role	assigned

Returns

returns false if callsign was not assigned

SetPlayerCallsignIndexes()

void SCR_PlayerCallsignData.SetPlayerCallsignIndexes	(	int	company,
		int	platoon,
		int	squad,
		int	character,
		ERoleCallsign	role )

Returns player callsigns.

Parameters

[out]	companyIndex	assigned
[out]	platoonIndex	assigned
[out]	squadIndex	assigned
[out]	character	assigned
[out]	role	assigned

Returns

returns false if callsign was not assigned

Member Data Documentation

m_eCharacterRole

ERoleCallsign SCR_PlayerCallsignData.m_eCharacterRole = ERoleCallsign.NONE

protected

m_iCharacterNumber

int SCR_PlayerCallsignData.m_iCharacterNumber = -1

protected

m_iCompanyIndex

int SCR_PlayerCallsignData.m_iCompanyIndex = -1

protected

m_iPlatoonIndex

int SCR_PlayerCallsignData.m_iPlatoonIndex = -1

protected

m_iSquadIndex

int SCR_PlayerCallsignData.m_iSquadIndex = -1

protected

---

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

• Game/Callsign/SCR_PlayerCallsignData.c