ICmpMinimap Class Reference

Per-unit minimap data. More...

#include <ICmpMinimap.h>

Inheritance diagram for ICmpMinimap:

Collaboration diagram for ICmpMinimap:

Public Member Functions
virtual bool	GetRenderData (u8 &r, u8 &g, u8 &b, entity_pos_t &x, entity_pos_t &z) const =0
	Gets the data for rendering this entity on the minimap. More...
virtual bool	CheckPing (double currentTime, double pingDuration)=0
	Returns true if the entity is actively pinging based on the current time. More...
virtual void	UpdateColor ()=0
	Updates the entity's minimap color to match the player color. More...
virtual bool	HasIcon ()=0
	Returns true if a minimap should have icon of this entity. More...
virtual std::string	GetIconPath ()=0
	Returns a path to icon of this entity. More...
virtual float	GetIconSize ()=0
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 (const 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
Public Types inherited from IComponent
using	AllocFunc = IComponent *(*)(const ScriptInterface &scriptInterface, JS::HandleValue ctor)
using	DeallocFunc = void(*)(IComponent *)
Static Public Member Functions inherited from IComponent
static std::string	GetSchema ()
static void	RegisterComponentType (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
static void	RegisterComponentTypeScriptWrapper (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
static u8	GetSerializationVersion ()

Detailed Description

Per-unit minimap data.

Member Function Documentation

CheckPing()

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

pure virtual

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

Implemented in CCmpMinimap.

GetIconPath()

virtual std::string ICmpMinimap::GetIconPath ( )

pure virtual

Returns a path to icon of this entity.

Implemented in CCmpMinimap.

GetIconSize()

virtual float ICmpMinimap::GetIconSize ( )

pure virtual

Implemented in CCmpMinimap.

GetRenderData()

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

pure virtual

Gets 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.

HasIcon()

virtual bool ICmpMinimap::HasIcon ( )

pure virtual

Returns true if a minimap should have icon of this entity.

Implemented in CCmpMinimap.

UpdateColor()

virtual void ICmpMinimap::UpdateColor ( )

pure virtual

Updates the entity's minimap color to match the player color.

Implemented in CCmpMinimap.

---

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

• /home/docker/jenkins/workspace/technical-docs/source/simulation2/components/ICmpMinimap.h