TurnOffTiles Class Reference

TurnOffTiles action. More...

Inherits TiledGrid3DAction.

Public Member Functions
void	shuffle (unsigned int *array, unsigned int len)
	Shuffle the array specified. More...
void	turnOnTile (const Vec2 &pos)
	Show the tile at specified position. More...
local	turnOnTile ( local pos)
	Show the tile at specified position. More...
void	turnOffTile (const Vec2 &pos)
	Hide the tile at specified position. More...
local	turnOffTile ( local pos)
	Hide the tile at specified position. More...
virtual TurnOffTiles *	clone () const override
	Returns a clone of action. More...
local	clone ()
	Returns a clone of action. More...
virtual void	startWithTarget (Node *target) override
	Called before the action start. More...
var	startWithTarget ( var target)
	Called before the action start. More...
local	startWithTarget ( local target)
	Called before the action start. 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 GridBase *	getGrid () override
	returns the grid
Public Member Functions inherited from GridAction
virtual GridAction *	reverse () 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...
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...
Node *	getTarget () 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...
Node *	getOriginalTarget () 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...
Ref *	autorelease ()
	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
Ref *	copy () const
	Returns a copy of the Ref. More...

Static Public Member Functions
static TurnOffTiles *	create (float duration, const Size &gridSize)
	Create the action with the grid size and the duration. More...
local	create ( local duration, local gridSize)
	Create the action with the grid size and the duration. More...
static TurnOffTiles *	create (float duration, const Size &gridSize, unsigned int seed)
	Create the action with the grid size and the duration. More...
var	create ( var duration, var gridSize, var seed)
	Create the action with the grid size and the duration. More...
local	create ( local duration, local gridSize, local seed)
	Create the action with the grid size and the duration. More...
Static Public Member Functions inherited from TiledGrid3DAction
static TiledGrid3DAction *	create (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...
var	initWithDuration ( var duration, var gridSize, var seed)
	Initializes the action with grid size, random seed and duration. More...
local	initWithDuration ( local duration, local gridSize, local 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...
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

TurnOffTiles action.

Turn off the target node with many tiles in random order.

Member Function Documentation

static TurnOffTiles* create ( float  duration, const Size &  gridSize  )

static

Create the action with the grid size and the duration.

Parameters

duration	Specify the duration of the TurnOffTiles action. It's a value in seconds.
gridSize	Specify the size of the grid.

Returns

If the creation success, return a pointer of TurnOffTiles action; otherwise, return nil.

var create ( var  duration, var  gridSize  )

static

Create the action with the grid size and the duration.

Parameters

duration	Specify the duration of the TurnOffTiles action. It's a value in seconds.
gridSize	Specify the size of the grid.

Returns

If the creation success, return a pointer of TurnOffTiles action; otherwise, return nil.

local create ( local  duration, local  gridSize  )

static

Create the action with the grid size and the duration.

Parameters

duration	Specify the duration of the TurnOffTiles action. It's a value in seconds.
gridSize	Specify the size of the grid.

Returns

If the creation success, return a pointer of TurnOffTiles action; otherwise, return nil.

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

static

Create the action with the grid size and the duration.

Parameters

duration	Specify the duration of the TurnOffTiles action. It's a value in seconds.
gridSize	Specify the size of the grid.
seed	Specify the random seed.

Returns

If the creation success, return a pointer of TurnOffTiles action; otherwise, return nil.

var create ( var  duration, var  gridSize, var  seed  )

static

Create the action with the grid size and the duration.

Parameters

duration	Specify the duration of the TurnOffTiles action. It's a value in seconds.
gridSize	Specify the size of the grid.
seed	Specify the random seed.

Returns

If the creation success, return a pointer of TurnOffTiles action; otherwise, return nil.

local create ( local  duration, local  gridSize, local  seed  )

static

Create the action with the grid size and the duration.

Parameters

duration	Specify the duration of the TurnOffTiles action. It's a value in seconds.
gridSize	Specify the size of the grid.
seed	Specify the random seed.

Returns

If the creation success, return a pointer of TurnOffTiles action; otherwise, return nil.

void shuffle	(	unsigned int *	array,
		unsigned int	len
	)

Shuffle the array specified.

Parameters

array	The array will be shuffled.
len	The size of the array.

var shuffle	(	var	array,
		var	len
	)

Shuffle the array specified.

Parameters

array	The array will be shuffled.
len	The size of the array.

local shuffle	(	local	array,
		local	len
	)

Shuffle the array specified.

Parameters

array	The array will be shuffled.
len	The size of the array.

void turnOnTile

(

const Vec2 &

pos

)

Show the tile at specified position.

Parameters

pos	The position index of the tile should be shown.

var turnOnTile

(

var

pos

)

Show the tile at specified position.

Parameters

pos	The position index of the tile should be shown.

local turnOnTile

(

local

pos

)

Show the tile at specified position.

Parameters

pos	The position index of the tile should be shown.

void turnOffTile

(

const Vec2 &

pos

)

Hide the tile at specified position.

Parameters

pos	The position index of the tile should be hide.

var turnOffTile

(

var

pos

)

Hide the tile at specified position.

Parameters

pos	The position index of the tile should be hide.

local turnOffTile

(

local

pos

)

Hide the tile at specified position.

Parameters

pos	The position index of the tile should be hide.

virtual TurnOffTiles* 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 startWithTarget ( Node *  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from GridAction.

var startWithTarget ( var  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from GridAction.

local startWithTarget ( local  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from GridAction.

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

time	A 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

time	A 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

time	A value between 0 and 1.

Reimplemented from Action.

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

protected

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

Parameters

duration	Specify the duration of the TurnOffTiles action. It's a value in seconds.
gridSize	Specify the size of the grid.
seed	Specify the random seed.

Returns

If the Initialization success, return true; otherwise, return false.

var initWithDuration ( var  duration, var  gridSize, var  seed  )

protected

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

Parameters

duration	Specify the duration of the TurnOffTiles action. It's a value in seconds.
gridSize	Specify the size of the grid.
seed	Specify the random seed.

Returns

If the Initialization success, return true; otherwise, return false.

local initWithDuration ( local  duration, local  gridSize, local  seed  )

protected

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

Parameters

duration	Specify the duration of the TurnOffTiles action. It's a value in seconds.
gridSize	Specify the size of the grid.
seed	Specify the random seed.

Returns

If the Initialization success, return true; otherwise, return false.

---

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

• CCActionTiledGrid.h