BaseRadioComponent Interface Reference

Inheritance diagram for BaseRadioComponent:

Public Member Functions
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 ()
proto external bool	IsEditorRadio ()
proto external void	SetTransceiverFrequency (BaseTransceiver transceiver, int freq)
	Set frequency of transceiver and sync with server.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Public Attributes
ref ScriptInvoker< BaseTransceiver, int, int >	m_OnTansceiverFrequencyChangedInvoker = new ScriptInvoker<BaseTransceiver, int, int>()
ref ScriptInvoker< BaseTransceiver, float, float >	m_OnTansceiverRangeChangedInvoker = new ScriptInvoker<BaseTransceiver, float, float>()
ref ScriptInvoker< bool >	m_OnPowerChanged = new ScriptInvoker<bool>()
ref ScriptInvoker< string >	m_OnEncryptionKeyChanged = new ScriptInvoker<string>()

Protected Member Functions
void	OnTansceiverFrequencyChanged (BaseTransceiver transceiver, int oldFreq, int newFreq)
	Event invoked on client and server when frequency is changed.
void	OnTansceiverRangeChanged (BaseTransceiver transceiver, float oldRange, float newRange)
	Event invoked on client and server when range is changed.
void	OnPowerChanged (bool powered)
	Event invoked on client and server when power is changed.
void	OnEncryptionKeyChanged (string newKey)
	Event invoked on client and server when encryption key is changed.

Member Function Documentation

GetEncryptionKey()

proto external string BaseRadioComponent.GetEncryptionKey

(

)

Returns

Key used for transmission encryption

GetOwner()

proto external IEntity BaseRadioComponent.GetOwner

(

)

Returns

Entity this component is atached to.

GetTransceiver()

proto external BaseTransceiver BaseRadioComponent.GetTransceiver

(

int

idx

)

Returns

Transceiver with given index.

IsEditorRadio()

proto external bool BaseRadioComponent.IsEditorRadio

(

)

IsPowered()

proto external bool BaseRadioComponent.IsPowered

(

)

Returns

Power state of whole radio

OnEncryptionKeyChanged()

void BaseRadioComponent.OnEncryptionKeyChanged ( string newKey )

protected

Event invoked on client and server when encryption key is changed.

OnPowerChanged()

void BaseRadioComponent.OnPowerChanged ( bool powered )

protected

Event invoked on client and server when power is changed.

OnTansceiverFrequencyChanged()

void BaseRadioComponent.OnTansceiverFrequencyChanged ( BaseTransceiver transceiver, int oldFreq, int newFreq )

protected

Event invoked on client and server when frequency is changed.

OnTansceiverRangeChanged()

void BaseRadioComponent.OnTansceiverRangeChanged ( BaseTransceiver transceiver, float oldRange, float newRange )

protected

Event invoked on client and server when range is changed.

SetEncryptionKey()

proto external void BaseRadioComponent.SetEncryptionKey

(

string

key

)

Parameters

key	Key used for transmission encryption

SetPower()

proto external void BaseRadioComponent.SetPower

(

bool

powered

)

Sets the power state of whole radio.

SetTransceiverFrequency()

proto external void BaseRadioComponent.SetTransceiverFrequency	(	BaseTransceiver	transceiver,
		int	freq )

Set frequency of transceiver and sync with server.

TransceiversCount()

proto external int BaseRadioComponent.TransceiversCount

(

)

Returns

Number of transceivers.

Member Data Documentation

m_OnEncryptionKeyChanged

ref ScriptInvoker<string> BaseRadioComponent.m_OnEncryptionKeyChanged = new ScriptInvoker<string>()

m_OnPowerChanged

ref ScriptInvoker<bool> BaseRadioComponent.m_OnPowerChanged = new ScriptInvoker<bool>()

m_OnTansceiverFrequencyChangedInvoker

ref ScriptInvoker<BaseTransceiver, int, int> BaseRadioComponent.m_OnTansceiverFrequencyChangedInvoker = new ScriptInvoker<BaseTransceiver, int, int>()

m_OnTansceiverRangeChangedInvoker

ref ScriptInvoker<BaseTransceiver, float, float> BaseRadioComponent.m_OnTansceiverRangeChangedInvoker = new ScriptInvoker<BaseTransceiver, float, float>()

---

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

• Game/generated/Components/BaseRadioComponent.c