CMessage Class Reference

#include <Message.h>

Inheritance diagram for CMessage:

Public Member Functions
virtual	~CMessage ()
virtual int	GetType () const =0
virtual const char *	GetScriptHandlerName () const =0
virtual const char *	GetScriptGlobalHandlerName () const =0
virtual JS::Value	ToJSVal (const ScriptRequest &) const =0
JS::Value	ToJSValCached (const ScriptRequest &) const

Protected Member Functions
	CMessage ()

Private Member Functions
	NONCOPYABLE (CMessage)

Private Attributes
std::unique_ptr< JS::PersistentRootedValue >	m_Cached

Constructor & Destructor Documentation

CMessage()

CMessage::CMessage ( )

inlineprotected

~CMessage()

virtual CMessage::~CMessage ( )

inlinevirtual

Member Function Documentation

GetScriptGlobalHandlerName()

virtual const char * CMessage::GetScriptGlobalHandlerName ( ) const

pure virtual

Implemented in CMessageTurnStart, CMessageUpdate, CMessageUpdate_MotionFormation, CMessageUpdate_MotionUnit, CMessageUpdate_Final, CMessageInterpolate, CMessageRenderSubmit, CMessageProgressiveLoad, CMessageDeserialized, CMessageCreate, CMessageDestroy, CMessageOwnershipChanged, CMessagePositionChanged, CMessageInterpolatedPositionChanged, CMessageMotionUpdate, CMessageWaterChanged, CMessageTerrainChanged, CMessageVisibilityChanged, CMessageMovementObstructionChanged, CMessageObstructionMapShapeChanged, CMessageTerritoriesChanged, CMessageRangeUpdate, CMessagePathResult, CMessageValueModification, CMessagePlayerColorChanged, CMessageTemplateModification, CMessageVisionRangeChanged, CMessageVisionSharingChanged, CMessageMinimapPing, CMessageCinemaPathEnded, CMessageCinemaQueueEnded, and CMessageScripted.

GetScriptHandlerName()

virtual const char * CMessage::GetScriptHandlerName ( ) const

pure virtual

Implemented in CMessageTurnStart, CMessageUpdate, CMessageUpdate_MotionFormation, CMessageUpdate_MotionUnit, CMessageUpdate_Final, CMessageInterpolate, CMessageRenderSubmit, CMessageProgressiveLoad, CMessageDeserialized, CMessageCreate, CMessageDestroy, CMessageOwnershipChanged, CMessagePositionChanged, CMessageInterpolatedPositionChanged, CMessageMotionUpdate, CMessageWaterChanged, CMessageTerrainChanged, CMessageVisibilityChanged, CMessageMovementObstructionChanged, CMessageObstructionMapShapeChanged, CMessageTerritoriesChanged, CMessageRangeUpdate, CMessagePathResult, CMessageValueModification, CMessagePlayerColorChanged, CMessageTemplateModification, CMessageVisionRangeChanged, CMessageVisionSharingChanged, CMessageMinimapPing, CMessageCinemaPathEnded, CMessageCinemaQueueEnded, and CMessageScripted.

GetType()

virtual int CMessage::GetType ( ) const

pure virtual

Implemented in CMessageTurnStart, CMessageUpdate, CMessageUpdate_MotionFormation, CMessageUpdate_MotionUnit, CMessageUpdate_Final, CMessageInterpolate, CMessageRenderSubmit, CMessageProgressiveLoad, CMessageDeserialized, CMessageCreate, CMessageDestroy, CMessageOwnershipChanged, CMessagePositionChanged, CMessageInterpolatedPositionChanged, CMessageMotionUpdate, CMessageWaterChanged, CMessageTerrainChanged, CMessageVisibilityChanged, CMessageMovementObstructionChanged, CMessageObstructionMapShapeChanged, CMessageTerritoriesChanged, CMessageRangeUpdate, CMessagePathResult, CMessageValueModification, CMessagePlayerColorChanged, CMessageTemplateModification, CMessageVisionRangeChanged, CMessageVisionSharingChanged, CMessageMinimapPing, CMessageCinemaPathEnded, CMessageCinemaQueueEnded, and CMessageScripted.

NONCOPYABLE()

CMessage::NONCOPYABLE ( CMessage  )

private

ToJSVal()

virtual JS::Value CMessage::ToJSVal ( const ScriptRequest &  ) const

pure virtual

Implemented in CMessageTurnStart, CMessageUpdate, CMessageUpdate_MotionFormation, CMessageUpdate_MotionUnit, CMessageUpdate_Final, CMessageInterpolate, CMessageRenderSubmit, CMessageProgressiveLoad, CMessageDeserialized, CMessageCreate, CMessageDestroy, CMessageOwnershipChanged, CMessagePositionChanged, CMessageInterpolatedPositionChanged, CMessageMotionUpdate, CMessageWaterChanged, CMessageTerrainChanged, CMessageVisibilityChanged, CMessageMovementObstructionChanged, CMessageObstructionMapShapeChanged, CMessageTerritoriesChanged, CMessageRangeUpdate, CMessagePathResult, CMessageValueModification, CMessagePlayerColorChanged, CMessageTemplateModification, CMessageVisionRangeChanged, CMessageVisionSharingChanged, CMessageMinimapPing, CMessageCinemaPathEnded, CMessageCinemaQueueEnded, and CMessageScripted.

ToJSValCached()

JS::Value CMessage::ToJSValCached

(

const ScriptRequest &

rq

)

const

Member Data Documentation

m_Cached

std::unique_ptr<JS::PersistentRootedValue> CMessage::m_Cached

mutableprivate

---

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

• /home/docker/jenkins/workspace/technical-docs/source/simulation2/system/Message.h
• /home/docker/jenkins/workspace/technical-docs/source/simulation2/scripting/MessageTypeConversions.cpp