Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
CMessageScripted Class Referencefinal

Used for script-only message types. More...

Inheritance diagram for CMessageScripted:
Collaboration diagram for CMessageScripted:

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
 
 CMessageScripted (const ScriptRequest &rq, int mtid, const std::string &name, JS::HandleValue msg)
 
- 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
 

Public Attributes

int mtid
 
std::string handlerName
 
std::string globalHandlerName
 
JS::PersistentRootedValue msg
 

Additional Inherited Members

- Protected Member Functions inherited from CMessage
 CMessage ()
 

Detailed Description

Used for script-only message types.

Constructor & Destructor Documentation

◆ CMessageScripted()

CMessageScripted::CMessageScripted ( const ScriptRequest rq,
int  mtid,
const std::string &  name,
JS::HandleValue  msg 
)
inline

Member Function Documentation

◆ GetScriptGlobalHandlerName()

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

Implements CMessage.

◆ GetScriptHandlerName()

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

Implements CMessage.

◆ GetType()

virtual int CMessageScripted::GetType ( ) const
inlinevirtual

Implements CMessage.

◆ ToJSVal()

virtual JS::Value CMessageScripted::ToJSVal ( const ScriptRequest rq) const
inlinevirtual

Implements CMessage.

Member Data Documentation

◆ globalHandlerName

std::string CMessageScripted::globalHandlerName

◆ handlerName

std::string CMessageScripted::handlerName

◆ msg

JS::PersistentRootedValue CMessageScripted::msg

◆ mtid

int CMessageScripted::mtid

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