Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Sequence Class Reference

Runs actions sequentially, one after another. More...

Inherits ActionInterval.

Public Types

typedef FiniteTimeActionM
 Helper constructor to create an array of sequenceable actions. More...
 

Public Member Functions

virtual Sequenceclone () const override
 Returns a clone of action. More...
 
virtual Sequencereverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
local reverse ()
 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...
 
local startWithTarget ( local target)
 Called before the action start. More...
 
virtual void stop () override
 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...
 
virtual bool isDone () const override
 Return true if the action has finished. More...
 
var isDone ()
 Return true if the action has finished. More...
 
local isDone ()
 Return true if the action has finished. More...
 
virtual void update (float t) override
- Public Member Functions inherited from ActionInterval
float getElapsed ()
 How many seconds had elapsed since the actions started to run. More...
 
var getElapsed ()
 How many seconds had elapsed since the actions started to run. More...
 
local getElapsed ()
 How many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
 Sets the amplitude rate, extension in GridAction. More...
 
float getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
var getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
local getAmplitudeRate ()
 Gets the amplitude rate, extension in GridAction. More...
 
virtual void step (float dt) override
- 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...
 
local setDuration ( local duration)
 Set duration in seconds of the action. More...
 
- Public Member Functions inherited from Action
NodegetTarget () const
 Return certain target. More...
 
var getTarget ()
 Return certain target. More...
 
local getTarget ()
 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...
 
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...
 
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...
 
var getFlags ()
 Returns a flag field that is used to group the actions easily. More...
 
local getFlags ()
 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...
 
local 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. More...
 
- Public Member Functions inherited from Clonable
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static Sequencecreate (const Vector< FiniteTimeAction * > &arrayOfActions)
 Helper constructor to create an array of sequenceable actions given an array. More...
 
local create ( local arrayOfActions)
 Helper constructor to create an array of sequenceable actions given an array. More...
 
static SequencecreateWithVariableList (FiniteTimeAction *action1, va_list args)
 Helper constructor to create an array of sequence-able actions. More...
 
static SequencecreateWithTwoActions (FiniteTimeAction *actionOne, FiniteTimeAction *actionTwo)
 Creates the action. More...
 
local createWithTwoActions ( local actionOne, local actionTwo)
 Creates the action. More...
 

Protected Member Functions

bool initWithTwoActions (FiniteTimeAction *pActionOne, FiniteTimeAction *pActionTwo)
 initializes the action
 
var initWithTwoActions ( var pActionOne, var pActionTwo)
 initializes the action
 
local initWithTwoActions ( local pActionOne, local pActionTwo)
 initializes the action
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action
 
var initWithDuration ( var d)
 initializes the action
 
local initWithDuration ( local d)
 initializes the action
 

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.
 
- 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

Runs actions sequentially, one after another.

Member Typedef Documentation

typedef FiniteTimeAction* M

Helper constructor to create an array of sequenceable actions.

Returns
An autoreleased Sequence object.
var M

Helper constructor to create an array of sequenceable actions.

Returns
An autoreleased Sequence object.
local M

Helper constructor to create an array of sequenceable actions.

Returns
An autoreleased Sequence object.

Member Function Documentation

static Sequence* create ( const Vector< FiniteTimeAction * > &  arrayOfActions)
static

Helper constructor to create an array of sequenceable actions given an array.

When this function bound to the js or lua,the input params changed
in js :var create(var object1,var object2, ...)
in lua :local create(local object1,local object2, ...)
Parameters
arrayOfActionsAn array of sequenceable actions.
Returns
An autoreleased Sequence object.
var create ( var  arrayOfActions)
static

Helper constructor to create an array of sequenceable actions given an array.

When this function bound to the js or lua,the input params changed
in js :var create(var object1,var object2, ...)
in lua :local create(local object1,local object2, ...)
Parameters
arrayOfActionsAn array of sequenceable actions.
Returns
An autoreleased Sequence object.
local create ( local  arrayOfActions)
static

Helper constructor to create an array of sequenceable actions given an array.

When this function bound to the js or lua,the input params changed
in js :var create(var object1,var object2, ...)
in lua :local create(local object1,local object2, ...)
Parameters
arrayOfActionsAn array of sequenceable actions.
Returns
An autoreleased Sequence object.
static Sequence*
createWithVariableList
( FiniteTimeAction action1,
va_list  args 
)
static

Helper constructor to create an array of sequence-able actions.

Parameters
action1The first sequenceable action.
argsThe va_list variable.
Returns
An autoreleased Sequence object.
local createWithVariableList ( local  action1,
local  args 
)
static

Helper constructor to create an array of sequence-able actions.

Parameters
action1The first sequenceable action.
argsThe va_list variable.
Returns
An autoreleased Sequence object.
static Sequence*
createWithTwoActions
( FiniteTimeAction actionOne,
FiniteTimeAction actionTwo 
)
static

Creates the action.

Parameters
actionOneThe first sequenceable action.
actionTwoThe second sequenceable action.
Returns
An autoreleased Sequence object.
local createWithTwoActions ( local  actionOne,
local  actionTwo 
)
static

Creates the action.

Parameters
actionOneThe first sequenceable action.
actionTwoThe second sequenceable action.
Returns
An autoreleased Sequence object.
virtual Sequence* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

virtual Sequence* reverse ( void  ) const
overridevirtual

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

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

Reimplemented from ActionInterval.

var reverse (   )
overridevirtual

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

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

Reimplemented from ActionInterval.

local reverse (   )
overridevirtual

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

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

Reimplemented from ActionInterval.

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

var startWithTarget ( var  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

local startWithTarget ( local  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

virtual void stop ( )
overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

var stop ( )
overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

local stop ( )
overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

virtual bool isDone ( ) const
overridevirtual

Return true if the action has finished.

Returns
Is true if the action has finished.

Reimplemented from ActionInterval.

var isDone ( )
overridevirtual

Return true if the action has finished.

Returns
Is true if the action has finished.

Reimplemented from ActionInterval.

local isDone ( )
overridevirtual

Return true if the action has finished.

Returns
Is true if the action has finished.

Reimplemented from ActionInterval.

virtual void update ( float  t)
overridevirtual
Parameters
tIn seconds.

Reimplemented from Action.

var update ( var  t)
overridevirtual
Parameters
tIn seconds.

Reimplemented from Action.

local update ( local  t)
overridevirtual
Parameters
tIn seconds.

Reimplemented from Action.


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