Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
CMessageDestroy Class Referencefinal

This is sent immediately before a destroyed entity is flushed and really destroyed. More...

#include <MessageTypes.h>

Inheritance diagram for CMessageDestroy:
Collaboration diagram for CMessageDestroy:

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
 
 CMessageDestroy (entity_id_t entity)
 
- 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

entity_id_t entity
 

Additional Inherited Members

- Protected Member Functions inherited from CMessage
 CMessage ()
 

Detailed Description

This is sent immediately before a destroyed entity is flushed and really destroyed.

(That is, after CComponentManager::DestroyComponentsSoon and inside FlushDestroyedComponents). The entity will still exist at the time this message is sent. It's possible for this message to be sent multiple times for one entity, but all its components will have been deleted after the first time.

Constructor & Destructor Documentation

◆ CMessageDestroy()

CMessageDestroy::CMessageDestroy ( entity_id_t  entity)
inline

Member Function Documentation

◆ FromJSVal()

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

◆ GetScriptGlobalHandlerName()

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

Implements CMessage.

◆ GetScriptHandlerName()

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

Implements CMessage.

◆ GetType()

virtual int CMessageDestroy::GetType ( ) const
inlinevirtual

Implements CMessage.

◆ ToJSVal()

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

Implements CMessage.

Member Data Documentation

◆ entity

entity_id_t CMessageDestroy::entity

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