Pyrogenesis  trunk
Public Member Functions | List of all members
ICmpFogging Class Referenceabstract

Handles the fogging of out-of-sight enemy entities, by creating mirage entities. More...

#include <ICmpFogging.h>

Inheritance diagram for ICmpFogging:
Inheritance graph
[legend]
Collaboration diagram for ICmpFogging:
Collaboration graph
[legend]

Public Member Functions

virtual bool IsActivated ()=0
 
virtual bool WasSeen (player_id_t player)=0
 
virtual bool IsMiraged (player_id_t player)=0
 
virtual void ForceMiraging (player_id_t player)=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 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 ()
 

Detailed Description

Handles the fogging of out-of-sight enemy entities, by creating mirage entities.

This allows hiding changes, especially destruction status or health.

Member Function Documentation

◆ ForceMiraging()

virtual void ICmpFogging::ForceMiraging ( player_id_t  player)
pure virtual

Implemented in CCmpFoggingScripted.

◆ IsActivated()

virtual bool ICmpFogging::IsActivated ( )
pure virtual

Implemented in CCmpFoggingScripted.

◆ IsMiraged()

virtual bool ICmpFogging::IsMiraged ( player_id_t  player)
pure virtual

Implemented in CCmpFoggingScripted.

◆ WasSeen()

virtual bool ICmpFogging::WasSeen ( player_id_t  player)
pure virtual

Implemented in CCmpFoggingScripted.


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