Pyrogenesis trunk
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CMessageRangeUpdate Class Referencefinal

Sent by CCmpRangeManager at most once per turn, when an active range query has had matching units enter/leave the range since the last RangeUpdate. More...

#include <MessageTypes.h>

Inheritance diagram for CMessageRangeUpdate:
Inheritance graph
[legend]
Collaboration diagram for CMessageRangeUpdate:
Collaboration graph
[legend]

Public Member Functions

virtual int GetType () const
 
virtual const char * GetScriptHandlerName () const
 
virtual const char * GetScriptGlobalHandlerName () const
 
virtual JS::Value ToJSVal (const ScriptRequest &rq) const
 
 CMessageRangeUpdate ()
 
 CMessageRangeUpdate (u32 tag)
 
 CMessageRangeUpdate (u32 tag, const std::vector< entity_id_t > &added, const std::vector< entity_id_t > &removed)
 
 CMessageRangeUpdate (const CMessageRangeUpdate &other)
 
CMessageRangeUpdateoperator= (const CMessageRangeUpdate &other)
 
- Public Member Functions inherited from CMessage
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
 

Static Public Member Functions

static CMessageFromJSVal (const ScriptRequest &, JS::HandleValue val)
 

Public Attributes

u32 tag
 
std::vector< entity_id_tadded
 
std::vector< entity_id_tremoved
 

Additional Inherited Members

- Protected Member Functions inherited from CMessage
 CMessage ()
 

Detailed Description

Sent by CCmpRangeManager at most once per turn, when an active range query has had matching units enter/leave the range since the last RangeUpdate.

Constructor & Destructor Documentation

◆ CMessageRangeUpdate() [1/4]

CMessageRangeUpdate::CMessageRangeUpdate ( )
inline

◆ CMessageRangeUpdate() [2/4]

CMessageRangeUpdate::CMessageRangeUpdate ( u32  tag)
inline

◆ CMessageRangeUpdate() [3/4]

CMessageRangeUpdate::CMessageRangeUpdate ( u32  tag,
const std::vector< entity_id_t > &  added,
const std::vector< entity_id_t > &  removed 
)
inline

◆ CMessageRangeUpdate() [4/4]

CMessageRangeUpdate::CMessageRangeUpdate ( const CMessageRangeUpdate other)
inline

Member Function Documentation

◆ FromJSVal()

CMessage * CMessageRangeUpdate::FromJSVal ( const ScriptRequest rq,
JS::HandleValue  val 
)
static

◆ GetScriptGlobalHandlerName()

virtual const char * CMessageRangeUpdate::GetScriptGlobalHandlerName ( ) const
inlinevirtual

Implements CMessage.

◆ GetScriptHandlerName()

virtual const char * CMessageRangeUpdate::GetScriptHandlerName ( ) const
inlinevirtual

Implements CMessage.

◆ GetType()

virtual int CMessageRangeUpdate::GetType ( ) const
inlinevirtual

Implements CMessage.

◆ operator=()

CMessageRangeUpdate & CMessageRangeUpdate::operator= ( const CMessageRangeUpdate other)
inline

◆ ToJSVal()

JS::Value CMessageRangeUpdate::ToJSVal ( const ScriptRequest rq) const
virtual

Implements CMessage.

Member Data Documentation

◆ added

std::vector<entity_id_t> CMessageRangeUpdate::added

◆ removed

std::vector<entity_id_t> CMessageRangeUpdate::removed

◆ tag

u32 CMessageRangeUpdate::tag

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