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

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

Inherits Action.

Public Member Functions

float getSpeed () 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...
 
ActionIntervalgetInnerAction () const
 Return the interior action. More...
 
virtual Speedclone () 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 Speedreverse () const override
 Returns a new action that performs the exact reverse of the action. More...
 
var reverse ()
 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...
 
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
local step ( local dt)
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...
 
- Public Member Functions inherited from Action
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...
 
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 Speedcreate (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...
 

Protected Member Functions

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

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

Changes the speed of an action, making it take longer (speed>1) or shorter (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.

Member Function Documentation

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

Create the action and set the speed.

Parameters
actionAn action.
speedThe action speed.
var create ( var  action,
var  speed 
)
static

Create the action and set the speed.

Parameters
actionAn action.
speedThe action speed.
local create ( local  action,
local  speed 
)
static

Create the action and set the speed.

Parameters
actionAn action.
speedThe action speed.
float getSpeed ( ) 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.
void setSpeed ( float  speed)
inline

Alter the speed of the inner function in runtime.

Parameters
speedAlter the speed of the inner function in runtime.
var setSpeed ( var  speed)
inline

Alter the speed of the inner function in runtime.

Parameters
speedAlter the speed of the inner function in runtime.
local setSpeed ( local  speed)
inline

Alter the speed of the inner function in runtime.

Parameters
speedAlter the speed of the inner function in runtime.
void setInnerAction ( ActionInterval action)

Replace the interior action.

Parameters
actionThe new action, it will replace the running action.
var setInnerAction ( var  action)

Replace the interior action.

Parameters
actionThe new action, it will replace the running action.
local setInnerAction ( local  action)

Replace the interior action.

Parameters
actionThe new action, it will replace the running action.
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.
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.

virtual Speed* reverse ( void  ) const
overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns
A new action that performs the exact reverse of the action.

Reimplemented from Action.

var reverse (   )
overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns
A new action that performs the exact reverse of the action.

Reimplemented from Action.

local reverse (   )
overridevirtual

Returns a new action that performs the exact reverse of the action.

Returns
A new action that performs the exact reverse of the action.

Reimplemented from Action.

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from Action.

var startWithTarget ( var  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from Action.

local startWithTarget ( local  target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

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.

virtual void step ( float  dt)
overridevirtual
Parameters
dtin seconds.

Reimplemented from Action.

var step ( var  dt)
overridevirtual
Parameters
dtin seconds.

Reimplemented from Action.

local step ( local  dt)
overridevirtual
Parameters
dtin seconds.

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

bool initWithAction ( ActionInterval action,
float  speed 
)
protected

Initializes the action.

var initWithAction ( var  action,
var  speed 
)
protected

Initializes the action.

local initWithAction ( local  action,
local  speed 
)
protected

Initializes the action.


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