Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
CCmpGuiInterfaceScripted Class Reference
Inheritance diagram for CCmpGuiInterfaceScripted:
Inheritance graph
[legend]
Collaboration diagram for CCmpGuiInterfaceScripted:
Collaboration graph
[legend]

Public Member Functions

 CCmpGuiInterfaceScripted (const ScriptInterface &scriptInterface, JS::HandleValue instance)
 
void Init (const CParamNode &paramNode) override
 
void Deinit () override
 
void HandleMessage (const CMessage &msg, bool global) override
 
void Serialize (ISerializer &serialize) override
 
void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize) override
 
JS::Value GetJSInstance () const override
 
int GetComponentTypeId () const override
 
void ScriptCall (int player, const std::wstring &cmd, JS::HandleValue data, JS::MutableHandleValue ret) override
 Generic call function, for use by GUI scripts to talk to the GuiInterface script. More...
 
virtual void ScriptCall (int player, const std::wstring &cmd, JS::HandleValue data, JS::MutableHandleValue ret)=0
 Generic call function, for use by GUI scripts to talk to the GuiInterface script. 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 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
 

Static Public Member Functions

static void ClassInit (CComponentManager &componentManager)
 
static IComponent * Allocate (const 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 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 ()
 

Private Attributes

CComponentTypeScript m_Script
 

Additional Inherited Members

- Public Types inherited from IComponent
using AllocFunc = IComponent *(*)(const ScriptInterface &scriptInterface, JS::HandleValue ctor)
 
using DeallocFunc = void(*)(IComponent *)
 

Constructor & Destructor Documentation

◆ CCmpGuiInterfaceScripted()

CCmpGuiInterfaceScripted::CCmpGuiInterfaceScripted ( const ScriptInterface &  scriptInterface,
JS::HandleValue  instance 
)
inline

Member Function Documentation

◆ Allocate()

static IComponent * CCmpGuiInterfaceScripted::Allocate ( const ScriptInterface &  scriptInterface,
JS::HandleValue  instance 
)
inlinestatic

◆ ClassInit()

static void CCmpGuiInterfaceScripted::ClassInit ( CComponentManager &  componentManager)
inlinestatic

◆ Deallocate()

static void CCmpGuiInterfaceScripted::Deallocate ( IComponent *  cmp)
inlinestatic

◆ Deinit()

void CCmpGuiInterfaceScripted::Deinit ( )
inlineoverridevirtual

Implements IComponent.

◆ Deserialize()

void CCmpGuiInterfaceScripted::Deserialize ( const CParamNode &  paramNode,
IDeserializer &  deserialize 
)
inlineoverridevirtual

Implements IComponent.

◆ GetComponentTypeId()

int CCmpGuiInterfaceScripted::GetComponentTypeId ( ) const
inlineoverridevirtual

Implements IComponent.

◆ GetJSInstance()

JS::Value CCmpGuiInterfaceScripted::GetJSInstance ( ) const
inlineoverridevirtual

Reimplemented from IComponent.

◆ GetSchema()

static std::string CCmpGuiInterfaceScripted::GetSchema ( )
inlinestatic

◆ HandleMessage()

void CCmpGuiInterfaceScripted::HandleMessage ( const CMessage &  msg,
bool  global 
)
inlineoverridevirtual

Reimplemented from IComponent.

◆ Init()

void CCmpGuiInterfaceScripted::Init ( const CParamNode &  paramNode)
inlineoverridevirtual

Implements IComponent.

◆ ScriptCall()

void CCmpGuiInterfaceScripted::ScriptCall ( int  player,
const std::wstring &  cmd,
JS::HandleValue  data,
JS::MutableHandleValue  ret 
)
inlineoverridevirtual

Generic call function, for use by GUI scripts to talk to the GuiInterface script.

Implements ICmpGuiInterface.

◆ Serialize()

void CCmpGuiInterfaceScripted::Serialize ( ISerializer &  serialize)
inlineoverridevirtual

Implements IComponent.

Member Data Documentation

◆ m_Script

CComponentTypeScript CCmpGuiInterfaceScripted::m_Script
private
The documentation for this class was generated from the following file: