SCR_CoverageRadioComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_CoverageRadioComponentClass

Functions
SCR_CoverageRadioComponentClass ScriptedRadioComponentClass	Attribute ("0", desc:"Source radio generates the radio signal. Should be limited to one per faction.", category:"Coverage")
	Determinates if the owner entity is covered by the radio signal eminating from the component marked as Source with the same encryption key.
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	OnCoverageChanged ()
void	Ping (string encryptionKey, bool signalSignature, bool reverse=false)
override void	OnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
	Editable Mine.
override void	OnDelete (IEntity owner)

Variables
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 = {}

Function Documentation

AddRadioInRange()

void AddRadioInRange ( notnull SCR_CoverageRadioComponent component )

protected

Definition at line 165 of file SCR_CoverageRadioComponent.c.

AddRadioInRangeOf()

void AddRadioInRangeOf ( notnull SCR_CoverageRadioComponent component )

protected

Definition at line 185 of file SCR_CoverageRadioComponent.c.

Attribute()

SCR_CoverageRadioComponentClass ScriptedRadioComponentClass Attribute	(	"0"	,
		desc:"Source radio generates the radio signal. Should be limited to one per faction."	,
		category:"Coverage"	)

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

Definition at line 1 of file SCR_CoverageRadioComponent.c.

ConnectedRadiosContain()

bool ConnectedRadiosContain ( notnull SCR_CoverageRadioComponent radio, bool inMyRange )

protected

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

Definition at line 138 of file SCR_CoverageRadioComponent.c.

FinishCoverageUpdate()

void FinishCoverageUpdate ( string encryptionKey )

protected

Definition at line 64 of file SCR_CoverageRadioComponent.c.

GetCoverageByEncryption()

SCR_ERadioCoverageStatus GetCoverageByEncryption ( string encryptionKey )

protected

Definition at line 159 of file SCR_CoverageRadioComponent.c.

GetOnCoverageChanged()

ScriptInvokerVoid GetOnCoverageChanged ( )

protected

Definition at line 239 of file SCR_CoverageRadioComponent.c.

GetRadiosInRange()

void GetRadiosInRange ( notnull array< SCR_CoverageRadioComponent > radios )

protected

Definition at line 77 of file SCR_CoverageRadioComponent.c.

GetRadiosInRangeCount()

int GetRadiosInRangeCount ( string encryptionFilter = "" )

protected

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

Definition at line 91 of file SCR_CoverageRadioComponent.c.

GetRadiosInRangeOf()

void GetRadiosInRangeOf ( notnull array< SCR_CoverageRadioComponent > radios )

protected

Definition at line 83 of file SCR_CoverageRadioComponent.c.

GetRadiosInRangeOfCount()

int GetRadiosInRangeOfCount ( string encryptionFilter = "" )

protected

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

Definition at line 114 of file SCR_CoverageRadioComponent.c.

GetSavedEncryption()

string GetSavedEncryption ( )

protected

Definition at line 153 of file SCR_CoverageRadioComponent.c.

GetSavedRange()

float GetSavedRange ( )

protected

Definition at line 147 of file SCR_CoverageRadioComponent.c.

IsSource()

bool IsSource ( )

protected

Definition at line 40 of file SCR_CoverageRadioComponent.c.

OnCoverageChanged()

void OnCoverageChanged ( )

protected

Definition at line 248 of file SCR_CoverageRadioComponent.c.

OnDelete()

override void OnDelete ( IEntity owner )

protected

Definition at line 356 of file SCR_CoverageRadioComponent.c.

OnEncryptionChanged()

void OnEncryptionChanged ( string newEncryptionKey )

protected

Definition at line 233 of file SCR_CoverageRadioComponent.c.

OnPowerToggle()

void OnPowerToggle ( bool powered )

protected

Definition at line 205 of file SCR_CoverageRadioComponent.c.

OnRangeChanged()

void OnRangeChanged ( float newRange )

protected

Definition at line 227 of file SCR_CoverageRadioComponent.c.

Ping()

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

protected

Definition at line 275 of file SCR_CoverageRadioComponent.c.

PrepareCoverageUpdate()

void PrepareCoverageUpdate ( string encryptionKey, bool signature )

protected

Definition at line 52 of file SCR_CoverageRadioComponent.c.

RemoveRadioInRange()

void RemoveRadioInRange ( notnull SCR_CoverageRadioComponent component )

protected

Definition at line 174 of file SCR_CoverageRadioComponent.c.

RemoveRadioInRangeOf()

void RemoveRadioInRangeOf ( notnull SCR_CoverageRadioComponent component )

protected

Definition at line 194 of file SCR_CoverageRadioComponent.c.

SetIsSource()

void SetIsSource ( bool isSource )

protected

Definition at line 34 of file SCR_CoverageRadioComponent.c.

WasPowered()

bool WasPowered ( )

protected

Definition at line 46 of file SCR_CoverageRadioComponent.c.

Variable Documentation

m_aEncryptionKeyCoverReceive

ref array<string> m_aEncryptionKeyCoverReceive = {}

protected

Definition at line 31 of file SCR_CoverageRadioComponent.c.

m_aEncryptionKeyCoverSend

ref array<string> m_aEncryptionKeyCoverSend = {}

protected

Definition at line 28 of file SCR_CoverageRadioComponent.c.

m_aInRangeOfRadios

ref array<SCR_CoverageRadioComponent> m_aInRangeOfRadios = {}

protected

Definition at line 23 of file SCR_CoverageRadioComponent.c.

m_mCoverage

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

protected

Definition at line 25 of file SCR_CoverageRadioComponent.c.