igor::iScriptComponent Class Reference

#include <iScriptComponent.h>

Inherits igor::iEntityComponent.

Public Member Functions

 iScriptComponent ()
 
std::vector< iaStringgetInfo () const override
 
const std::vector< iScriptData > & getScripts () const
 
void addScript (const iScriptDelegate &delegate)
 
void addScript (const iScriptPtr script)
 
void removeScript (const iScriptDelegate &delegate)
 
void execute ()
 
- Public Member Functions inherited from igor::iEntityComponent
 iEntityComponent ()
 
virtual ~iEntityComponent ()=default
 
const iEntityComponentIDgetID () const
 
iEntityComponentState getState () const
 
virtual std::vector< iaStringgetInfo () const
 
void increaseVersion ()
 
uint16 getVersion () const
 

Static Public Member Functions

static iEntityComponentPtr createInstance ()
 
static const iaStringgetTypeName ()
 

Additional Inherited Members

- Protected Member Functions inherited from igor::iEntityComponent
virtual bool onLoad (iEntityPtr entity, bool &asyncLoad)
 
virtual void onActivate (iEntityPtr entity)
 
virtual void onDeactivate (iEntityPtr entity)
 
virtual void onUnLoad (iEntityPtr entity)
 
virtual iEntityComponentPtr getCopy ()=0
 
iEntityPtr getEntity () const
 

Detailed Description

script component

Constructor & Destructor Documentation

◆ iScriptComponent()

igor::iScriptComponent::iScriptComponent ( )

ctor

Member Function Documentation

◆ addScript() [1/2]

void igor::iScriptComponent::addScript ( const iScriptDelegate &  delegate)

adds script from code

Parameters
scriptthe script to add

◆ addScript() [2/2]

void igor::iScriptComponent::addScript ( const iScriptPtr  script)

adds script from script

Parameters
scriptthe script script to add
namethe name of the script

◆ createInstance()

iEntityComponentPtr igor::iScriptComponent::createInstance ( )
static

creates instance of this component type

◆ execute()

void igor::iScriptComponent::execute ( )

executes all behaviours

◆ getInfo()

std::vector< iaString > igor::iScriptComponent::getInfo ( ) const
overridevirtual
Returns
a set of info strings

Reimplemented from igor::iEntityComponent.

◆ getScripts()

const std::vector< iScriptData > & igor::iScriptComponent::getScripts ( ) const
Returns
scripts

◆ getTypeName()

const iaString & igor::iScriptComponent::getTypeName ( )
static
Returns
type name of component

◆ removeScript()

void igor::iScriptComponent::removeScript ( const iScriptDelegate &  delegate)

removes script from entity

Parameters
scriptthe script to be removed

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