Pyrogenesis  13997
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
ICmpMinimap Class Referenceabstract

Per-unit minimap data. More...

#include <ICmpMinimap.h>

Inheritance diagram for ICmpMinimap:
IComponent CCmpMinimap

Public Member Functions

virtual bool GetRenderData (u8 &r, u8 &g, u8 &b, entity_pos_t &x, entity_pos_t &z)=0
 Get the data for rendering this entity on the minimap. More...
 
virtual bool CheckPing (double currentTime, double pingDuration)=0
 Return true if entity is actively pinging based on the current time. More...
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
virtual void Init (const CParamNode &paramNode)=0
 
virtual void Deinit ()=0
 
virtual void HandleMessage (const CMessage &msg, bool global)
 
CEntityHandle GetEntityHandle () const
 
void SetEntityHandle (CEntityHandle ent)
 
entity_id_t GetEntityId () const
 
CEntityHandle GetSystemEntity () const
 
const CSimContextGetSimContext () const
 
void SetSimContext (const CSimContext &context)
 
virtual void Serialize (ISerializer &serialize)=0
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0
 
virtual JSClass * GetJSClass () const
 
virtual jsval GetJSInstance () const
 

Additional Inherited Members

- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static u8 GetSerializationVersion ()
 

Detailed Description

Per-unit minimap data.

Definition at line 28 of file ICmpMinimap.h.

Member Function Documentation

virtual bool ICmpMinimap::CheckPing ( double  currentTime,
double  pingDuration 
)
pure virtual

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

Implemented in CCmpMinimap.

virtual bool ICmpMinimap::GetRenderData ( u8 r,
u8 g,
u8 b,
entity_pos_t x,
entity_pos_t z 
)
pure virtual

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.

Implemented in CCmpMinimap.


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