Cocos2d-x  v4
ActionInstant Class Reference

Instant actions are immediate actions. They don't have a duration like the IntervalAction actions. More...

Inherits FiniteTimeAction.

Inherited by CallFunc, FlipX, FlipY, Hide, Place, RemoveSelf, ReuseGrid, Show, StopGrid, and ToggleVisibility.

Public Member Functions

virtual ActionInstantclone () const override
 Returns a clone of action. More...
 
virtual ActionInstantreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
virtual bool isDone () const override
 Return true if the action has finished. More...
 
virtual void step (float dt) override
 
virtual void update (float time) 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
 @js NA @lua NA
 
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 ()
 @js NA @lua NA
 

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.
 

Detailed Description

Instant actions are immediate actions. They don't have a duration like the IntervalAction actions.

Member Function Documentation

◆ clone()

virtual ActionInstant* clone ( ) const
inlineoverridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from FiniteTimeAction.

Reimplemented in ReuseGrid, CallFuncN, StopGrid, CallFunc, Place, FlipY, FlipX, RemoveSelf, ToggleVisibility, Hide, Show, and LuaCallFunc.

◆ reverse()

virtual ActionInstant* reverse ( ) const
inlineoverridevirtual

Returns a new action that performs the exact reverse of the action.

Returns
A new action that performs the exact reverse of the action. @js NA

Reimplemented from FiniteTimeAction.

Reimplemented in ReuseGrid, StopGrid, CallFunc, Place, FlipY, FlipX, RemoveSelf, ToggleVisibility, Hide, and Show.

◆ startWithTarget()

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from Action.

Reimplemented in ReuseGrid, and StopGrid.

◆ isDone()

virtual bool isDone ( ) const
overridevirtual

Return true if the action has finished.

Returns
Is true if the action has finished.

Reimplemented from Action.

◆ step()

virtual void step ( float  dt)
overridevirtual
Parameters
dtIn seconds.

Reimplemented from Action.

◆ update()

virtual void update ( float  time)
overridevirtual
Parameters
timeIn seconds.

Reimplemented from Action.

Reimplemented in CallFunc, Place, FlipY, FlipX, RemoveSelf, ToggleVisibility, Hide, and Show.


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