cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CallFuncN Class Reference

Calls a 'callback' with the node as the first argument. More...

#include <CCActionInstant.h>

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

Public Member Functions

virtual CallFuncNclone () const override
 Returns a clone of action. More...
 
local clone ()
 Returns a clone of action. More...
 
virtual void execute () override
 Executes the callback. More...
 
local execute ()
 Executes the callback. More...
 
bool initWithTarget (Ref *target, SEL_CallFuncN selector)
 initializes the action with the callback More...
 
local initWithTarget ( local target, local selector)
 initializes the action with the callback More...
 
- Public Member Functions inherited from CallFunc
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 exactly the reverse action. More...
 
local reverse ()
 Returns a new action that performs the exactly the reverse action. More...
 
CC_CONSTRUCTOR_ACCESS _callFunc (nullptr)
CC_CONSTRUCTOR_ACCESS _function (nullptr)
virtual ~CallFunc ()
var ~CallFunc ()
local ~CallFunc ()
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
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...
 
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. More...
 
var startWithTarget ( var target)
 Called before the action start. More...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
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...
 
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...
 
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...
 
local 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...
 
virtual ~Action ()
var ~Action ()
local ~Action ()
- 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 ()
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static CallFuncNcreate (const std::function< void(Node *)> &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 CallFuncNcreate (Ref *target, SEL_CallFuncN selector)
 Creates the action with the callback. More...
 
local create ( local target, local selector)
 Creates the action with the callback. More...
 
- Static Public Member Functions inherited from CallFunc
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 CallFunccreate (Ref *target, SEL_CallFunc selector)
 Creates the action with the callback. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: CallFuncN():_functionN(nullptr){} virtual ~CallFuncN(){} bool initWithFunction(const std::function<void(Node*)>& func)
local __pad0__: CallFuncN():_functionN(nullptr){} virtual ~CallFuncN(){} bool initWithFunction(const std::function<void(Node*)>& func)
- Public Attributes inherited from CallFunc
CC_CONSTRUCTOR_ACCESS __pad0__: CallFunc() : _selectorTarget(nullptr)
local __pad0__: CallFunc() : _selectorTarget(nullptr)
- Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
var __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
local __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()

Protected Attributes

std::function< void(Node *)> _functionN
 function that will be called with the "sender" as the 1st argument More...
 
local _functionN
 function that will be called with the "sender" as the 1st argument More...
 
- Protected Attributes inherited from CallFunc
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 Action
Node_originalTarget
Node_target
 The "target". More...
 
int _tag
 The action tag. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _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 Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Detailed Description

Calls a 'callback' with the node as the first argument.

N means Node.

Member Function Documentation

virtual CallFuncN* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from CallFunc.

Reimplemented in LuaCallFunc.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from CallFunc.

Reimplemented in LuaCallFunc.

static CallFuncN* create ( const std::function< void(Node *)> &  func)
static

Creates the action with the callback of type std::function<void()>.

This is the preferred way to create the callback.

Parameters
funcA callback function need to be excuted.
Returns
An autoreleased CallFuncN 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.

Parameters
funcA callback function need to be excuted.
Returns
An autoreleased CallFuncN object.
static CallFuncN* create ( Ref target,
SEL_CallFuncN  selector 
)
static

Creates the action with the callback.

typedef void (Ref::SEL_CallFuncN)(Node);

Deprecated:
Use the std::function API instead.
local create ( local  target,
local  selector 
)
static

Creates the action with the callback.

typedef void (Ref::SEL_CallFuncN)(Node);

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

Executes the callback.

Reimplemented from CallFunc.

Reimplemented in LuaCallFunc.

local execute ( )
overridevirtual

Executes the callback.

Reimplemented from CallFunc.

Reimplemented in LuaCallFunc.

bool initWithTarget ( Ref target,
SEL_CallFuncN  selector 
)

initializes the action with the callback

typedef void (Ref::SEL_CallFuncN)(Node);

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

initializes the action with the callback

typedef void (Ref::SEL_CallFuncN)(Node);

Deprecated:
Use the std::function API instead.

Member Data Documentation

local __pad0__
std::function<void(Node*)>
_functionN
protected

function that will be called with the "sender" as the 1st argument

local _functionN
protected

function that will be called with the "sender" as the 1st argument


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