cocos2d-x  3.1rc0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CallFunc Class Reference

Calls a 'callback'. More...

#include <CCActionInstant.h>

Inheritance diagram for CallFunc:
ActionInstant FiniteTimeAction Action Ref Clonable __CCCallFuncND __CCCallFuncO CallFuncN LuaCallFunc

Public Member Functions

virtual void execute ()
 executes the callback More...
 
var execute ()
 executes the callback More...
 
local execute ()
 executes the callback More...
 
RefgetTargetCallback ()
void setTargetCallback (Ref *sel)
local setTargetCallback ( local sel)
virtual void update (float time) override
 called once per frame. More...
 
local update ( local time)
 called once per frame. More...
 
virtual CallFuncreverse () const override
 returns a new action that performs the exactly the reverse action More...
 
local reverse ()
 returns a new action that performs the exactly the reverse action More...
 
virtual CallFuncclone () const override
 returns a clone of action More...
 
local clone ()
 returns a clone of action More...
 
CC_CONSTRUCTOR_ACCESS _callFunc (nullptr)
var _callFunc ( var nullptr)
local _callFunc ( local nullptr)
CC_CONSTRUCTOR_ACCESS _function (nullptr)
virtual ~CallFunc ()
var ~CallFunc ()
local ~CallFunc ()
CC_DEPRECATED_ATTRIBUTE 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...
 
- Public Member Functions inherited from ActionInstant
virtual bool isDone () const override
 return true if the action has finished More...
 
local isDone ()
 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
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
virtual void startWithTarget (Node *target)
 called before the action start. It will also set the target. More...
 
virtual void stop ()
 called after the action has finished. More...
 
NodegetTarget () const
var getTarget ()
local getTarget ()
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
var getOriginalTarget ()
local getOriginalTarget ()
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
int getTag () const
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- 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 ()
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
CC_DEPRECATED_ATTRIBUTE Refcopy () const
 returns a copy of the Ref. More...
 
local copy ()
 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...
 
var create ( var func)
 creates the action with the callback of type std::function<void()>. More...
 
static CC_DEPRECATED_ATTRIBUTE
CallFunc
create (Ref *target, SEL_CallFunc selector)
 creates the action with the callback More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: CallFunc() : _selectorTarget(nullptr)
local __pad0__: CallFunc() : _selectorTarget(nullptr)

Protected Attributes

Ref_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...
 
var _function
 function that will be called More...
 
local _function
 function that will be called More...
 
- Protected Attributes inherited from FiniteTimeAction
float _duration
 duration in seconds More...
 
- Protected Attributes inherited from Action
Node_originalTarget
local _originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from FiniteTimeAction
 FiniteTimeAction ()
virtual ~FiniteTimeAction ()
- Protected Member Functions inherited from Action
 Action ()
 Action ()
 Action ()
virtual ~Action ()
local ~Action ()
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Detailed Description

Calls a 'callback'.

Constructor & Destructor Documentation

virtual ~CallFunc ( )
virtual
var ~CallFunc ( )
virtual
local ~CallFunc ( )
virtual

Member Function Documentation

CC_CONSTRUCTOR_ACCESS _callFunc ( nullptr  )
var _callFunc ( var  )
local _callFunc ( local  )
CC_CONSTRUCTOR_ACCESS _function ( nullptr  )
inline
var _function ( var  )
inline
local _function ( local  )
inline
virtual CallFunc* clone ( ) const
overridevirtual

returns a clone of action

Implements ActionInstant.

Reimplemented in __CCCallFuncO, __CCCallFuncND, CallFuncN, and LuaCallFunc.

var clone ( )
overridevirtual

returns a clone of action

Implements ActionInstant.

Reimplemented in __CCCallFuncO, __CCCallFuncND, CallFuncN, and LuaCallFunc.

local clone ( )
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)

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

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 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
( Ref target,
SEL_CallFunc  selector 
)
static

creates the action with the callback

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

Deprecated:
Use the std::function API instead.
virtual void execute ( )
virtual

executes the callback

Reimplemented in __CCCallFuncO, __CCCallFuncND, CallFuncN, and LuaCallFunc.

var execute ( )
virtual

executes the callback

Reimplemented in __CCCallFuncO, __CCCallFuncND, CallFuncN, and LuaCallFunc.

local execute ( )
virtual

executes the callback

Reimplemented in __CCCallFuncO, __CCCallFuncND, CallFuncN, and LuaCallFunc.

Ref* getTargetCallback ( )
inline
var getTargetCallback ( )
inline
local getTargetCallback ( )
inline
bool initWithFunction ( const std::function< void()> &  func)

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

CC_DEPRECATED_ATTRIBUTE bool
initWithTarget
( Ref target)

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

Deprecated:
Use the std::function API instead.
var initWithTarget ( var  target)

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

Deprecated:
Use the std::function API instead.
local initWithTarget ( local  target)

initializes the action with the callback typedef void (Ref::*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.

var reverse ( )
overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInstant.

local reverse ( )
overridevirtual

returns a new action that performs the exactly the reverse action

Implements ActionInstant.

void setTargetCallback ( Ref sel)
inline
var setTargetCallback ( var  sel)
inline
local setTargetCallback ( local  sel)
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.

var update ( var  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.

local update ( local  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 { ... }
union { ... }
union { ... }
var __pad0__
local __pad0__
SEL_CallFunc _callFunc
var _callFunc
local _callFunc
SEL_CallFuncN _callFuncN
var _callFuncN
local _callFuncN
std::function<void()> _function
protected

function that will be called

var _function
protected

function that will be called

local _function
protected

function that will be called

Ref* _selectorTarget
protected

Target that will be called.

var _selectorTarget
protected

Target that will be called.

local _selectorTarget
protected

Target that will be called.


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