Pyrogenesis  trunk
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
CCmpVisibilityScripted Class Reference
Inheritance diagram for CCmpVisibilityScripted:
Inheritance graph
[legend]
Collaboration diagram for CCmpVisibilityScripted:
Collaboration graph
[legend]

Public Member Functions

 CCmpVisibilityScripted (ScriptInterface &scriptInterface, JS::HandleValue instance)
 
virtual void Init (const CParamNode &paramNode)
 
virtual void Deinit ()
 
virtual void HandleMessage (const CMessage &msg, bool global)
 
virtual void Serialize (ISerializer &serialize)
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)
 
virtual JS::Value GetJSInstance () const
 
virtual int GetComponentTypeId () const
 
virtual bool IsActivated ()
 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)
 
virtual bool GetRetainInFog ()
 
virtual bool GetAlwaysVisible ()
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
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 bool NewJSObject (ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
 Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...
 

Static Public Member Functions

static void ClassInit (CComponentManager &componentManager)
 
static IComponent * Allocate (ScriptInterface &scriptInterface, JS::HandleValue instance)
 
static void Deallocate (IComponent *cmp)
 
static std::string GetSchema ()
 
- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static u8 GetSerializationVersion ()
 

Private Attributes

CComponentTypeScript m_Script
 

Constructor & Destructor Documentation

CCmpVisibilityScripted::CCmpVisibilityScripted ( ScriptInterface &  scriptInterface,
JS::HandleValue  instance 
)
inline

Member Function Documentation

static IComponent* CCmpVisibilityScripted::Allocate ( ScriptInterface &  scriptInterface,
JS::HandleValue  instance 
)
inlinestatic
static void CCmpVisibilityScripted::ClassInit ( CComponentManager &  componentManager)
inlinestatic
static void CCmpVisibilityScripted::Deallocate ( IComponent *  cmp)
inlinestatic
virtual void CCmpVisibilityScripted::Deinit ( )
inlinevirtual

Implements IComponent.

virtual void CCmpVisibilityScripted::Deserialize ( const CParamNode &  paramNode,
IDeserializer &  deserialize 
)
inlinevirtual

Implements IComponent.

virtual bool CCmpVisibilityScripted::GetAlwaysVisible ( )
inlinevirtual

Implements ICmpVisibility.

virtual int CCmpVisibilityScripted::GetComponentTypeId ( ) const
inlinevirtual

Implements IComponent.

virtual JS::Value CCmpVisibilityScripted::GetJSInstance ( ) const
inlinevirtual

Reimplemented from IComponent.

virtual bool CCmpVisibilityScripted::GetRetainInFog ( )
inlinevirtual

Implements ICmpVisibility.

static std::string CCmpVisibilityScripted::GetSchema ( )
inlinestatic
virtual ICmpRangeManager::ELosVisibility CCmpVisibilityScripted::GetVisibility ( player_id_t  player,
bool  isVisible,
bool  isExplored 
)
inlinevirtual

Implements ICmpVisibility.

virtual void CCmpVisibilityScripted::HandleMessage ( const CMessage &  msg,
bool  global 
)
inlinevirtual

Reimplemented from IComponent.

virtual void CCmpVisibilityScripted::Init ( const CParamNode &  paramNode)
inlinevirtual

Implements IComponent.

virtual bool CCmpVisibilityScripted::IsActivated ( )
inlinevirtual

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.

Implements ICmpVisibility.

virtual void CCmpVisibilityScripted::Serialize ( ISerializer &  serialize)
inlinevirtual

Implements IComponent.

Member Data Documentation

CComponentTypeScript CCmpVisibilityScripted::m_Script
private
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.11