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

The Visibility component is a scripted component that allows any part of the simulation to influence the visibility of an entity. More...

#include <ICmpVisibility.h>

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

Public Member Functions

virtual bool IsActivated ()=0
 This function is a fallback for some entities whose visibility status cannot be cached by the range manager (especially local entities like previews). More...
 
virtual ICmpRangeManager::ELosVisibility GetVisibility (player_id_t player, bool isVisible, bool isExplored)=0
 
virtual bool GetRetainInFog ()=0
 
virtual bool GetAlwaysVisible ()=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 (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

The Visibility component is a scripted component that allows any part of the simulation to influence the visibility of an entity.

This component:

Member Function Documentation

virtual bool ICmpVisibility::GetAlwaysVisible ( )
pure virtual

Implemented in CCmpVisibilityScripted.

virtual bool ICmpVisibility::GetRetainInFog ( )
pure virtual

Implemented in CCmpVisibilityScripted.

virtual ICmpRangeManager::ELosVisibility ICmpVisibility::GetVisibility ( player_id_t  player,
bool  isVisible,
bool  isExplored 
)
pure virtual

Implemented in CCmpVisibilityScripted.

virtual bool ICmpVisibility::IsActivated ( )
pure virtual

This function is a fallback for some entities whose visibility status cannot be cached by the range manager (especially local entities like previews).

Calling the scripts is expensive, so only call it if really needed.

Implemented in CCmpVisibilityScripted.


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