Cocos Creator API

1.3.0

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

Scheduler

: 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'. *

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

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.
Noteļ¼šIt will affect EVERY scheduled selector / action.
timeScale Number

getTimeScale ( ) Number

Returns time scale of scheduler.

:

: Number

update
(
  • dt
)

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

delta time

scheduleCallbackForTarget
(
  • target
  • callback_fn
  • interval
  • repeat
  • delay
  • paused
)
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
target Object
callback_fn Function
interval Number
repeat Number
delay Number
paused Boolean

:

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

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

The schedule
callback Function
target Object
interval Number
repeat Number
delay Number
paused Boolean

:

//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.
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 unscheduleUpdate()
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.
target Object

The target to be unscheduled.

unscheduleAllForTarget
(
  • target
)

Unschedules all scheduled callbacks for a given target. This also includes the "update" callback.
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.
minPriority Number

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

isScheduled
(
  • callback
  • target
)
Boolean

Checks whether a callback for a given target is scheduled.
callback Function

The callback to check.
target Object

The target of the callback.

:

: 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.
minPriority Number

resumeTargets
(
  • targetsToResume
)

Resume selectors on a set of targets.
This can be useful for undoing a call to pauseAllCallbacks.
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.
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.
target Object

isTargetPaused
(
  • target
)
Boolean

Returns whether or not the target is paused.
target Object

:

: Boolean

scheduleUpdateForTarget
(
  • target
  • priority
  • paused
)
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.
target Object
priority Number
paused Boolean

:

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

unscheduleCallbackForTarget
(
  • target
  • callback
)
deprecated

: since v3.4 please use .unschedule

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

callback[Function] or key[String]

:

//unschedule a callback of target
var scheduler = cc.director.getScheduler();
scheduler.unscheduleCallbackForTarget(this, callback);

unscheduleUpdateForTarget
(
  • target
)
deprecated

: since v3.4 please use .unschedule

Unschedules the update callback function for a given target.
target Object

:

//unschedules the "update" method.
var scheduler = cc.director.getScheduler();
scheduler.unscheduleUpdateForTarget(this);

unscheduleAllCallbacksForTarget
(
  • target
)
deprecated

: since v3.4 please use unscheduleAllForTarget

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

unscheduleAllCallbacks ( ) 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

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