Inherits ActionInterval.

Public Member Functions
void	startWithTarget (Node *target) override
	Called before the action start. More...

void	update (float dt) override
	Called once per frame. More...

var	update ( var dt)
	Called once per frame. More...

local	update ( local dt)
	Called once per frame. More...

ActionTween *	reverse () const override
	Returns a new action that performs the exactly the reverse action. More...

var	reverse ()
	Returns a new action that performs the exactly the reverse action. More...

local	reverse ()
	Returns a new action that performs the exactly the reverse action. More...

ActionTween *	clone () const override
	Returns a clone of action. More...

var	clone ()
	Returns a clone of action. More...

local	clone ()
	Returns a clone of action. More...

Public Member Functions inherited from ActionInterval
float	getElapsed (void)
	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 ampliture rate, extension in GridAction. More...

local	setAmplitudeRate ( local amp)
	Sets the ampliture rate, extension in GridAction. More...

float	getAmplitudeRate (void)
	Gets the ampliture rate, extension in GridAction. More...

virtual bool	isDone (void) const override
	Return true if the action has finished. More...

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

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

Node *	getTarget () const
	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...

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

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

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

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

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 ActionTween *	create (float duration, const std::string &key, float from, float to)
	Create and initializes the action with the property name (key), and the from and to parameters. More...

local	create ( local duration, local key, local from, local to)
	Create and initializes the action with the property name (key), and the from and to parameters. More...

Protected Member Functions
bool	initWithDuration (float duration, const std::string &key, float from, float to)
	Initializes the action with the property name (key), and the from and to parameters. More...

var	initWithDuration ( var duration, var key, var from, var to)
	Initializes the action with the property name (key), and the from and to parameters. More...

local	initWithDuration ( local duration, local key, local from, local to)
	Initializes the action with the property name (key), and the from and to parameters. 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

int	_luaID
	Lua reference id.

void *	_scriptObject
	scriptObject, support for swift

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

ActionTween.

ActionTween is an action that lets you update any property of an object. For example, if you want to modify the "width" property of a target from 200 to 300 in 2 seconds, then:

auto modifyWidth = ActionTween::create(2, "width", 200, 300);

target->runAction(modifyWidth);

Another example: ScaleTo action could be rewritten using PropertyAction:

// scaleA and scaleB are equivalents
auto scaleA = ScaleTo::create(2, 3);                 // (duration, to)
auto scaleB = ActionTween::create(2, "scale", 1, 3); // (duration, key, from, to)

Since: v0.99.2

Member Function Documentation

static ActionTween* create	(	float	duration,
		const std::string &	key,
		float	from,
		float	to
	)

static

Create and initializes the action with the property name (key), and the from and to parameters.

Parameters

duration	The duration of the ActionTween. It's a value in seconds.
key	The key of property which should be updated.
from	The value of the specified property when the action begin.
to	The value of the specified property when the action end.

Returns: If the creation success, return a pointer of ActionTween; otherwise, return nil.

var create	(	var	duration,
		var	key,
		var	from,
		var	to
	)

static

Create and initializes the action with the property name (key), and the from and to parameters.

Parameters

duration	The duration of the ActionTween. It's a value in seconds.
key	The key of property which should be updated.
from	The value of the specified property when the action begin.
to	The value of the specified property when the action end.

Returns: If the creation success, return a pointer of ActionTween; otherwise, return nil.

local create	(	local	duration,
		local	key,
		local	from,
		local	to
	)

static

Create and initializes the action with the property name (key), and the from and to parameters.

Parameters

duration	The duration of the ActionTween. It's a value in seconds.
key	The key of property which should be updated.
from	The value of the specified property when the action begin.
to	The value of the specified property when the action end.

Returns: If the creation success, return a pointer of ActionTween; otherwise, return nil.

void startWithTarget ( Node * target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented from ActionInterval.

var startWithTarget ( var target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented from ActionInterval.

local startWithTarget ( local target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target A certain target.

Reimplemented from ActionInterval.

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.

ActionTween* reverse ( void ) const

overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns: A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

var reverse ( )

overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns: A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

local reverse ( )

overridevirtual

Returns a new action that performs the exactly the reverse action.

Returns: A new action that performs the exactly the reverse action.

Reimplemented from ActionInterval.

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

bool initWithDuration	(	float	duration,
		const std::string &	key,
		float	from,
		float	to
	)

protected

Initializes the action with the property name (key), and the from and to parameters.

Parameters

duration	The duration of the ActionTween. It's a value in seconds.
key	The key of property which should be updated.
from	The value of the specified property when the action begin.
to	The value of the specified property when the action end.

Returns: If the initialization success, return true; otherwise, return false.

var initWithDuration	(	var	duration,
		var	key,
		var	from,
		var	to
	)

protected

Initializes the action with the property name (key), and the from and to parameters.

Parameters

duration	The duration of the ActionTween. It's a value in seconds.
key	The key of property which should be updated.
from	The value of the specified property when the action begin.
to	The value of the specified property when the action end.

Returns: If the initialization success, return true; otherwise, return false.

local initWithDuration	(	local	duration,
		local	key,
		local	from,
		local	to
	)

protected

Initializes the action with the property name (key), and the from and to parameters.

Parameters

duration	The duration of the ActionTween. It's a value in seconds.
key	The key of property which should be updated.
from	The value of the specified property when the action begin.
to	The value of the specified property when the action end.

Returns: If the initialization success, return true; otherwise, return false.

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

CCActionTween.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation