Speed Class Reference

Changes the speed of an action, making it take longer (speed>1) or less (speed<1) time. More...

#include <CCAction.h>

Inheritance diagram for Speed:

Public Member Functions
float	getSpeed (void) const
	Return the speed. More...
var	getSpeed ()
	Return the speed. More...
local	getSpeed ()
	Return the speed. More...
void	setSpeed (float speed)
	Alter the speed of the inner function in runtime. More...
var	setSpeed ( var speed)
	Alter the speed of the inner function in runtime. More...
local	setSpeed ( local speed)
	Alter the speed of the inner function in runtime. More...
void	setInnerAction (ActionInterval *action)
	Replace the interior action. More...
ActionInterval *	getInnerAction () const
	Return the interior action. More...
virtual Speed *	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...
virtual Speed *	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...
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	stop () override
	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...
virtual void	step (float dt) override
virtual bool	isDone () const override
	Return true if the action has finished. More...
var	isDone ()
	Return true if the action has finished. More...
local	isDone ()
	Return true if the action has finished. More...
virtual	~Speed (void)
var	~Speed ()
local	~Speed ()
bool	initWithAction (ActionInterval *action, float speed)
	Initializes the action. More...
var	initWithAction ( var action, var speed)
	Initializes the action. More...
local	initWithAction ( local action, local speed)
	Initializes the action. More...
Public Member Functions inherited from Action
virtual std::string	description () const
virtual void	update (float time)
	Called once per frame. More...
var	update ( var time)
	Called once per frame. More...
local	update ( local time)
	Called once per frame. 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...
virtual	~Action ()
var	~Action ()
local	~Action ()
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
virtual	~Clonable ()
Ref *	copy () const
	Returns a copy of the Ref. More...

Static Public Member Functions
static Speed *	create (ActionInterval *action, float speed)
	Create the action and set the speed. More...
var	create ( var action, var speed)
	Create the action and set the speed. More...
local	create ( local action, local speed)
	Create the action and set the speed. More...

Public Attributes
CC_CONSTRUCTOR_ACCESS	__pad0__: Speed()
Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS	__pad0__: Action()

Protected Attributes
float	_speed
var	_speed
local	_speed
ActionInterval *	_innerAction
var	_innerAction
local	_innerAction
Protected Attributes inherited from Action
Node *	_originalTarget
Node *	_target
	The "target". More...
int	_tag
	The action tag. More...
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...
local	_referenceCount
	count of references More...

Additional Inherited Members
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...
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...

Detailed Description

Changes the speed of an action, making it take longer (speed>1) or less (speed<1) time.

Useful to simulate 'slow motion' or 'fast forward' effect.

Warning

This action can't be Sequenceable because it is not an IntervalAction.

Constructor & Destructor Documentation

virtual ~Speed ( void  )

virtual

var ~Speed (   )

virtual

local ~Speed (   )

virtual

Member Function Documentation

virtual Speed* clone ( ) const

overridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from Action.

var clone ( )

overridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from Action.

local clone ( )

overridevirtual

Returns a clone of action.

Returns

A clone action.

Reimplemented from Action.

static Speed* create ( ActionInterval *  action, float  speed  )

static

Create the action and set the speed.

Parameters

action	An action.
speed	The action speed.

var create ( var  action, var  speed  )

static

Create the action and set the speed.

Parameters

action	An action.
speed	The action speed.

local create ( local  action, local  speed  )

static

Create the action and set the speed.

Parameters

action	An action.
speed	The action speed.

ActionInterval* getInnerAction ( ) const

inline

Return the interior action.

Returns

The interior action.

var getInnerAction ( )

inline

Return the interior action.

Returns

The interior action.

local getInnerAction ( )

inline

Return the interior action.

Returns

The interior action.

float getSpeed ( void  ) const

inline

Return the speed.

Returns

The action speed.

var getSpeed (   )

inline

Return the speed.

Returns

The action speed.

local getSpeed (   )

inline

Return the speed.

Returns

The action speed.

bool initWithAction	(	ActionInterval *	action,
		float	speed
	)

Initializes the action.

var initWithAction	(	var	action,
		var	speed
	)

Initializes the action.

local initWithAction	(	local	action,
		local	speed
	)

Initializes the action.

virtual bool isDone ( ) const

overridevirtual

Return true if the action has finished.

Returns

Is true if the action has finished.

Reimplemented from Action.

var isDone ( )

overridevirtual

Return true if the action has finished.

Returns

Is true if the action has finished.

Reimplemented from Action.

local isDone ( )

overridevirtual

Return true if the action has finished.

Returns

Is true if the action has finished.

Reimplemented from Action.

virtual Speed* 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 Action.

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

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

void setInnerAction

(

ActionInterval *

action

)

Replace the interior action.

Parameters

action

The new action, it will replace the running action.

var setInnerAction

(

var

action

)

Replace the interior action.

Parameters

action

The new action, it will replace the running action.

local setInnerAction

(

local

action

)

Replace the interior action.

Parameters

action

The new action, it will replace the running action.

void setSpeed ( float  speed )

inline

Alter the speed of the inner function in runtime.

Parameters

speed

Alter the speed of the inner function in runtime.

var setSpeed ( var  speed )

inline

Alter the speed of the inner function in runtime.

Parameters

speed

Alter the speed of the inner function in runtime.

local setSpeed ( local  speed )

inline

Alter the speed of the inner function in runtime.

Parameters

speed

Alter the speed of the inner function in runtime.

virtual void startWithTarget ( Node *  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from Action.

var startWithTarget ( var  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from Action.

local startWithTarget ( local  target )

overridevirtual

Called before the action start.

It will also set the target.

Parameters

target

A certain target.

Reimplemented from Action.

virtual void step ( float  dt )

overridevirtual

Parameters

dt	in seconds.

Reimplemented from Action.

var step ( var  dt )

overridevirtual

Parameters

dt	in seconds.

Reimplemented from Action.

local step ( local  dt )

overridevirtual

Parameters

dt	in seconds.

Reimplemented from Action.

virtual void stop ( )

overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

var stop ( )

overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

local stop ( )

overridevirtual

Called after the action has finished.

It will set the 'target' to nil. IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".

Reimplemented from Action.

Member Data Documentation

CC_CONSTRUCTOR_ACCESS __pad0__

var __pad0__

local __pad0__

ActionInterval* _innerAction

protected

var _innerAction

protected

local _innerAction

protected

float _speed

protected

var _speed

protected

local _speed

protected

---

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

• /Users/minggo/SourceCode/cocos2d-x/cocos/2d/CCAction.h