Calls a 'callback'. More...

#include <CCActionInstant.h>

Inheritance diagram for CallFunc:

Public Member Functions
	CallFunc ()
virtual	~CallFunc ()
CC_DEPRECATED_ATTRIBUTE bool	initWithTarget (Object *pSelectorTarget)
	initializes the action with the callback typedef void (Object::*SEL_CallFunc)(); More...

bool	initWithFunction (const std::function< void()> &func)
	initializes the action with the std::function<void()> More...

virtual void	execute ()
	executes the callback More...

Object *	getTargetCallback ()
void	setTargetCallback (Object *pSel)
virtual void	update (float time) override
	called once per frame. More...

virtual CallFunc *	reverse () const override
	returns a new action that performs the exactly the reverse action More...

virtual CallFunc *	clone () const override
	returns a clone of action More...

Public Member Functions inherited from ActionInstant
virtual bool	isDone (void) const override
	return true if the action has finished More...

virtual void	step (float dt) override
	called every frame with it's delta time. DON'T override unless you know what you are doing. More...

local	step ( local dt)
	called every frame with it's delta time. DON'T override unless you know what you are doing. More...

Public Member Functions inherited from FiniteTimeAction
	FiniteTimeAction ()
virtual	~FiniteTimeAction ()
float	getDuration (void) 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
	Action (void)
	ctor ()
	Action ()
virtual	~Action (void)
const char *	description () const
virtual void	startWithTarget (Node *target)
	called before the action start. It will also set the target. More...

var	startWithTarget ( var target)
	called before the action start. It will also set the target. More...

local	startWithTarget ( local target)
	called before the action start. It will also set the target. More...

virtual void	stop (void)
	called after the action has finished. More...

var	stop ()
	called after the action has finished. More...

local	stop ()
	called after the action has finished. More...

Node *	getTarget (void) const
void	setTarget (Node *target)
	The action will modify the target properties. More...

Node *	getOriginalTarget (void) const
local	getOriginalTarget ()
void	setOriginalTarget (Node *pOriginalTarget)
	Set the original target, since target can be nil. More...

int	getTag (void) const
void	setTag (int nTag)
Public Member Functions inherited from Object
	Object ()
	Constructor. More...

virtual	~Object ()
void	release ()
	Release the ownership immediately. More...

void	retain ()
	Retains the ownership. More...

Object *	autorelease ()
	Release the ownership sometime soon automatically. More...

bool	isSingleReference () const
	Returns a boolean value that indicates whether there is only one reference to the object. More...

unsigned int	retainCount () const
	Returns the object's current reference count. More...

virtual bool	isEqual (const Object *object)
	Returns a boolean value that indicates whether this object and a given object are equal. More...

virtual void	acceptVisitor (DataVisitor &visitor)
Public Member Functions inherited from Clonable
virtual	~Clonable ()
CC_DEPRECATED_ATTRIBUTE Object *	copy () const
	returns a copy of the object. More...

local	copy ()
	returns a copy of the object. 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 CC_DEPRECATED_ATTRIBUTE CallFunc *	create (Object *pSelectorTarget, SEL_CallFunc selector)
	creates the action with the callback More...

Protected Attributes
Object *	_selectorTarget
	Target that will be called. More...

union {
SEL_CallFunc _callFunc
var _callFunc
local _callFunc
SEL_CallFuncN _callFuncN
var _callFuncN
local _callFuncN
};
std::function< void()>	_function
	function that will be called More...

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID More...

int	_luaID
	Lua reference id. More...

Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions. More...

var	INVALID_TAG = -1
	Default tag used for all the actions. More...

local	INVALID_TAG = -1
	Default tag used for all the actions. More...

Detailed Description

Calls a 'callback'.

Constructor & Destructor Documentation

CallFunc ( )

inline

virtual ~CallFunc ( )

virtual

Member Function Documentation

virtual CallFunc* clone ( ) const

overridevirtual

returns a clone of action

Implements ActionInstant.

Reimplemented in __CCCallFuncO, __CCCallFuncND, CallFuncN, and LuaCallFunc.

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 funtion 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)

static CC_DEPRECATED_ATTRIBUTE CallFunc* create	(	Object *	pSelectorTarget,
		SEL_CallFunc	selector
	)

static

creates the action with the callback

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

Deprecated:: Use the std::function API instead.

virtual void execute ( )

virtual

executes the callback

Reimplemented in __CCCallFuncO, __CCCallFuncND, CallFuncN, and LuaCallFunc.

Object* getTargetCallback ( )

inline

bool initWithFunction ( const std::function< void()> & func)

initializes the action with the std::function<void()>

CC_DEPRECATED_ATTRIBUTE bool
initWithTarget ( Object * pSelectorTarget)

initializes the action with the callback

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

Deprecated:: Use the std::function API instead.

virtual CallFunc* reverse ( ) const

overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInstant.

void setTargetCallback ( Object * pSel)

inline

virtual void update ( float time)

overridevirtual

called once per frame.

time a value between 0 and 1

For example:

0 means that the action just started
0.5 means that the action is in the middle
1 means that the action is over

Reimplemented from ActionInstant.

Member Data Documentation

union { ... }

SEL_CallFunc _callFunc

SEL_CallFuncN _callFuncN

std::function<void()> _function

protected

function that will be called

Object* _selectorTarget

protected

Target that will be called.

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

/Users/cocos2d/MyWork/cocos2d-x-develop/cocos2dx/actions/CCActionInstant.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation