SCR_CampaignRadioMsg Interface Reference

Inheritance diagram for SCR_CampaignRadioMsg:

Public Member Functions
void	SetRadioMsg (SCR_ERadioMsg msg)
void	SetFactionId (int factionId)
void	SetBaseCallsign (int callsign)
void	SetCallerCallsign (int companyID, int platoonID, int squadID, int characterID)
void	SetCalledCallsign (int companyID, int platoonID, int squadID, int characterID)
void	SetIsPublic (bool public)
void	SetParam (int param)
void	SetPlayerID (int playerID)
void	SetMessageForCommander (bool isMessageForCommander, notnull SCR_Faction faction)
float	GetSeed ()
override void	OnDelivery (BaseTransceiver receiver, int freq, float quality)
	Called upon delivery of the message.
Public Member Functions inherited from BaseRadioMessage
proto external string	GetEncryptionKey ()
	Encryption key used to encrypt message.
proto external void	SetEncryptionKey (string key)
	Sets encryption of the message to given string.

Static Public Attributes
static const int	INVALID_RADIO_MSG_PARAM = -1

Protected Attributes
SCR_ERadioMsg	m_iRadioMsg
int	m_iFactionId
int	m_iBaseCallsign = SCR_MilitaryBaseComponent.INVALID_BASE_CALLSIGN
int	m_iCallerCompanyID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX
int	m_iCallerPlatoonID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX
int	m_iCallerSquadID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX
int	m_iCallerCharacterID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX
int	m_iCalledCompanyID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX
int	m_iCalledPlatoonID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX
int	m_iCalledSquadID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX
int	m_iCalledCharacterID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX
float	m_fSeed = Math.RandomFloat01()
bool	m_bIsPublic = true
int	m_iParam = INVALID_RADIO_MSG_PARAM
int	m_iPlayerID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX
bool	m_bIsMessageForCommander
SCR_Faction	m_Faction

Member Function Documentation

GetSeed()

float SCR_CampaignRadioMsg.GetSeed

(

)

OnDelivery()

override void SCR_CampaignRadioMsg.OnDelivery	(	BaseTransceiver	receiver,
		int	freq,
		float	quality )

Called upon delivery of the message.

Implements ScriptedRadioMessage.

SetBaseCallsign()

void SCR_CampaignRadioMsg.SetBaseCallsign

(

int

callsign

)

SetCalledCallsign()

void SCR_CampaignRadioMsg.SetCalledCallsign	(	int	companyID,
		int	platoonID,
		int	squadID,
		int	characterID )

SetCallerCallsign()

void SCR_CampaignRadioMsg.SetCallerCallsign	(	int	companyID,
		int	platoonID,
		int	squadID,
		int	characterID )

SetFactionId()

void SCR_CampaignRadioMsg.SetFactionId

(

int

factionId

)

SetIsPublic()

void SCR_CampaignRadioMsg.SetIsPublic

(

bool

public

)

SetMessageForCommander()

void SCR_CampaignRadioMsg.SetMessageForCommander	(	bool	isMessageForCommander,
		notnull SCR_Faction	faction )

Parameters

[in]	isMessageForCommander
[in]	faction

SetParam()

void SCR_CampaignRadioMsg.SetParam

(

int

param

)

SetPlayerID()

void SCR_CampaignRadioMsg.SetPlayerID

(

int

playerID

)

SetRadioMsg()

void SCR_CampaignRadioMsg.SetRadioMsg

(

SCR_ERadioMsg

msg

)

Member Data Documentation

INVALID_RADIO_MSG_PARAM

const int SCR_CampaignRadioMsg.INVALID_RADIO_MSG_PARAM = -1

static

m_bIsMessageForCommander

bool SCR_CampaignRadioMsg.m_bIsMessageForCommander

protected

m_bIsPublic

bool SCR_CampaignRadioMsg.m_bIsPublic = true

protected

m_Faction

SCR_Faction SCR_CampaignRadioMsg.m_Faction

protected

m_fSeed

float SCR_CampaignRadioMsg.m_fSeed = Math.RandomFloat01()

protected

m_iBaseCallsign

int SCR_CampaignRadioMsg.m_iBaseCallsign = SCR_MilitaryBaseComponent.INVALID_BASE_CALLSIGN

protected

m_iCalledCharacterID

int SCR_CampaignRadioMsg.m_iCalledCharacterID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX

protected

m_iCalledCompanyID

int SCR_CampaignRadioMsg.m_iCalledCompanyID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX

protected

m_iCalledPlatoonID

int SCR_CampaignRadioMsg.m_iCalledPlatoonID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX

protected

m_iCalledSquadID

int SCR_CampaignRadioMsg.m_iCalledSquadID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX

protected

m_iCallerCharacterID

int SCR_CampaignRadioMsg.m_iCallerCharacterID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX

protected

m_iCallerCompanyID

int SCR_CampaignRadioMsg.m_iCallerCompanyID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX

protected

m_iCallerPlatoonID

int SCR_CampaignRadioMsg.m_iCallerPlatoonID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX

protected

m_iCallerSquadID

int SCR_CampaignRadioMsg.m_iCallerSquadID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX

protected

m_iFactionId

int SCR_CampaignRadioMsg.m_iFactionId

protected

m_iParam

int SCR_CampaignRadioMsg.m_iParam = INVALID_RADIO_MSG_PARAM

protected

m_iPlayerID

int SCR_CampaignRadioMsg.m_iPlayerID = SCR_CampaignMilitaryBaseComponent.INVALID_PLAYER_INDEX

protected

m_iRadioMsg

SCR_ERadioMsg SCR_CampaignRadioMsg.m_iRadioMsg

protected

---

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

• Game/Entities/Campaign/SCR_CampaignRadioMsg.c