Pyrogenesis  13997
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CCmpMinimap Class Reference
Inheritance diagram for CCmpMinimap:
ICmpMinimap IComponent

Public Member Functions

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)
 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 JSClass * GetJSClass () const
 
virtual jsval GetJSInstance () const
 

Static Public Member Functions

static void ClassInit (CComponentManager &componentManager)
 
static IComponentAllocate (ScriptInterface &, jsval)
 
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_UsePlayerColour
 
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
 

Detailed Description

Definition at line 30 of file CCmpMinimap.cpp.

Member Function Documentation

static IComponent* CCmpMinimap::Allocate ( ScriptInterface ,
jsval   
)
inlinestatic

Definition at line 40 of file CCmpMinimap.cpp.

virtual bool CCmpMinimap::CheckPing ( double  currentTime,
double  pingDuration 
)
inlinevirtual

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

Implements ICmpMinimap.

Definition at line 223 of file CCmpMinimap.cpp.

static void CCmpMinimap::ClassInit ( CComponentManager componentManager)
inlinestatic

Definition at line 33 of file CCmpMinimap.cpp.

static void CCmpMinimap::Deallocate ( IComponent cmp)
inlinestatic

Definition at line 40 of file CCmpMinimap.cpp.

virtual void CCmpMinimap::Deinit ( )
inlinevirtual

Implements IComponent.

Definition at line 113 of file CCmpMinimap.cpp.

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

Implements IComponent.

Definition at line 141 of file CCmpMinimap.cpp.

virtual bool CCmpMinimap::GetRenderData ( u8 r,
u8 g,
u8 b,
entity_pos_t x,
entity_pos_t z 
)
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 colour and world position.

Implements ICmpMinimap.

Definition at line 210 of file CCmpMinimap.cpp.

static std::string CCmpMinimap::GetSchema ( )
inlinestatic

Definition at line 58 of file CCmpMinimap.cpp.

virtual void CCmpMinimap::HandleMessage ( const CMessage msg,
bool  global 
)
inlinevirtual

Reimplemented from IComponent.

Definition at line 148 of file CCmpMinimap.cpp.

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

Implements IComponent.

Definition at line 89 of file CCmpMinimap.cpp.

virtual void CCmpMinimap::Serialize ( ISerializer serialize)
inlinevirtual

Implements IComponent.

Definition at line 136 of file CCmpMinimap.cpp.

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

Definition at line 118 of file CCmpMinimap.cpp.

Member Data Documentation

bool CCmpMinimap::m_Active

Definition at line 50 of file CCmpMinimap.cpp.

u8 CCmpMinimap::m_B

Definition at line 46 of file CCmpMinimap.cpp.

u8 CCmpMinimap::m_G

Definition at line 46 of file CCmpMinimap.cpp.

bool CCmpMinimap::m_IsPinging

Definition at line 56 of file CCmpMinimap.cpp.

double CCmpMinimap::m_PingEndTime

Definition at line 55 of file CCmpMinimap.cpp.

u8 CCmpMinimap::m_R

Definition at line 46 of file CCmpMinimap.cpp.

bool CCmpMinimap::m_UsePlayerColour

Definition at line 44 of file CCmpMinimap.cpp.

entity_pos_t CCmpMinimap::m_X

Definition at line 51 of file CCmpMinimap.cpp.

entity_pos_t CCmpMinimap::m_Z

Definition at line 51 of file CCmpMinimap.cpp.


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