ActionManager Class

Module: cc

cc.ActionManager is a class that can manage actions.
Normally you won't need to use this class directly. 99% of the cases you will use the CCNode interface, which uses this class's singleton object. But there are some cases where you might need to use this class.
Examples:

• When you want to run an action where the target is different from a CCNode.
  
• When you want to pause / resume the actions
  

Index

Methods

• addAction Adds an action with a target.
  If the target is already present, then the action will be added to the existing target. If the target is not present, a new instance of this target will be created either paused or not, and the action will be added to the newly created target. When the target is paused, the queued actions won't be 'ticked'.
• removeAllActions Removes all actions from all the targets.
• removeAllActionsFromTarget Removes all actions from a certain target.
  All the actions that belongs to the target will be removed.
• removeAction Removes an action given an action reference.
• removeActionByTag Removes an action given its tag and the target.
• getActionByTag Gets an action given its tag an a target.
• getNumberOfRunningActionsInTarget Returns the numbers of actions that are running in a certain target.
  Composable actions are counted as 1 action.
  Example:
  
  • If you are running 1 Sequence of 7 actions, it will return 1.
    
  • If you are running 7 Sequences of 2 actions, it will return 7.
• pauseTarget Pauses the target: all running actions and newly added actions will be paused.
• resumeTarget Resumes the target. All queued actions will be resumed.
• pauseAllRunningActions Pauses all running actions, returning a list of targets whose actions were paused.
• resumeTargets Resume a set of targets (convenience function to reverse a pauseAllRunningActions or pauseTargets call).
• pauseTargets Pause a set of targets.
• purgeSharedManager purges the shared action manager. It releases the retained instance.
  because it uses this, so it can not be static.
• update The ActionManager update。

Details

Methods

addAction

Adds an action with a target.
If the target is already present, then the action will be added to the existing target. If the target is not present, a new instance of this target will be created either paused or not, and the action will be added to the newly created target. When the target is paused, the queued actions won't be 'ticked'.

Parameters

• action Action
• target Node
• paused Boolean

removeAllActions

Removes all actions from all the targets.

removeAllActionsFromTarget

Removes all actions from a certain target.
All the actions that belongs to the target will be removed.

Parameters

• target Node
• forceDelete Boolean

removeAction

Removes an action given an action reference.

Parameters

• action Action

removeActionByTag

Removes an action given its tag and the target.

Parameters

• tag Number
• target Node

getActionByTag

Gets an action given its tag an a target.

Parameters

• tag Number
• target Node

getNumberOfRunningActionsInTarget

Returns the numbers of actions that are running in a certain target.
Composable actions are counted as 1 action.
Example:

• If you are running 1 Sequence of 7 actions, it will return 1.
  
• If you are running 7 Sequences of 2 actions, it will return 7.

Parameters

• target Node

pauseTarget

Pauses the target: all running actions and newly added actions will be paused.

Parameters

• target Node

resumeTarget

Resumes the target. All queued actions will be resumed.

Parameters

• target Node

pauseAllRunningActions

Pauses all running actions, returning a list of targets whose actions were paused.

resumeTargets

Resume a set of targets (convenience function to reverse a pauseAllRunningActions or pauseTargets call).

Parameters

• targetsToResume Array

pauseTargets

Pause a set of targets.

Parameters

• targetsToPause Array

purgeSharedManager

purges the shared action manager. It releases the retained instance.
because it uses this, so it can not be static.

update

The ActionManager update。

Parameters

• dt Number delta time in seconds