SCR_CoverageRadioComponent Interface Reference

Determinates if the owner entity is covered by the radio signal eminating from the component marked as Source with the same encryption key. More...

Inheritance diagram for SCR_CoverageRadioComponent:

Public Member Functions
void	SetIsSource (bool isSource)
bool	IsSource ()
bool	WasPowered ()
void	PrepareCoverageUpdate (string encryptionKey, bool signature)
void	FinishCoverageUpdate (string encryptionKey)
void	GetRadiosInRange (notnull array< SCR_CoverageRadioComponent > radios)
void	GetRadiosInRangeOf (notnull array< SCR_CoverageRadioComponent > radios)
int	GetRadiosInRangeCount (string encryptionFilter="")
	Returns the amount of radios which are covered by this radio's signal.
int	GetRadiosInRangeOfCount (string encryptionFilter="")
	Returns the amount of radios which are covering this radio with their signal.
bool	ConnectedRadiosContain (notnull SCR_CoverageRadioComponent radio, bool inMyRange)
	Returns true if the provided radio is covered by this radio or vice versa, depending on the direction parameter.
float	GetSavedRange ()
string	GetSavedEncryption ()
SCR_ERadioCoverageStatus	GetCoverageByEncryption (string encryptionKey)
void	AddRadioInRange (notnull SCR_CoverageRadioComponent component)
void	RemoveRadioInRange (notnull SCR_CoverageRadioComponent component)
void	AddRadioInRangeOf (notnull SCR_CoverageRadioComponent component)
void	RemoveRadioInRangeOf (notnull SCR_CoverageRadioComponent component)
void	OnPowerToggle (bool powered)
void	OnRangeChanged (float newRange)
void	OnEncryptionChanged (string newEncryptionKey)
ScriptInvokerVoid	GetOnCoverageChanged ()
void	Ping (string encryptionKey, bool signalSignature, bool reverse=false)
override void	OnInit (IEntity owner)
	Called during EOnInit.
override void	OnPostInit (IEntity owner)
	Called after all components are initialized.
void	~SCR_CoverageRadioComponent ()
Public Member Functions inherited from ScriptedRadioComponent
void	OnPostInit (IEntity owner)
	Called after all components are initialized.
void	OnInit (IEntity owner)
	Called during EOnInit.
void	OnFrame (IEntity owner, float timeSlice)
	Called during EOnFrame.
Public Member Functions inherited from BaseRadioComponent
proto external IEntity	GetOwner ()
proto external int	TransceiversCount ()
proto external BaseTransceiver	GetTransceiver (int idx)
proto external void	SetEncryptionKey (string key)
proto external string	GetEncryptionKey ()
proto external void	SetPower (bool powered)
	Sets the power state of whole radio.
proto external bool	IsPowered ()
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Protected Member Functions
void	OnCoverageChanged ()

Protected Attributes
bool	m_bIsSource
bool	m_bWasPowered = true
bool	m_bLastSignalSignature
bool	m_bCouldSend
bool	m_bCouldReceive
float	m_fSavedRange
string	m_sSavedEncryptionKey
ref ScriptInvokerVoid	m_OnCoverageChanged
ref array< SCR_CoverageRadioComponent >	m_aRadiosInRange = {}
ref array< SCR_CoverageRadioComponent >	m_aInRangeOfRadios = {}
ref map< string, SCR_ERadioCoverageStatus >	m_mCoverage = new map<string, SCR_ERadioCoverageStatus>()
ref array< string >	m_aEncryptionKeyCoverSend = {}
ref array< string >	m_aEncryptionKeyCoverReceive = {}

Detailed Description

Determinates if the owner entity is covered by the radio signal eminating from the component marked as Source with the same encryption key.

Constructor & Destructor Documentation

~SCR_CoverageRadioComponent()

void SCR_CoverageRadioComponent.~SCR_CoverageRadioComponent

(

)

Member Function Documentation

AddRadioInRange()

void SCR_CoverageRadioComponent.AddRadioInRange

(

notnull SCR_CoverageRadioComponent

component

)

AddRadioInRangeOf()

void SCR_CoverageRadioComponent.AddRadioInRangeOf

(

notnull SCR_CoverageRadioComponent

component

)

ConnectedRadiosContain()

bool SCR_CoverageRadioComponent.ConnectedRadiosContain	(	notnull SCR_CoverageRadioComponent	radio,
		bool	inMyRange
	)

Returns true if the provided radio is covered by this radio or vice versa, depending on the direction parameter.

FinishCoverageUpdate()

void SCR_CoverageRadioComponent.FinishCoverageUpdate

(

string

encryptionKey

)

GetCoverageByEncryption()

SCR_ERadioCoverageStatus SCR_CoverageRadioComponent.GetCoverageByEncryption

(

string

encryptionKey

)

GetOnCoverageChanged()

ScriptInvokerVoid SCR_CoverageRadioComponent.GetOnCoverageChanged

(

)

GetRadiosInRange()

void SCR_CoverageRadioComponent.GetRadiosInRange

(

notnull array< SCR_CoverageRadioComponent >

radios

)

GetRadiosInRangeCount()

int SCR_CoverageRadioComponent.GetRadiosInRangeCount

(

string

encryptionFilter = ""

)

Returns the amount of radios which are covered by this radio's signal.

GetRadiosInRangeOf()

void SCR_CoverageRadioComponent.GetRadiosInRangeOf

(

notnull array< SCR_CoverageRadioComponent >

radios

)

GetRadiosInRangeOfCount()

int SCR_CoverageRadioComponent.GetRadiosInRangeOfCount

(

string

encryptionFilter = ""

)

Returns the amount of radios which are covering this radio with their signal.

GetSavedEncryption()

string SCR_CoverageRadioComponent.GetSavedEncryption

(

)

GetSavedRange()

float SCR_CoverageRadioComponent.GetSavedRange

(

)

IsSource()

bool SCR_CoverageRadioComponent.IsSource

(

)

OnCoverageChanged()

void SCR_CoverageRadioComponent.OnCoverageChanged ( )

protected

OnEncryptionChanged()

void SCR_CoverageRadioComponent.OnEncryptionChanged

(

string

newEncryptionKey

)

OnInit()

override void SCR_CoverageRadioComponent.OnInit

(

IEntity

owner

)

Called during EOnInit.

Parameters

owner

Entity this component is attached to.

Implements ScriptedRadioComponent.

OnPostInit()

override void SCR_CoverageRadioComponent.OnPostInit

(

IEntity

owner

)

Called after all components are initialized.

Parameters

owner

Entity this component is attached to.

Implements ScriptedRadioComponent.

OnPowerToggle()

void SCR_CoverageRadioComponent.OnPowerToggle

(

bool

powered

)

OnRangeChanged()

void SCR_CoverageRadioComponent.OnRangeChanged

(

float

newRange

)

Ping()

void SCR_CoverageRadioComponent.Ping	(	string	encryptionKey,
		bool	signalSignature,
		bool	reverse = false
	)

PrepareCoverageUpdate()

void SCR_CoverageRadioComponent.PrepareCoverageUpdate	(	string	encryptionKey,
		bool	signature
	)

RemoveRadioInRange()

void SCR_CoverageRadioComponent.RemoveRadioInRange

(

notnull SCR_CoverageRadioComponent

component

)

RemoveRadioInRangeOf()

void SCR_CoverageRadioComponent.RemoveRadioInRangeOf

(

notnull SCR_CoverageRadioComponent

component

)

SetIsSource()

void SCR_CoverageRadioComponent.SetIsSource

(

bool

isSource

)

WasPowered()

bool SCR_CoverageRadioComponent.WasPowered

(

)

Member Data Documentation

m_aEncryptionKeyCoverReceive

ref array<string> SCR_CoverageRadioComponent.m_aEncryptionKeyCoverReceive = {}

protected

m_aEncryptionKeyCoverSend

ref array<string> SCR_CoverageRadioComponent.m_aEncryptionKeyCoverSend = {}

protected

m_aInRangeOfRadios

ref array<SCR_CoverageRadioComponent> SCR_CoverageRadioComponent.m_aInRangeOfRadios = {}

protected

m_aRadiosInRange

ref array<SCR_CoverageRadioComponent> SCR_CoverageRadioComponent.m_aRadiosInRange = {}

protected

m_bCouldReceive

bool SCR_CoverageRadioComponent.m_bCouldReceive

protected

m_bCouldSend

bool SCR_CoverageRadioComponent.m_bCouldSend

protected

m_bIsSource

bool SCR_CoverageRadioComponent.m_bIsSource

protected

m_bLastSignalSignature

bool SCR_CoverageRadioComponent.m_bLastSignalSignature

protected

m_bWasPowered

bool SCR_CoverageRadioComponent.m_bWasPowered = true

protected

m_fSavedRange

float SCR_CoverageRadioComponent.m_fSavedRange

protected

m_mCoverage

ref map<string, SCR_ERadioCoverageStatus> SCR_CoverageRadioComponent.m_mCoverage = new map<string, SCR_ERadioCoverageStatus>()

protected

m_OnCoverageChanged

ref ScriptInvokerVoid SCR_CoverageRadioComponent.m_OnCoverageChanged

protected

m_sSavedEncryptionKey

string SCR_CoverageRadioComponent.m_sSavedEncryptionKey

protected

---

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

• Game/Components/SCR_CoverageRadioComponent.c