Cocos2d-x  v4
CallFunc Class Reference

Calls a 'callback'. More...

Inherits ActionInstant.

Inherited by CallFuncN.

Public Member Functions

virtual void execute ()
 Executes the callback.
 
virtual void update (float time) override
 
virtual CallFuncreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
virtual CallFuncclone () const override
 Returns a clone of 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...
 
NodegetTarget () const
 Return certain target. More...
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () 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...
 
Refautorelease ()
 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 CallFunccreate (const std::function< void()> &func)
 Creates the action with the callback of type std::function<void()>. More...
 

Protected Member Functions

bool initWithFunction (const std::function< void()> &func)
 initializes the action with the std::function<void()> @lua 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.
 

Detailed Description

Calls a 'callback'.

Member Function Documentation

◆ create()

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
funcA callback function need to be executed.
Returns
An autoreleased CallFunc object.

◆ update()

virtual void update ( float  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from ActionInstant.

◆ reverse()

virtual CallFunc* reverse ( ) 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. @js 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.


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