Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
ICmpRangeOverlayRenderer Class Referenceabstract

#include <ICmpRangeOverlayRenderer.h>

Inheritance diagram for ICmpRangeOverlayRenderer:
Collaboration diagram for ICmpRangeOverlayRenderer:

Public Member Functions

virtual void AddRangeOverlay (float radius, const std::string &texture, const std::string &textureMask, float thickness)=0
 Add a range overlay to this entity, for example for an aura or attack. More...
 
virtual void ResetRangeOverlays ()=0
 Delete all range overlays. More...
 
virtual void UpdateColor ()=0
 Updates the overlay color to match the player color. 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 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 ()
 

Member Function Documentation

◆ AddRangeOverlay()

virtual void ICmpRangeOverlayRenderer::AddRangeOverlay ( float  radius,
const std::string &  texture,
const std::string &  textureMask,
float  thickness 
)
pure virtual

Add a range overlay to this entity, for example for an aura or attack.

Implemented in CCmpRangeOverlayRenderer.

◆ ResetRangeOverlays()

virtual void ICmpRangeOverlayRenderer::ResetRangeOverlays ( )
pure virtual

Delete all range overlays.

Implemented in CCmpRangeOverlayRenderer.

◆ UpdateColor()

virtual void ICmpRangeOverlayRenderer::UpdateColor ( )
pure virtual

Updates the overlay color to match the player color.

Implemented in CCmpRangeOverlayRenderer.


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