cocos2d-x  3.5
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Repeat Class Reference

Repeats an action a number of times. More...

#include <CCActionInterval.h>

Inheritance diagram for Repeat:
ActionInterval FiniteTimeAction Action Ref Clonable

Public Member Functions

void setInnerAction (FiniteTimeAction *action)
 Sets the inner action. More...
 
FiniteTimeActiongetInnerAction ()
 Gets the inner action. More...
 
virtual Repeatclone () const override
 Returns a clone of action. More...
 
virtual Repeatreverse () const override
 Returns a new action that performs the exactly the reverse action. More...
 
virtual void startWithTarget (Node *target) override
 Called before the action start. More...
 
virtual void stop (void) override
 Called after the action has finished. More...
 
virtual void update (float dt) override
virtual bool isDone (void) const override
 Return true if the action has finished. More...
 
bool initWithAction (FiniteTimeAction *pAction, unsigned int times)
 initializes a Repeat action. More...
 
- Public Member Functions inherited from ActionInterval
float getElapsed (void)
 How many seconds had elapsed since the actions started to run. More...
 
void setAmplitudeRate (float amp)
 Sets the ampliture rate, extension in GridAction. More...
 
float getAmplitudeRate (void)
 Gets the ampliture rate, extension in GridAction. More...
 
virtual void step (float dt) override
- Public Member Functions inherited from FiniteTimeAction
float getDuration () const
 Get duration in seconds of the action. More...
 
void setDuration (float duration)
 Set duration in seconds of the action. More...
 
- Public Member Functions inherited from Action
virtual std::string description () const
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...
 
virtual ~Action ()
- 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 ()
Refcopy () const
 Returns a copy of the Ref. More...
 

Static Public Member Functions

static Repeatcreate (FiniteTimeAction *action, unsigned int times)
 Creates a Repeat action. More...
 

Public Attributes

CC_CONSTRUCTOR_ACCESS __pad0__: Repeat() {} virtual ~Repeat()
- Public Attributes inherited from ActionInterval
CC_CONSTRUCTOR_ACCESS __pad0__: bool initWithDuration(float d)
- Public Attributes inherited from FiniteTimeAction
CC_CONSTRUCTOR_ACCESS __pad0__: FiniteTimeAction() : _duration(0) {} virtual ~FiniteTimeAction(){}protected: float _duration
- Public Attributes inherited from Action
CC_CONSTRUCTOR_ACCESS __pad0__: Action()

Protected Attributes

unsigned int _times
unsigned int _total
float _nextDt
bool _actionInstant
FiniteTimeAction_innerAction
 Inner action. More...
 
- Protected Attributes inherited from ActionInterval
float _elapsed
bool _firstTick
- 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...
 

Additional Inherited Members

- Static Public Attributes inherited from Action
static const int INVALID_TAG = -1
 Default tag used for all the actions. More...
 
- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 

Detailed Description

Repeats an action a number of times.

To repeat an action forever use the RepeatForever action.

Member Function Documentation

virtual Repeat* clone ( ) const
overridevirtual

Returns a clone of action.

Returns
A clone action.

Reimplemented from ActionInterval.

static Repeat* create ( FiniteTimeAction action,
unsigned int  times 
)
static

Creates a Repeat action.

Times is an unsigned integer between 1 and pow(2,30).

Parameters
actionThe action needs to repeat.
timesThe repeat times.
Returns
An autoreleased Repeat object.
FiniteTimeAction* getInnerAction ( )
inline

Gets the inner action.

Returns
The inner action.
bool initWithAction ( FiniteTimeAction pAction,
unsigned int  times 
)

initializes a Repeat action.

Times is an unsigned integer between 1 and pow(2,30)

virtual bool isDone ( void  ) const
overridevirtual

Return true if the action has finished.

Returns
Is true if the action has finished.

Reimplemented from ActionInterval.

virtual Repeat* 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.

void setInnerAction ( FiniteTimeAction action)
inline

Sets the inner action.

Parameters
actionThe inner action.
virtual void startWithTarget ( Node target)
overridevirtual

Called before the action start.

It will also set the target.

Parameters
targetA certain target.

Reimplemented from ActionInterval.

virtual void stop ( void  )
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 update ( float  dt)
overridevirtual
Parameters
dtIn seconds.

Reimplemented from Action.

Member Data Documentation

bool _actionInstant
protected
FiniteTimeAction* _innerAction
protected

Inner action.

float _nextDt
protected
unsigned int _times
protected
unsigned int _total
protected

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