CCmpExample Class Reference

Inheritance diagram for CCmpExample:

Collaboration diagram for CCmpExample:

Public Member Functions
int	GetComponentTypeId () const override
virtual void	Init (const CParamNode &paramNode)
virtual void	Deinit ()
virtual void	Serialize (ISerializer &serialize)
virtual void	Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)
virtual void	HandleMessage (const CMessage &msg, bool global)
virtual int	DoWhatever (int x, int y)
	Documentation for each method. More...
virtual int	DoWhatever (int x, int y)=0
	Documentation for each method. 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 &, JS::HandleValue)
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 ()

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

Member Function Documentation

Allocate()

static IComponent * CCmpExample::Allocate ( const ScriptInterface &  , JS::HandleValue    )

inlinestatic

ClassInit()

static void CCmpExample::ClassInit ( CComponentManager &  componentManager )

inlinestatic

Deallocate()

static void CCmpExample::Deallocate ( IComponent *  cmp )

inlinestatic

Deinit()

virtual void CCmpExample::Deinit ( )

inlinevirtual

Implements IComponent.

Deserialize()

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

inlinevirtual

Implements IComponent.

DoWhatever()

virtual int CCmpExample::DoWhatever ( int  x, int  y  )

inlinevirtual

Documentation for each method.

Implements ICmpExample.

GetComponentTypeId()

int CCmpExample::GetComponentTypeId ( ) const

inlineoverridevirtual

Implements IComponent.

GetSchema()

static std::string CCmpExample::GetSchema ( )

inlinestatic

HandleMessage()

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

inlinevirtual

Reimplemented from IComponent.

Init()

virtual void CCmpExample::Init ( const CParamNode &  paramNode )

inlinevirtual

Implements IComponent.

Serialize()

virtual void CCmpExample::Serialize ( ISerializer &  serialize )

inlinevirtual

Implements IComponent.

---

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

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