Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
CallFunc Class Reference

Calls a 'callback'. More...

Inherits ActionInstant.

Inherited by __CCCallFuncND, __CCCallFuncO, and CallFuncN.

Public Member Functions

virtual void execute ()
 Executes the callback.
 
var execute ()
 Executes the callback.
 
local execute ()
 Executes the callback.
 
RefgetTargetCallback ()
 Get the selector target. More...
 
local getTargetCallback ()
 Get the selector target. More...
 
void setTargetCallback (Ref *sel)
 Set the selector target. More...
 
local setTargetCallback ( local sel)
 Set the selector target. More...
 
virtual void update (float time) override
local update ( local time)
virtual CallFuncreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
var reverse ()
 Returns a new action that performs the exact reverse of the action. More...
 
local reverse ()
 Returns a new action that performs the exact reverse of the action. More...
 
virtual CallFuncclone () const override
 Returns a clone of action. More...
 
local clone ()
 Returns a clone of action. More...
 
- Public Member Functions inherited from ActionInstant
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
virtual bool isDone () const override
 Return true if the action has finished. More...
 
var isDone ()
 Return true if the action has finished. More...
 
local isDone ()
 Return true if the action has finished. More...
 
virtual void step (float dt) override
var step ( var dt)
local step ( local dt)
- Public Member Functions inherited from FiniteTimeAction
float getDuration () const
 Get duration in seconds of the action. More...
 
var getDuration ()
 Get duration in seconds of the action. More...
 
local getDuration ()
 Get duration in seconds of the action. More...
 
void setDuration (float duration)
 Set duration in seconds of the action. More...
 
local setDuration ( local duration)
 Set duration in seconds of the action. More...
 
- Public Member Functions inherited from Action
virtual void stop ()
 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...
 
NodegetTarget () const
 Return certain target. More...
 
var getTarget ()
 Return certain target. More...
 
local getTarget ()
 Return certain target. More...
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
var setTarget ( var target)
 The action will modify the target properties. More...
 
local setTarget ( local target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
 Return a original Target. More...
 
var getOriginalTarget ()
 Return a original Target. More...
 
local getOriginalTarget ()
 Return a original Target. More...
 
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
local setOriginalTarget ( local 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...
 
var getTag ()
 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...
 
var setTag ( var tag)
 Changes the tag that is used to identify the action easily. More...
 
local setTag ( local 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...
 
var getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
local getFlags ()
 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...
 
local 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...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 
- Public Member Functions inherited from Clonable
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static CallFunccreate (const std::function< void()> &func)
 Creates the action with the callback of type std::function<void()>. More...
 
local create ( local func)
 Creates the action with the callback of type std::function<void()>. More...
 
static CallFunccreate (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...
 
var initWithTarget ( var target)
 initializes the action with the callback typedef void (Ref::*SEL_CallFunc)(); More...
 
local initWithTarget ( local 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()> More...
 
var initWithFunction ( var func)
 initializes the action with the std::function<void()> More...
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _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...
 
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'.

Member Function Documentation

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.
var create ( var  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.
local create ( local  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.
static CallFunc* create ( Ref target,
SEL_CallFunc  selector 
)
static

Creates the action with the callback.

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

Ref* getTargetCallback ( )
inline

Get the selector target.

Returns
The selector target.
var getTargetCallback ( )
inline

Get the selector target.

Returns
The selector target.
local getTargetCallback ( )
inline

Get the selector target.

Returns
The selector target.
void setTargetCallback ( Ref sel)
inline

Set the selector target.

Parameters
selThe selector target.
var setTargetCallback ( var  sel)
inline

Set the selector target.

Parameters
selThe selector target.
local setTargetCallback ( local  sel)
inline

Set the selector target.

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

Reimplemented from ActionInstant.

var update ( var  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from ActionInstant.

local update ( local  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from ActionInstant.

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.

Reimplemented from ActionInstant.

var reverse (   )
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.

Reimplemented from ActionInstant.

local reverse (   )
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.

Reimplemented from ActionInstant.

virtual CallFunc* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInstant.

Reimplemented in CallFuncN, and LuaCallFunc.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInstant.

Reimplemented in CallFuncN, and LuaCallFunc.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInstant.

Reimplemented in CallFuncN, and LuaCallFunc.

bool initWithTarget ( Ref target)
protected

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

var initWithTarget ( var  target)
protected

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

local initWithTarget ( local  target)
protected

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

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

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

var initWithFunction ( var  func)
protected

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


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