SCR_PlayerCallsignData Class Reference

Protected Member Functions
void	SetPlayerCallsignIndexes (int company, int platoon, int squad, int character, ERoleCallsign role)
bool	GetPlayerCallsignIndexes (out int company, out int platoon, out int squad, out int character, out ERoleCallsign role)

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

Definition at line 4 of file SCR_PlayerCallsignData.c.

Member Function Documentation

GetPlayerCallsignIndexes()

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

inlineprotected

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

Definition at line 39 of file SCR_PlayerCallsignData.c.

SetPlayerCallsignIndexes()

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

inlineprotected

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

Definition at line 21 of file SCR_PlayerCallsignData.c.

Member Data Documentation

m_eCharacterRole

ERoleCallsign SCR_PlayerCallsignData::m_eCharacterRole = ERoleCallsign.NONE

protected

Definition at line 10 of file SCR_PlayerCallsignData.c.

m_iCharacterNumber

int SCR_PlayerCallsignData::m_iCharacterNumber = -1

protected

Definition at line 9 of file SCR_PlayerCallsignData.c.

m_iCompanyIndex

int SCR_PlayerCallsignData::m_iCompanyIndex = -1

protected

Definition at line 6 of file SCR_PlayerCallsignData.c.

m_iPlatoonIndex

int SCR_PlayerCallsignData::m_iPlatoonIndex = -1

protected

Definition at line 7 of file SCR_PlayerCallsignData.c.

m_iSquadIndex

int SCR_PlayerCallsignData::m_iSquadIndex = -1

protected

Definition at line 8 of file SCR_PlayerCallsignData.c.

---

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

• scripts/Game/Callsign/SCR_PlayerCallsignData.c