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

JumpTiles3D action. More...

Inherits TiledGrid3DAction.

Public Member Functions

float getAmplitude () const
 Get the amplitude of the effect. More...
 
local getAmplitude ()
 Get the amplitude of the effect. More...
 
void setAmplitude (float amplitude)
 Set the amplitude to the effect. More...
 
local setAmplitude ( local amplitude)
 Set the amplitude to the effect. More...
 
float getAmplitudeRate () const
 Get the amplitude rate of the effect. More...
 
local getAmplitudeRate ()
 Get the amplitude rate of the effect. More...
 
void setAmplitudeRate (float amplitudeRate)
 Set the amplitude rate of the effect. More...
 
local setAmplitudeRate ( local amplitudeRate)
 Set the amplitude rate of the effect. More...
 
virtual JumpTiles3Dclone () const override
 Returns a clone of action. More...
 
virtual void update (float time) override
 Called once per frame. More...
 
local update ( local time)
 Called once per frame. 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 tile (const Vec2 &position)
Quad3 getOriginalTile (const Vec2 &position) const
 Get the non-transformed tile that belongs to a certain position of the grid. More...
 
Quad3 originalTile (const Vec2 &position)
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...
 
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...
 
- 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 bool isDone () const override
 Return true if the action has finished. More...
 
var isDone ()
 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...
 
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
virtual void stop ()
 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...
 
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 JumpTiles3Dcreate (float duration, const Size &gridSize, unsigned int numberOfJumps, float amplitude)
 Create the action with the number of jumps, the sin amplitude, the grid size and the 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 numberOfJumps, float amplitude)
 Initializes the action with the number of jumps, the sin amplitude, the grid size and the duration. More...
 
var initWithDuration ( var duration, var gridSize, var numberOfJumps, var amplitude)
 Initializes the action with the number of jumps, the sin amplitude, the grid size and the duration. More...
 
local initWithDuration ( local duration, local gridSize, local numberOfJumps, local amplitude)
 Initializes the action with the number of jumps, the sin amplitude, the grid size and the duration. More...
 
- Protected Member Functions inherited from GridAction
bool initWithDuration (float duration, const Size &gridSize)
 Initializes the action with size and duration. More...
 
var initWithDuration ( var duration, var gridSize)
 Initializes the action with size and duration. More...
 
local initWithDuration ( local duration, local gridSize)
 Initializes the action with size and duration. More...
 
- 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

JumpTiles3D action.

Move the tiles of a target node across the Z axis.

Member Function Documentation

static JumpTiles3D* create ( float  duration,
const Size &  gridSize,
unsigned int  numberOfJumps,
float  amplitude 
)
static

Create the action with the number of jumps, the sin amplitude, the grid size and the duration.

Parameters
durationSpecify the duration of the JumpTiles3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
numberOfJumpsSpecify the jump tiles count.
amplitudeSpecify the amplitude of the JumpTiles3D action.
Returns
If the creation success, return a pointer of JumpTiles3D action; otherwise, return nil.
var create ( var  duration,
var  gridSize,
var  numberOfJumps,
var  amplitude 
)
static

Create the action with the number of jumps, the sin amplitude, the grid size and the duration.

Parameters
durationSpecify the duration of the JumpTiles3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
numberOfJumpsSpecify the jump tiles count.
amplitudeSpecify the amplitude of the JumpTiles3D action.
Returns
If the creation success, return a pointer of JumpTiles3D action; otherwise, return nil.
local create ( local  duration,
local  gridSize,
local  numberOfJumps,
local  amplitude 
)
static

Create the action with the number of jumps, the sin amplitude, the grid size and the duration.

Parameters
durationSpecify the duration of the JumpTiles3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
numberOfJumpsSpecify the jump tiles count.
amplitudeSpecify the amplitude of the JumpTiles3D action.
Returns
If the creation success, return a pointer of JumpTiles3D action; otherwise, return nil.
float getAmplitude ( ) const
inline

Get the amplitude of the effect.

Returns
Return the amplitude of the effect.
var getAmplitude ( )
inline

Get the amplitude of the effect.

Returns
Return the amplitude of the effect.
local getAmplitude ( )
inline

Get the amplitude of the effect.

Returns
Return the amplitude of the effect.
void setAmplitude ( float  amplitude)
inline

Set the amplitude to the effect.

Parameters
amplitudeThe value of amplitude will be set.
var setAmplitude ( var  amplitude)
inline

Set the amplitude to the effect.

Parameters
amplitudeThe value of amplitude will be set.
local setAmplitude ( local  amplitude)
inline

Set the amplitude to the effect.

Parameters
amplitudeThe value of amplitude will be set.
float getAmplitudeRate ( ) const
inline

Get the amplitude rate of the effect.

Returns
Return the amplitude rate of the effect.
var getAmplitudeRate ( )
inline

Get the amplitude rate of the effect.

Returns
Return the amplitude rate of the effect.
local getAmplitudeRate ( )
inline

Get the amplitude rate of the effect.

Returns
Return the amplitude rate of the effect.
void setAmplitudeRate ( float  amplitudeRate)
inline

Set the amplitude rate of the effect.

Parameters
amplitudeRateThe value of amplitude rate will be set.
var setAmplitudeRate ( var  amplitudeRate)
inline

Set the amplitude rate of the effect.

Parameters
amplitudeRateThe value of amplitude rate will be set.
local setAmplitudeRate ( local  amplitudeRate)
inline

Set the amplitude rate of the effect.

Parameters
amplitudeRateThe value of amplitude rate will be set.
virtual JumpTiles3D* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from TiledGrid3DAction.

var clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from TiledGrid3DAction.

local clone ( )
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from TiledGrid3DAction.

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.

var update ( var  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.

local update ( local  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.

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

Initializes the action with the number of jumps, the sin amplitude, the grid size and the duration.

Parameters
durationSpecify the duration of the JumpTiles3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
numberOfJumpsSpecify the jump tiles count.
amplitudeSpecify the amplitude of the JumpTiles3D action.
Returns
If the initialization success, return true; otherwise, return false.
var initWithDuration ( var  duration,
var  gridSize,
var  numberOfJumps,
var  amplitude 
)
protected

Initializes the action with the number of jumps, the sin amplitude, the grid size and the duration.

Parameters
durationSpecify the duration of the JumpTiles3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
numberOfJumpsSpecify the jump tiles count.
amplitudeSpecify the amplitude of the JumpTiles3D action.
Returns
If the initialization success, return true; otherwise, return false.
local initWithDuration ( local  duration,
local  gridSize,
local  numberOfJumps,
local  amplitude 
)
protected

Initializes the action with the number of jumps, the sin amplitude, the grid size and the duration.

Parameters
durationSpecify the duration of the JumpTiles3D action. It's a value in seconds.
gridSizeSpecify the size of the grid.
numberOfJumpsSpecify the jump tiles count.
amplitudeSpecify the amplitude of the JumpTiles3D action.
Returns
If the initialization success, return true; otherwise, return false.

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