Cocos2d-x  v4
Speed Class Reference

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

Inherits Action.

Public Member Functions

float getSpeed () const
 Return the speed. More...
 
void setSpeed (float 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...
 
virtual Speedreverse () const override
 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...
 
virtual void stop () override
 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...
 
- Public Member Functions inherited from Action
virtual std::string description () const
 @js NA @lua NA
 
virtual void update (float time)
 Called once per frame. More...
 
NodegetTarget () const
 Return certain target. More...
 
void setTarget (Node *target)
 The action will modify the target properties. More...
 
NodegetOriginalTarget () const
 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...
 
void setTag (int 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)
 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...
 
Refautorelease ()
 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 ()
 @js NA @lua NA
 

Static Public Member Functions

static Speedcreate (ActionInterval *action, float speed)
 Create the action and set the speed. More...
 

Protected Member Functions

bool initWithAction (ActionInterval *action, float speed)
 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
 
bool _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.
 

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

◆ create()

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

Create the action and set the speed.

Parameters
actionAn action.
speedThe action speed.

◆ getSpeed()

float getSpeed ( ) const
inline

Return the speed.

Returns
The action speed.

◆ setSpeed()

void setSpeed ( float  speed)
inline

Alter the speed of the inner function in runtime.

Parameters
speedAlter the speed of the inner function in runtime.

◆ setInnerAction()

void setInnerAction ( ActionInterval action)

Replace the interior action.

Parameters
actionThe new action, it will replace the running action.

◆ getInnerAction()

ActionInterval* getInnerAction ( ) const
inline

Return the interior action.

Returns
The interior action.

◆ clone()

virtual Speed* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from Action.

◆ reverse()

virtual Speed* reverse ( ) 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. @js NA

Reimplemented from Action.

◆ startWithTarget()

virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from Action.

◆ stop()

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.

◆ step()

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

Reimplemented from Action.

◆ isDone()

virtual bool isDone ( ) const
overridevirtual

Return true if the action has finished.

Returns
Is true if the action has finished.

Reimplemented from Action.


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