Class: Scheduler

Game-time scheduler ticked by SchedulerSystem each Update — callbacks ride the engine clock. Context (the third arg) is bound as this so passing this from a script makes method-style callbacks work directly.

Re-entrant: scheduling from inside a callback joins next tick; cancellations during dispatch are deferred to the end-of-tick sweep.

Constructors

Constructor

new Scheduler(): Scheduler;

Returns

Scheduler

Properties

Property	Modifier	Type
shared	readonly	Scheduler

Methods

Count()

Count(): number;

Returns

number

---

Schedule()

Schedule(
   callback, 
   interval, 
   context?, 
   repeat?, 
   delay?
): number;

repeat = -1 for infinite. delay overrides the time before the first fire (defaults to interval).

Parameters

Parameter	Type	Default value
callback	(...args) => unknown	undefined
interval	number	undefined
context?	object	undefined
repeat?	number	-1
delay?	number	undefined

Returns

number

---

ScheduleNextFrame()

ScheduleNextFrame(callback, context?): number;

Parameters

Parameter	Type
callback	(...args) => unknown
context?	object

Returns

number

---

ScheduleOnce()

ScheduleOnce(
   callback, 
   delay, 
   context?
): number;

Parameters

Parameter	Type
callback	(...args) => unknown
delay	number
context?	object

Returns

number

---

Tick()

Tick(dt, isPaused?): void;

isPaused(context) true = that task holds this tick (its clock doesn't advance) — tasks of a script whose entity is inactive (Cocos pauses a node's schedules the same way).

Parameters

Parameter	Type
dt	number
isPaused?	(context) => boolean

Returns

void

---

Unschedule()

Unschedule(handle): void;

Parameters

Parameter	Type
handle	number

Returns

void

---

UnscheduleAll()

UnscheduleAll(): void;

Returns

void

---

UnscheduleAllForTarget()

UnscheduleAllForTarget(context): void;

Parameters

Parameter	Type
context	object

Returns

void