LuaCallFunc Class Reference

The LuaCallFunc is wrapped to call the callback function in the Lua Conveniently and don't insert useless code to processing the lua in the CallFuncN. More...

Inherits CallFuncN.

Public Member Functions
	LuaCallFunc ()
	Default constructor.
virtual	~LuaCallFunc ()
	Destructor.
bool	initWithFunction (const std::function< void(void *self, Node *)> &func)
	Init a LuaCallFunc object by a function pointer for callback. More...
virtual LuaCallFunc *	clone () const override
	Returns a clone of action. More...
virtual void	execute () override
	Executes the callback.
Public Member Functions inherited from CallFunc
virtual void	update (float time) override
virtual CallFunc *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...
Public Member Functions inherited from ActionInstant
virtual void	startWithTarget (Node *target) override
	Called before the action start. More...
virtual bool	isDone () const override
	Return true if the action has finished. More...
virtual void	step (float dt) override
Public Member Functions inherited from FiniteTimeAction
float	getDuration () const
	Get duration in seconds of the action. More...
void	setDuration (float duration)
	Set duration in seconds of the action. More...
Public Member Functions inherited from Action
virtual std::string	description () const
	@js NA @lua NA
virtual void	stop ()
	Called after the action has finished. More...
Node *	getTarget () const
	Return certain target. More...
void	setTarget (Node *target)
	The action will modify the target properties. More...
Node *	getOriginalTarget () const
	Return a original Target. More...
void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil. More...
int	getTag () const
	Returns a tag that is used to identify the action easily. More...
void	setTag (int tag)
	Changes the tag that is used to identify the action easily. More...
unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily. More...
void	setFlags (unsigned int flags)
	Changes the flag field that is used to group the actions easily. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor. More...
Public Member Functions inherited from Clonable
virtual	~Clonable ()
	@js NA @lua NA

Static Public Member Functions
static LuaCallFunc *	create (const std::function< void(void *self, Node *)> &func)
	Create a LuaCallFunc object by a function pointer for callback. More...
Static Public Member Functions inherited from CallFuncN
static CallFuncN *	create (const std::function< void(Node *)> &func)
	Creates the action with the callback of type std::function<void()>. More...
Static Public Member Functions inherited from CallFunc
static CallFunc *	create (const std::function< void()> &func)
	Creates the action with the callback of type std::function<void()>. More...

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.
Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions.
Protected Member Functions inherited from CallFuncN
bool	initWithFunction (const std::function< void(Node *)> &func)
	initializes the action with the std::function<void(Node*)>
Protected Member Functions inherited from CallFunc
bool	initWithFunction (const std::function< void()> &func)
	initializes the action with the std::function<void()> @lua NA

Detailed Description

The LuaCallFunc is wrapped to call the callback function in the Lua Conveniently and don't insert useless code to processing the lua in the CallFuncN.

@lua NA @js NA

Member Function Documentation

create()

static LuaCallFunc* create ( const std::function< void(void *self, Node *)> &  func )

static

Create a LuaCallFunc object by a function pointer for callback.

Parameters

func	a function pointer for callback.

initWithFunction()

bool initWithFunction

(

const std::function< void(void *self, Node *)> &

func

)

Init a LuaCallFunc object by a function pointer for callback.

Parameters

func	a function pointer for callback.

clone()

virtual LuaCallFunc* clone ( ) const

overridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from CallFuncN.

---

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

• LuaScriptHandlerMgr.h