Cocos Creator API

1.0.0

Cocos Creator is a highly customizable game development tool that utilizes the power of cocos2d-x.

Scheduler

Module: cc

Scheduler is responsible of triggering the scheduled callbacks.
You should not use NSTimer. Instead use this class.

There are 2 different types of callbacks (selectors):
- update callback: the 'update' callback will be called every frame. You can customize the priority.
- custom callback: A custom callback will be called every frame, or with a custom interval of time

The 'custom selectors' should be avoided when possible. It is faster, and consumes less memory to use the 'update callback'. *

Properties

PRIORITY_SYSTEM Number static

Priority level reserved for system services.

PRIORITY_NON_SYSTEM Number static

Minimum priority level for user scheduling.

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Methods

setTimeScale
(
  • timeScale
)

Modifies the time of all scheduled callbacks.
You can use this property to create a 'slow motion' or 'fast forward' effect.
Default is 1.0. To create a 'slow motion' effect, use values below 1.0.
To create a 'fast forward' effect, use values higher than 1.0.

name type description
timeScale Number

getTimeScale ( ) Number

Returns time scale of scheduler.

returns:

type: Number

update
(
  • dt
)

'update' the scheduler. (You should NEVER call this method, unless you know what you are doing.)

name type description
dt Number

delta time

scheduleCallbackForTarget
(
  • target
  • callback_fn
  • interval
  • repeat
  • delay
  • paused
)
deprecated

deprecated: since v3.4 please use .schedule

The scheduled method will be called every 'interval' seconds.
If paused is YES, then it won't be called until it is resumed.
If 'interval' is 0, it will be called every frame, but if so, it recommended to use 'scheduleUpdateForTarget:' instead.
If the callback function is already scheduled, then only the interval parameter will be updated without re-scheduling it again.
repeat let the action be repeated repeat + 1 times, use cc.macro.REPEAT_FOREVER to let the action run continuously
delay is the amount of time the action will wait before it'll start

name type description
target Object
callback_fn function
interval Number
repeat Number
delay Number
paused Boolean

examples:

-------------------
//register a schedule to scheduler
cc.director.getScheduler().scheduleCallbackForTarget(this, function, interval, repeat, delay, !this._isRunning );

schedule
(
  • callback
  • target
  • interval
  • repeat
  • delay
  • paused
)

The schedule

name type description
callback Function
target Object
interval Number
repeat Number
delay Number
paused Boolean

examples:

-------------------
//register a schedule to scheduler
cc.director.getScheduler().schedule(callback, this, interval, !this._isRunning);

scheduleUpdate
(
  • target
  • priority
  • paused
  • updateFunc
)

Schedules the update callback for a given target, the callback will be invoked every frame after schedule started

name type description
target Object
priority Number
paused Boolean
updateFunc Function

unschedule
(
  • callback
  • target
)

Unschedules a callback for a callback and a given target. If you want to unschedule the "update", use unscheudleUpdate()

name type description
callback Function

The callback to be unscheduled
target Object

The target bound to the callback.

unscheduleUpdate
(
  • target
)

Unschedules the update callback for a given target

name type description
target Object

The target to be unscheduled.

unscheduleAllForTarget
(
  • target
)

Unschedules all scheduled callbacks for a given target. This also includes the "update" callback.

name type description
target Object

The target to be unscheduled.

unscheduleAll ( )

Unschedules all scheduled callbacks from all targets including the system callbacks. You should NEVER call this method, unless you know what you are doing.

unscheduleAllWithMinPriority
(
  • minPriority
)

Unschedules all callbacks from all targets with a minimum priority. You should only call this with PRIORITY_NON_SYSTEM_MIN or higher.

name type description
minPriority Number

The minimum priority of selector to be unscheduled. Which means, all selectors which priority is higher than minPriority will be unscheduled.

isScheduled
(
  • key
  • target
)
Boolean

Checks whether a callback for a given target is scheduled.

name type description
key Function | String

The callback to check.
target Object

The target of the callback.

returns:

type: Boolean

True if the specified callback is invoked, false if not.

pauseAllTargets ( )

Pause all selectors from all targets.
You should NEVER call this method, unless you know what you are doing.

pauseAllTargetsWithMinPriority
(
  • minPriority
)

Pause all selectors from all targets with a minimum priority.
You should only call this with kCCPriorityNonSystemMin or higher.

name type description
minPriority Number

resumeTargets
(
  • targetsToResume
)

Resume selectors on a set of targets.
This can be useful for undoing a call to pauseAllCallbacks.

name type description
targetsToResume Array

pauseTarget
(
  • target
)

Pauses the target.
All scheduled selectors/update for a given target won't be 'ticked' until the target is resumed.
If the target is not present, nothing happens.

name type description
target Object

resumeTarget
(
  • target
)

Resumes the target.
The 'target' will be unpaused, so all schedule selectors/update will be 'ticked' again.
If the target is not present, nothing happens.

name type description
target Object

isTargetPaused
(
  • target
)
Boolean

Returns whether or not the target is paused

name type description
target Object

returns:

type: Boolean

scheduleUpdateForTarget
(
  • target
  • priority
  • paused
)
deprecated

deprecated: since v3.4 please use .scheduleUpdate

Schedules the 'update' callback_fn for a given target with a given priority.
The 'update' callback_fn will be called every frame.
The lower the priority, the earlier it is called.

name type description
target Object
priority Number
paused Boolean

examples:

-------------------
//register this object to scheduler
cc.director.getScheduler().scheduleUpdateForTarget(this, priority, !this._isRunning );

unscheduleCallbackForTarget
(
  • target
  • callback
)
deprecated

deprecated: since v3.4 please use .unschedule

Unschedule a callback function for a given target.
If you want to unschedule the "update", use unscheudleUpdateForTarget.

name type description
target Object
callback Function

callback[Function] or key[String]

examples:

-------------------
//unschedule a callback of target
cc.director.getScheduler().unscheduleCallbackForTarget(function, this);

unscheduleUpdateForTarget
(
  • target
)
deprecated

deprecated: since v3.4 please use .unschedule

Unschedules the update callback function for a given target

name type description
target Object

examples:

-------------------
//unschedules the "update" method.
cc.director.getScheduler().unscheduleUpdateForTarget(this);

unscheduleAllCallbacksForTarget
(
  • target
)
deprecated

deprecated: since v3.4 please use unscheduleAllForTarget

Unschedules all function callbacks for a given target. This also includes the "update" callback function.

name type description
target Object

unscheduleAllCallbacks ( ) deprecated

deprecated: since v3.4 please use .unscheduleAllWithMinPriority

Unschedules all function callbacks from all targets.
You should NEVER call this method, unless you know what you are doing.

unscheduleAllCallbacksWithMinPriority
(
  • minPriority
)
deprecated

deprecated: since v3.4 please use .unscheduleAllWithMinPriority

Unschedules all function callbacks from all targets with a minimum priority.
You should only call this with kCCPriorityNonSystemMin or higher.

name type description
minPriority Number

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index