Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
LuaCallFunc Class Reference

The LuaCallFunc is wrapped to call the callback function in the Lua conveniently and don't insert useless code to processing the Lua in the CallFuncN. More...

Inherits CallFuncN.

Public Member Functions

 LuaCallFunc ()
 Default constructor.
 
virtual ~LuaCallFunc ()
 Destructor.
 
bool initWithFunction (const std::function< void(void *self, Node *)> &func)
 Init a LuaCallFunc object by a function pointer for callback. More...
 
virtual LuaCallFuncclone () const override
 Returns a clone of action. More...
 
virtual void execute () override
 Executes the callback.
 
- 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
 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...
 
- 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 its delta time, dt in seconds. More...
 
local step ( local dt)
 Called every frame with its delta time, dt in seconds. 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 void startWithTarget (Node *target)
 Called before the action start. More...
 
virtual void stop ()
 Called after the action that has finished. More...
 
NodegetTarget () const
 Return the current target. More...
 
void setTarget (Node *target)
 The setter function for the target property. More...
 
var setTarget ( var target)
 The setter function for the target property. More...
 
local setTarget ( local target)
 The setter function for the target property. More...
 
NodegetOriginalTarget () const
 Return the original Target. More...
 
var getOriginalTarget ()
 Return the original Target. More...
 
local getOriginalTarget ()
 Return the original Target. More...
 
void setOriginalTarget (Node *originalTarget)
 Set the original target, since target can be nil. More...
 
var setOriginalTarget ( var 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...
 
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...
 
unsigned int getFlags () const
 Returns a flag field that is used to group the actions easily. More...
 
void setFlags (unsigned int flags)
 Returns a flag field that is used to group the actions easily. More...
 
var setFlags ( var flags)
 Returns a flag field that is used to group the actions easily. More...
 
local setFlags ( local flags)
 Returns a flag field that is used to group the actions easily. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
local 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...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 
- Public Member Functions inherited from Clonable
Refcopy () const
 Returns a copy of the Ref.
 

Static Public Member Functions

static LuaCallFunccreate (const std::function< void(void *self, Node *)> &func)
 Create a LuaCallFunc object by a function pointer for callback. More...
 
- Static Public Member Functions inherited from CallFuncN
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...
 
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 typedef void (Ref::*SEL_CallFunc)(); Use the std::function API instead.
 

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.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
local _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions.
 
var INVALID_TAG = -1
 Default tag used for all the actions.
 
local INVALID_TAG = -1
 Default tag used for all the actions.
 
- Protected Member Functions inherited from CallFuncN
bool initWithFunction (const std::function< void(Node *)> &func)
 initializes the action with the std::function<void(Node*)>
 
local initWithFunction ( local func)
 initializes the action with the std::function<void(Node*)>
 
bool initWithTarget (Ref *target, SEL_CallFuncN selector)
 initializes the action with the callback typedef void (Ref::SEL_CallFuncN)(Node);
 
- Protected Member Functions inherited from CallFunc
bool initWithTarget (Ref *target)
 Initializes the action with the callback typedef void (Ref::*SEL_CallFunc)();.
 
var initWithTarget ( var target)
 Initializes the action with the callback typedef void (Ref::*SEL_CallFunc)();.
 
local initWithTarget ( local target)
 Initializes the action with the callback typedef void (Ref::*SEL_CallFunc)();.
 
bool initWithFunction (const std::function< void()> &func)
 initializes the action with the std::function<void()>
 
var initWithFunction ( var func)
 initializes the action with the std::function<void()>
 

Detailed Description

The LuaCallFunc is wrapped to call the callback function in the Lua conveniently and don't insert useless code to processing the Lua in the CallFuncN.

Member Function Documentation

static LuaCallFunc* create ( const std::function< void(void *self, Node *)> &  func)
static

Create a LuaCallFunc object by a function pointer for callback.

a function pointer for callback.

bool initWithFunction ( const std::function< void(void *self, Node *)> &  func)

Init a LuaCallFunc object by a function pointer for callback.

a function pointer for callback.

virtual LuaCallFunc* clone ( ) const
overridevirtual

Returns a clone of action.

A clone action.

Reimplemented from CallFuncN.


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