Cocos2d-x  v4
ShuffleTiles Class Reference

ShuffleTiles action. More...

Inherits TiledGrid3DAction.

Public Member Functions

virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
virtual void update (float time) override
 Called once per frame. More...
 
virtual ShuffleTilesclone () const override
 Returns a clone of action. More...
 
- Public Member Functions inherited from TiledGrid3DAction
Quad3 getTile (const Vec2 &position) const
 Get the tile that belongs to a certain position of the grid. More...
 
Quad3 getOriginalTile (const Vec2 &position) const
 Get the non-transformed tile that belongs to a certain position of the grid. More...
 
void setTile (const Vec2 &position, const Quad3 &coords)
 Set a new tile to a certain position of the grid. More...
 
virtual GridBasegetGrid () override
 returns the grid
 
- Public Member Functions inherited from GridAction
virtual GridActionreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
- Public Member Functions inherited from ActionInterval
float 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...
 
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
 @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
 

Static Public Member Functions

static ShuffleTilescreate (float duration, const Size &gridSize, unsigned int seed)
 Create the action with grid size, random seed and duration. More...
 
- Static Public Member Functions inherited from TiledGrid3DAction
static TiledGrid3DActioncreate (float duration, const Size &gridSize)
 Create the action with size and duration. More...
 

Protected Member Functions

bool initWithDuration (float duration, const Size &gridSize, unsigned int seed)
 Initializes the action with grid size, random seed and duration. More...
 
- Protected Member Functions inherited from GridAction
bool initWithDuration (float duration, const Size &gridSize)
 Initializes the action with size and duration. More...
 
- Protected Member Functions inherited from ActionInterval
bool initWithDuration (float d)
 initializes the action
 

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

ShuffleTiles action.

This action make the target node shuffle with many tiles in random order. You can create the action by these parameters: duration, grid size, the random seed.

Member Function Documentation

◆ create()

static ShuffleTiles* create ( float  duration,
const Size &  gridSize,
unsigned int  seed 
)
static

Create the action with grid size, random seed and duration.

Parameters
durationSpecify the duration of the ShuffleTiles action. It's a value in seconds.
gridSizeSpecify the size of the grid.
seedSpecify the random seed.
Returns
If the creation success, return a pointer of ShuffleTiles action; otherwise, return nil.

◆ startWithTarget()

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from GridAction.

◆ update()

virtual void update ( float  time)
overridevirtual

Called once per frame.

time a value between 0 and 1.

For example:

  • 0 Means that the action just started.
  • 0.5 Means that the action is in the middle.
  • 1 Means that the action is over.
Parameters
timeA value between 0 and 1.

Reimplemented from Action.

◆ clone()

virtual ShuffleTiles* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from TiledGrid3DAction.

◆ initWithDuration()

bool initWithDuration ( float  duration,
const Size &  gridSize,
unsigned int  seed 
)
protected

Initializes the action with grid size, random seed and duration.

Parameters
durationSpecify the duration of the ShuffleTiles action. It's a value in seconds.
gridSizeSpecify the size of the grid.
seedSpecify the random seed.
Returns
If the Initialization success, return true; otherwise, return false.

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