Pyrogenesis  trunk
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CCmpMinimap Class Reference
Inheritance diagram for CCmpMinimap:
Inheritance graph
[legend]
Collaboration diagram for CCmpMinimap:
Collaboration graph
[legend]

Public Member Functions

virtual int GetComponentTypeId () const
 
virtual void Init (const CParamNode &paramNode)
 
virtual void Deinit ()
 
template<typename S >
void SerializeCommon (S &serialize)
 
virtual void Serialize (ISerializer &serialize)
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)
 
virtual void HandleMessage (const CMessage &msg, bool global)
 
virtual bool GetRenderData (u8 &r, u8 &g, u8 &b, entity_pos_t &x, entity_pos_t &z) const
 Get the data for rendering this entity on the minimap. More...
 
virtual bool CheckPing (double currentTime, double pingDuration)
 Return true if entity is actively pinging based on the current time. More...
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
CEntityHandle GetEntityHandle () const
 
void SetEntityHandle (CEntityHandle ent)
 
entity_id_t GetEntityId () const
 
CEntityHandle GetSystemEntity () const
 
const CSimContextGetSimContext () const
 
void SetSimContext (const CSimContext &context)
 
virtual bool NewJSObject (ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
 Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...
 
virtual JS::Value GetJSInstance () const
 

Static Public Member Functions

static void ClassInit (CComponentManager &componentManager)
 
static IComponentAllocate (ScriptInterface &, JS::HandleValue)
 
static void Deallocate (IComponent *cmp)
 
static std::string GetSchema ()
 
- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static u8 GetSerializationVersion ()
 

Public Attributes

bool m_UsePlayerColor
 
u8 m_R
 
u8 m_G
 
u8 m_B
 
bool m_Active
 
entity_pos_t m_X
 
entity_pos_t m_Z
 
double m_PingEndTime
 
bool m_IsPinging
 

Member Function Documentation

static IComponent* CCmpMinimap::Allocate ( ScriptInterface ,
JS::HandleValue   
)
inlinestatic
virtual bool CCmpMinimap::CheckPing ( double  currentTime,
double  pingDuration 
)
inlinevirtual

Return true if entity is actively pinging based on the current time.

Implements ICmpMinimap.

static void CCmpMinimap::ClassInit ( CComponentManager componentManager)
inlinestatic
static void CCmpMinimap::Deallocate ( IComponent cmp)
inlinestatic
virtual void CCmpMinimap::Deinit ( )
inlinevirtual

Implements IComponent.

virtual void CCmpMinimap::Deserialize ( const CParamNode paramNode,
IDeserializer deserialize 
)
inlinevirtual

Implements IComponent.

virtual int CCmpMinimap::GetComponentTypeId ( ) const
inlinevirtual

Implements IComponent.

virtual bool CCmpMinimap::GetRenderData ( u8 r,
u8 g,
u8 b,
entity_pos_t x,
entity_pos_t z 
) const
inlinevirtual

Get the data for rendering this entity on the minimap.

If it should not be drawn, returns false; otherwise the arguments are set to the color and world position.

Implements ICmpMinimap.

static std::string CCmpMinimap::GetSchema ( )
inlinestatic
virtual void CCmpMinimap::HandleMessage ( const CMessage msg,
bool  global 
)
inlinevirtual

Reimplemented from IComponent.

virtual void CCmpMinimap::Init ( const CParamNode paramNode)
inlinevirtual

Implements IComponent.

virtual void CCmpMinimap::Serialize ( ISerializer serialize)
inlinevirtual

Implements IComponent.

template<typename S >
void CCmpMinimap::SerializeCommon ( S &  serialize)
inline

Member Data Documentation

bool CCmpMinimap::m_Active
u8 CCmpMinimap::m_B
u8 CCmpMinimap::m_G
bool CCmpMinimap::m_IsPinging
double CCmpMinimap::m_PingEndTime
u8 CCmpMinimap::m_R
bool CCmpMinimap::m_UsePlayerColor
entity_pos_t CCmpMinimap::m_X
entity_pos_t CCmpMinimap::m_Z

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