CCmpSettlementScripted Class Reference

Inheritance diagram for CCmpSettlementScripted:

Collaboration diagram for CCmpSettlementScripted:

Public Member Functions
	CCmpSettlementScripted (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
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

CCmpSettlementScripted()

CCmpSettlementScripted::CCmpSettlementScripted ( const ScriptInterface &  scriptInterface, JS::HandleValue  instance  )

inline

Member Function Documentation

Allocate()

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

inlinestatic

ClassInit()

static void CCmpSettlementScripted::ClassInit ( CComponentManager &  componentManager )

inlinestatic

Deallocate()

static void CCmpSettlementScripted::Deallocate ( IComponent *  cmp )

inlinestatic

Deinit()

void CCmpSettlementScripted::Deinit ( )

inlineoverridevirtual

Implements IComponent.

Deserialize()

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

inlineoverridevirtual

Implements IComponent.

GetComponentTypeId()

int CCmpSettlementScripted::GetComponentTypeId ( ) const

inlineoverridevirtual

Implements IComponent.

GetJSInstance()

JS::Value CCmpSettlementScripted::GetJSInstance ( ) const

inlineoverridevirtual

Reimplemented from IComponent.

GetSchema()

static std::string CCmpSettlementScripted::GetSchema ( )

inlinestatic

HandleMessage()

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

inlineoverridevirtual

Reimplemented from IComponent.

Init()

void CCmpSettlementScripted::Init ( const CParamNode &  paramNode )

inlineoverridevirtual

Implements IComponent.

Serialize()

void CCmpSettlementScripted::Serialize ( ISerializer &  serialize )

inlineoverridevirtual

Implements IComponent.

Member Data Documentation

m_Script

CComponentTypeScript CCmpSettlementScripted::m_Script

private

---

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

• /home/docker/jenkins/workspace/technical-docs/source/simulation2/components/ICmpSettlement.cpp