FadeTo Class Reference

Fades an object that implements the RGBAProtocol protocol. More...

Inherits ActionInterval.

Inherited by FadeIn, and FadeOut.

Public Member Functions
virtual FadeTo *	clone () const override
	override ActionInterval.
local	clone ()
	override ActionInterval.
virtual FadeTo *	reverse (void) const override
	override ActionInterval.
var	reverse ()
	override ActionInterval.
local	reverse ()
	override ActionInterval.
virtual void	startWithTarget (Node *target) override
	override ActionInterval.
var	startWithTarget ( var target)
	override ActionInterval.
local	startWithTarget ( local target)
	override ActionInterval.
virtual void	update (float time) override
	override ActionInterval.
var	update ( var time)
	override ActionInterval.
local	update ( local time)
	override ActionInterval.
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 amplitude rate, extension in GridAction. More...
float	getAmplitudeRate (void)
	Gets the ampliture rate, extension in GridAction. More...
virtual bool	isDone (void) const override
	override Action.
local	isDone ()
	override Action.
virtual void	step (float dt) override
	Called every frame with its delta time, dt in seconds. More...
var	step ( var dt)
	Called every frame with its delta time, dt in seconds. More...
local	step ( local dt)
	Called every frame with its delta time, dt in seconds. More...
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 that has finished. More...
Node *	getTarget () const
	Return the current target. More...
void	setTarget (Node *target)
	The setter function for the target property. More...
var	setTarget ( var target)
	The setter function for the target property. More...
local	setTarget ( local target)
	The setter function for the target property. More...
Node *	getOriginalTarget () const
	Return the original Target. More...
var	getOriginalTarget ()
	Return the original Target. More...
local	getOriginalTarget ()
	Return the original Target. More...
void	setOriginalTarget (Node *originalTarget)
	Set the original target, since target can be nil. More...
var	setOriginalTarget ( var 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...
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...
unsigned int	getFlags () const
	Returns a flag field that is used to group the actions easily. More...
void	setFlags (unsigned int flags)
	Returns a flag field that is used to group the actions easily. More...
var	setFlags ( var flags)
	Returns a flag field that is used to group the actions easily. More...
local	setFlags ( local flags)
	Returns a flag field that is used to group the actions easily. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
local	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...
local	getReferenceCount ()
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor.
Public Member Functions inherited from Clonable
Ref *	copy () const
	Returns a copy of the Ref.

Static Public Member Functions
static FadeTo *	create (float duration, GLubyte opacity)
	Creates an action with duration and opacity. More...

Protected Member Functions
bool	initWithDuration (float duration, GLubyte opacity)
	initializes the action with duration and opacity Duration time, in seconds. More...
local	initWithDuration ( local duration, local opacity)
	initializes the action with duration and opacity Duration time, in seconds. More...
Protected Member Functions inherited from ActionInterval
bool	initWithDuration (float d)
	initializes the action with the duration. More...
var	initWithDuration ( var d)
	initializes the action with the duration. More...
local	initWithDuration ( local d)
	initializes the action with the duration. More...

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.
bool	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...
local	_scriptOwned
	The life of the object is scrolled by the scripting engine. More...
Static Public Attributes inherited from Action
static const int	INVALID_TAG = -1
	Default tag used for all the actions.
var	INVALID_TAG = -1
	Default tag used for all the actions.
local	INVALID_TAG = -1
	Default tag used for all the actions.

Detailed Description

Fades an object that implements the RGBAProtocol protocol.

It modifies the opacity from the current value to a custom one. This action doesn't support "reverse"

Member Function Documentation

static FadeTo* create ( float  duration, GLubyte  opacity  )

static

Creates an action with duration and opacity.

Duration time, in seconds. A certain opacity, the range is from 0 to 255. An autoreleased FadeTo object.

var create ( var  duration, var  opacity  )

static

Creates an action with duration and opacity.

Duration time, in seconds. A certain opacity, the range is from 0 to 255. An autoreleased FadeTo object.

local create ( local  duration, local  opacity  )

static

Creates an action with duration and opacity.

Duration time, in seconds. A certain opacity, the range is from 0 to 255. An autoreleased FadeTo object.

bool initWithDuration ( float  duration, GLubyte  opacity  )

protected

initializes the action with duration and opacity Duration time, in seconds.

A certain opacity, the range is from 0 to 255. Return true if successfully initialized, otherwise return false

var initWithDuration ( var  duration, var  opacity  )

protected

initializes the action with duration and opacity Duration time, in seconds.

A certain opacity, the range is from 0 to 255. Return true if successfully initialized, otherwise return false

local initWithDuration ( local  duration, local  opacity  )

protected

initializes the action with duration and opacity Duration time, in seconds.

A certain opacity, the range is from 0 to 255. Return true if successfully initialized, otherwise return false

---

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

• CCActionInterval.h