cocos2d-x  3.0Beta0
 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 Object Clonable __CCCallFuncND __CCCallFuncO CallFuncN LuaCallFunc

Public Member Functions

virtual void execute ()
 executes the callback More...
 
ObjectgetTargetCallback ()
local getTargetCallback ()
void setTargetCallback (Object *sel)
var setTargetCallback ( var sel)
local setTargetCallback ( local sel)
virtual void update (float time) override
 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...
 
var clone ()
 returns a clone of action More...
 
local clone ()
 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
 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...
 
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...
 
var setDuration ( var 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 std::string 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 ()
 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
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
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
var getTag ()
local getTag ()
void setTag (int tag)
var setTag ( var tag)
local setTag ( local tag)
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 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...
 
local retainCount ()
 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 ()
Objectcopy () const
 returns a copy of the object. More...
 
var copy ()
 returns a copy of the object. More...
 
local copy ()
 returns a copy of the object. 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 (Object *target, SEL_CallFunc selector)
 creates the action with the callback More...
 

Protected Member Functions

 CallFunc ()
virtual ~CallFunc ()
CC_DEPRECATED_ATTRIBUTE bool initWithTarget (Object *target)
 initializes the action with the callback typedef void (Object::*SEL_CallFunc)(); More...
 
local initWithTarget ( local target)
 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...
 

Protected Attributes

Object_selectorTarget
 Target that will be called. More...
 
local _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...
 

Additional Inherited Members

- Public Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 
var _luaID
 Lua reference id. More...
 
local _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 ( )
inlineprotected
var CallFunc ( )
inlineprotected
local CallFunc ( )
inlineprotected
virtual ~CallFunc ( )
protectedvirtual
var ~CallFunc ( )
protectedvirtual
local ~CallFunc ( )
protectedvirtual

Member Function Documentation

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
( Object target,
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.

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.

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

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

CC_DEPRECATED_ATTRIBUTE bool
initWithTarget
( Object target)
protected

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

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

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

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

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.

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 ( Object 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 { ... }
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

Object* _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: