Класс MessageReceiverBase

Граф наследования:MessageReceiverBase:

Закрытые члены
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)

Закрытые данные
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

Подробное описание

Конструктор(ы)

MessageReceiverBase()

void MessageReceiverBase ( )

inlineprivate

    {
        m_ModuleMessageManager = PluginMessageManager.Cast(GetPlugin(PluginMessageManager));
    }

Перекрестные ссылки GetPlugin() и m_ModuleMessageManager.

Методы

BitToDec()

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

inlineprivate

    {
        int value = mask & (GetCompareMask() << index);
        value = value >> index;
        return value;
    }

Broadcast()

void Broadcast ( int channel )

inlineprivate

    {
        m_ModuleMessageManager.Broadcast(channel);
    }

Перекрестные ссылки m_ModuleMessageManager.

BroadcastFloat()

void BroadcastFloat ( int channel, float value )

inlineprivate

    {
        m_ModuleMessageManager.BroadcastFloat(channel, value);
    }

Перекрестные ссылки m_ModuleMessageManager.

BroadcastInt()

void BroadcastInt ( int channel, int value )

inlineprivate

    {
        m_ModuleMessageManager.BroadcastInt(channel, value);
    }

Перекрестные ссылки m_ModuleMessageManager.

BroadcastParam()

void BroadcastParam ( int channel, Param params )

inlineprivate

    {
        m_ModuleMessageManager.BroadcastParam(channel, params);
    }

Перекрестные ссылки m_ModuleMessageManager.

BroadcastString()

void BroadcastString ( int channel, string value )

inlineprivate

    {
        m_ModuleMessageManager.BroadcastString(channel, value);
    }

Перекрестные ссылки m_ModuleMessageManager.

DisplayElementBase()

void DisplayElementBase ( PlayerBase player )

inlineprivate

    {
        m_System = "VirtualHud";
        m_ModulePlayerStatus = PluginPlayerStatus.Cast(GetPlugin(PluginPlayerStatus));
        m_Player = player;
        //SetMaxValue();
    }

Перекрестные ссылки GetPlugin(), m_ModulePlayerStatus, m_Player и m_System.

GetCompareMask()

int GetCompareMask ( )

inlineprivate

    {
        int mask = Math.Pow(2, GetNumberOfBits() ) - 1;
        return mask;
    }

Перекрестные ссылки Math::Pow().

GetNumberOfBits()

int GetNumberOfBits ( )

inlineprivate

    {
        return NUM_OF_BITS;
    }

GetType()

int GetType ( )

inlineprivate

    {
        return m_Type;
    }

Перекрестные ссылки m_Type.

GetValue()

int GetValue ( )

inlineprivate

    {
        return m_Value;
    }

Перекрестные ссылки m_Value.

IsClientOnly()

bool IsClientOnly ( )

inlineprivate

    {
        return m_IsClientOnly;
    }

IsValueChanged()

bool IsValueChanged ( )

inlineprivate

    {
        return !(m_Value == m_ValueLast);
    }

Перекрестные ссылки m_Value.

Log()

void Log ( string message )

inlineprivate

    {
        Debug.Log(message,m_System);
    }

Перекрестные ссылки Debug::Log() и m_System.

OnReceive()

void OnReceive ( int channel )

inlineprivate

{}

OnReceiveFloat()

void OnReceiveFloat ( int channel, float value )

inlineprivate

{}

OnReceiveInt()

void OnReceiveInt ( int channel, int value )

inlineprivate

{}

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

    {
        m_Value = value;
        if (range != 0 )
        {
            m_Range = range;
        }
    }

Перекрестные ссылки m_Value.

Subscribe()

void Subscribe ( int channel )

inlineprivate

    {
        m_ModuleMessageManager.Subscribe(this,channel);
    }

Перекрестные ссылки m_ModuleMessageManager.

TranslateLevelToStatus()

int TranslateLevelToStatus ( int level )

inlineprivate

    {
        if( level == DSLevels.WARNING )
            return 2;
        if( level == DSLevels.CRITICAL )
            return 3;
        if( level == DSLevels.BLINKING )
            return 4;
        if( level == DSLevels.EXTRA )
            return 5;
        return 1;
    }

Unsubscribe()

void Unsubscribe ( int channel )

inlineprivate

    {
        if( IsPluginManagerExists() ) m_ModuleMessageManager.Unsubscribe(this,channel);
    }

Перекрестные ссылки IsPluginManagerExists() и m_ModuleMessageManager.

UnsubscribeAll()

void UnsubscribeAll ( )

inlineprivate

    {
        if( IsPluginManagerExists() ) m_ModuleMessageManager.UnsubscribeAll(this);
    }

Перекрестные ссылки IsPluginManagerExists() и m_ModuleMessageManager.

UpdateHUD()

void UpdateHUD ( )

inlineprivate

    {
        m_ValueLast = m_Value;
    }

Перекрестные ссылки m_Value.

Поля

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

Используется в Broadcast(), BroadcastFloat(), BroadcastInt(), BroadcastParam(), BroadcastString(), MessageReceiverBase(), Subscribe(), Unsubscribe() и 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

Используется в 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

---

Объявления и описания членов классов находятся в файлах:

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