Cocos2d-x  v3.15
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...

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

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...
 
void setTargetCallback (Ref *sel)
 Set the selector target. More...
 
virtual void update (float time) override
 
virtual CallFuncreverse () const override
 Returns a new action that performs the exact reverse of the 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
 
- 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
 NA NA
 
virtual void startWithTarget (Node *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...
 
NodegetOriginalTarget () const
 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...
 
void setTag (int 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)
 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...
 
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 ()
 NA NA
 
Refcopy () const
 Returns a copy of the Ref. More...
 

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...
 
static CallFuncNcreate (Ref *target, SEL_CallFuncN 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...
 
static CallFunccreate (Ref *target, SEL_CallFunc selector)
 Creates the action with the callback. More...
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
bool _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...
 
- Protected Member Functions inherited from CallFuncN
bool initWithFunction (const std::function< void(Node *)> &func)
 initializes the action with the std::function<void(Node*)>
 
bool initWithTarget (Ref *target, SEL_CallFuncN selector)
 initializes the action with the callback More...
 
- Protected Member Functions inherited from CallFunc
bool initWithTarget (Ref *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()> NA
 

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.

NA NA

Member Function Documentation

◆ create()

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

Create a LuaCallFunc object by a function pointer for callback.

Parameters
funca function pointer for callback.

◆ initWithFunction()

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

Init a LuaCallFunc object by a function pointer for callback.

Parameters
funca function pointer for callback.

◆ clone()

virtual LuaCallFunc* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from CallFuncN.


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