Per-unit minimap data. More...

Inheritance diagram for ICmpMinimap:

Collaboration diagram for ICmpMinimap:

[legend]

Public Member Functions
virtual bool	GetRenderData (u8 &r, u8 &g, u8 &b, entity_pos_t &x, entity_pos_t &z) const =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 CSimContext &	GetSimContext () const

void	SetSimContext (const CSimContext &context)

virtual void	Serialize (ISerializer &serialize)=0

virtual void	Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0

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

virtual int	GetComponentTypeId () const =0

Additional Inherited Members
Static Public Member Functions inherited from IComponent
static std::string	GetSchema ()

static u8	GetSerializationVersion ()

Detailed Description

Per-unit minimap data.

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
	)		const

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 color and world position.

Implemented in CCmpMinimap.

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