CallFunc Class Reference

Calls a 'callback'. More...

Inheritance diagram for CallFunc:

Public Member Functions
virtual void	execute ()
	Executes the callback.
Ref *	getTargetCallback ()
	Get the selector target. More...
void	setTargetCallback (Ref *sel)
	Set the selector target. More...
virtual void	update (float time) override
virtual CallFunc *	reverse () const override
	Returns a new action that performs the exact reverse of the action. More...
virtual CallFunc *	clone () const override
	Returns a clone of action. More...
Public Member Functions inherited from ActionInstant
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
	NA NA
virtual void	startWithTarget (Node *target)
	Called before the action start. More...
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 ()
	NA NA
Ref *	copy () const
	Returns a copy of the Ref. More...

Static Public Member Functions
static CallFunc *	create (const std::function< void()> &func)
	Creates the action with the callback of type std::function<void()>. More...
static CallFunc *	create (Ref *target, SEL_CallFunc selector)
	Creates the action with the callback. More...

Protected Member Functions
bool	initWithTarget (Ref *target)
	initializes the action with the callback typedef void (Ref::*SEL_CallFunc)(); More...
bool	initWithFunction (const std::function< void()> &func)
	initializes the action with the std::function<void()> NA

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. More...

Detailed Description

Calls a 'callback'.

Member Function Documentation

create() [1/2]

static CallFunc* create ( const std::function< void()> &  func )

static

Creates the action with the callback of type std::function<void()>.

This is the preferred way to create the callback. When this function bound in js or lua ,the input param will be changed. In js: var create(var func, var this, var [data]) or var create(var func). In lua:local create(local funcID).

Parameters

func	A callback function need to be executed.

Returns

An autoreleased CallFunc object.

create() [2/2]

static CallFunc* create ( Ref *  target, SEL_CallFunc  selector  )

static

Creates the action with the callback.

typedef void (Ref::*SEL_CallFunc)();

getTargetCallback()

Ref* getTargetCallback ( )

inline

Get the selector target.

Returns

The selector target.

setTargetCallback()

void setTargetCallback ( Ref *  sel )

inline

Set the selector target.

Parameters

sel	The selector target.

update()

virtual void update ( float  time )

overridevirtual

Parameters

time	In seconds.

Reimplemented from ActionInstant.

reverse()

virtual CallFunc* reverse ( void  ) const

overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns

A new action that performs the exact reverse of the action. NA

Reimplemented from ActionInstant.

clone()

virtual CallFunc* clone ( ) const

overridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from ActionInstant.

Reimplemented in CallFuncN, and LuaCallFunc.

initWithTarget()

bool initWithTarget ( Ref *  target )

protected

initializes the action with the callback typedef void (Ref::*SEL_CallFunc)();

---

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

• CCActionInstant.h