CMessagePositionChanged Class Reference

Sent by CCmpPosition whenever anything has changed that will affect the return value of GetPosition2D() or GetRotation().Y. More...

#include <MessageTypes.h>

Inheritance diagram for CMessagePositionChanged:

Collaboration diagram for CMessagePositionChanged:

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
	CMessagePositionChanged (entity_id_t entity, bool inWorld, entity_pos_t x, entity_pos_t z, entity_angle_t a)
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 CMessage *	FromJSVal (const ScriptRequest &, JS::HandleValue val)

Public Attributes
entity_id_t	entity
bool	inWorld
entity_pos_t	x
entity_pos_t	z
entity_angle_t	a

Additional Inherited Members
Protected Member Functions inherited from CMessage
	CMessage ()

Detailed Description

Sent by CCmpPosition whenever anything has changed that will affect the return value of GetPosition2D() or GetRotation().Y.

If inWorld is false, then the other fields are invalid and meaningless. Otherwise they represent the current position.

Constructor & Destructor Documentation

CMessagePositionChanged()

CMessagePositionChanged::CMessagePositionChanged ( entity_id_t  entity, bool  inWorld, entity_pos_t  x, entity_pos_t  z, entity_angle_t  a  )

inline

Member Function Documentation

FromJSVal()

CMessage * CMessagePositionChanged::FromJSVal ( const ScriptRequest &  rq, JS::HandleValue  val  )

static

GetScriptGlobalHandlerName()

virtual const char * CMessagePositionChanged::GetScriptGlobalHandlerName ( ) const

inlinevirtual

Implements CMessage.

GetScriptHandlerName()

virtual const char * CMessagePositionChanged::GetScriptHandlerName ( ) const

inlinevirtual

Implements CMessage.

GetType()

virtual int CMessagePositionChanged::GetType ( ) const

inlinevirtual

Implements CMessage.

ToJSVal()

JS::Value CMessagePositionChanged::ToJSVal ( const ScriptRequest &  rq ) const

virtual

Implements CMessage.

Member Data Documentation

a

entity_angle_t CMessagePositionChanged::a

entity

entity_id_t CMessagePositionChanged::entity

inWorld

bool CMessagePositionChanged::inWorld

x

entity_pos_t CMessagePositionChanged::x

z

entity_pos_t CMessagePositionChanged::z

---

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

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