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

Sent by CCmpUnitMotion during Update if an event happened that might interest other components. More...

#include <MessageTypes.h>

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

Public Types

enum  UpdateType {
  LIKELY_SUCCESS , LIKELY_FAILURE , OBSTRUCTED , VERY_OBSTRUCTED ,
  LENGTH
}
 

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
 
 CMessageMotionUpdate (UpdateType ut)
 
- 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

UpdateType updateType
 

Static Public Attributes

static const std::array< const char *, UpdateType::LENGTH > UpdateTypeStr
 

Additional Inherited Members

- Protected Member Functions inherited from CMessage
 CMessage ()
 

Detailed Description

Sent by CCmpUnitMotion during Update if an event happened that might interest other components.

Member Enumeration Documentation

◆ UpdateType

Enumerator
LIKELY_SUCCESS 
LIKELY_FAILURE 
OBSTRUCTED 
VERY_OBSTRUCTED 
LENGTH 

Constructor & Destructor Documentation

◆ CMessageMotionUpdate()

CMessageMotionUpdate::CMessageMotionUpdate ( UpdateType  ut)
inline

Member Function Documentation

◆ FromJSVal()

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

◆ GetScriptGlobalHandlerName()

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

Implements CMessage.

◆ GetScriptHandlerName()

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

Implements CMessage.

◆ GetType()

virtual int CMessageMotionUpdate::GetType ( ) const
inlinevirtual

Implements CMessage.

◆ ToJSVal()

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

Implements CMessage.

Member Data Documentation

◆ updateType

UpdateType CMessageMotionUpdate::updateType

◆ UpdateTypeStr

const std::array< const char *, CMessageMotionUpdate::UpdateType::LENGTH > CMessageMotionUpdate::UpdateTypeStr
static
Initial value:
= { {
"likelySuccess", "likelyFailure", "obstructed", "veryObstructed"
} }

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