MessageReceiverBase Class Reference

Private Member Functions
void	OnReceive (int channel)
void	OnReceiveInt (int channel, int value)
void	OnReceiveFloat (int channel, float value)
void	OnReceiveString (int channel, string value)
void	OnReceiveParam (int channel, Param params)
	This method is called when an object inheriting from this class subscribes to a channel, and a message along with an object reference is broadcast on that channel, if the object was created just for the purpose of relaying information and is not referenced anywhere else, it should be deleted after processing inside this method.
void	MessageReceiverBase ()
void	Subscribe (int channel)
void	Unsubscribe (int channel)
void	UnsubscribeAll ()
void	Broadcast (int channel)
void	BroadcastInt (int channel, int value)
void	BroadcastFloat (int channel, float value)
void	BroadcastString (int channel, string value)
void	BroadcastParam (int channel, Param params)
void	Log (string message)
void	DisplayElementBase (PlayerBase player)
bool	IsClientOnly ()
bool	IsValueChanged ()
void	UpdateHUD ()
int	GetNumberOfBits ()
void	SetValue (int value, int range=0)
int	GetValue ()
int	BitToDec (int mask, int index, int length)
int	GetCompareMask ()
int	GetType ()
int	TranslateLevelToStatus (int level)

Private Attributes
PluginMessageManager	m_ModuleMessageManager
string	m_System
int	m_Value
int	m_ValueLast = -99999
int	m_Key = 0
int	m_Type = 0
int	m_Range = 0
int	m_Colors [7]
string	m_Labels [7]
int	m_Pos = 1
int	NUM_OF_BITS
bool	m_IsClientOnly = false
PlayerBase	m_Player
PluginPlayerStatus	m_ModulePlayerStatus

Constructor & Destructor Documentation

MessageReceiverBase()

void MessageReceiverBase ( )

inlineprivate

References GetPlugin(), and m_ModuleMessageManager.

Member Function Documentation

BitToDec()

int BitToDec ( int  mask, int  index, int  length  )

inlineprivate

Broadcast()

void Broadcast ( int  channel )

inlineprivate

References m_ModuleMessageManager.

BroadcastFloat()

void BroadcastFloat ( int  channel, float  value  )

inlineprivate

References m_ModuleMessageManager.

BroadcastInt()

void BroadcastInt ( int  channel, int  value  )

inlineprivate

References m_ModuleMessageManager.

BroadcastParam()

void BroadcastParam ( int  channel, Param  params  )

inlineprivate

References m_ModuleMessageManager.

BroadcastString()

void BroadcastString ( int  channel, string  value  )

inlineprivate

References m_ModuleMessageManager.

DisplayElementBase()

void DisplayElementBase ( PlayerBase  player )

inlineprivate

References GetPlugin(), m_ModulePlayerStatus, m_Player, and m_System.

GetCompareMask()

int GetCompareMask ( )

inlineprivate

References Math::Pow().

GetNumberOfBits()

int GetNumberOfBits ( )

inlineprivate

GetType()

int GetType ( )

inlineprivate

References m_Type.

GetValue()

int GetValue ( )

inlineprivate

References m_Value.

IsClientOnly()

bool IsClientOnly ( )

inlineprivate

IsValueChanged()

bool IsValueChanged ( )

inlineprivate

References m_Value.

Log()

void Log ( string  message )

inlineprivate

References Debug::Log(), and m_System.

OnReceive()

void OnReceive ( int  channel )

inlineprivate

Referenced by PluginBase::Broadcast().

OnReceiveFloat()

void OnReceiveFloat ( int  channel, float  value  )

inlineprivate

Referenced by PluginBase::BroadcastFloat().

OnReceiveInt()

void OnReceiveInt ( int  channel, int  value  )

inlineprivate

Referenced by PluginBase::BroadcastInt().

OnReceiveParam()

void OnReceiveParam ( int  channel, Param  params  )

inlineprivate

This method is called when an object inheriting from this class subscribes to a channel, and a message along with an object reference is broadcast on that channel, if the object was created just for the purpose of relaying information and is not referenced anywhere else, it should be deleted after processing inside this method.

OnReceiveString()

void OnReceiveString ( int  channel, string  value  )

inlineprivate

SetValue()

void SetValue ( int  value, int  range = 0  )

inlineprivate

References m_Value.

Subscribe()

void Subscribe ( int  channel )

inlineprivate

References m_ModuleMessageManager.

TranslateLevelToStatus()

int TranslateLevelToStatus ( int  level )

inlineprivate

Unsubscribe()

void Unsubscribe ( int  channel )

inlineprivate

References IsPluginManagerExists(), and m_ModuleMessageManager.

UnsubscribeAll()

void UnsubscribeAll ( )

inlineprivate

References IsPluginManagerExists(), and m_ModuleMessageManager.

UpdateHUD()

void UpdateHUD ( )

inlineprivate

References m_Value.

Field Documentation

m_Colors

int m_Colors[7]

private

m_IsClientOnly

bool m_IsClientOnly = false

private

m_Key

int m_Key = 0

private

m_Labels

string m_Labels[7]

private

m_ModuleMessageManager

PluginMessageManager m_ModuleMessageManager

private

Referenced by Broadcast(), BroadcastFloat(), BroadcastInt(), BroadcastParam(), BroadcastString(), MessageReceiverBase(), Subscribe(), Unsubscribe(), and UnsubscribeAll().

m_ModulePlayerStatus

PluginPlayerStatus m_ModulePlayerStatus

private

m_Player

PlayerBase m_Player

private

m_Pos

int m_Pos = 1

private

m_Range

int m_Range = 0

private

m_System

string m_System

private

Referenced by Log().

m_Type

int m_Type = 0

private

m_Value

int m_Value

private

m_ValueLast

int m_ValueLast = -99999

private

NUM_OF_BITS

int NUM_OF_BITS

private

---

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

• P:/scripts/4_World/Classes/MessageReceiverBase.c
• P:/scripts/4_World/Classes/VirtualHud/DisplayElementBase.c