Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SchedulerBase

A Scheduler manages a set of systems and their dependencies. Typically you will only have a frame scheduler obtained from ut.World. Systems can be added, removed, enabled and disabled at any time.

Hierarchy

Index

Methods

deltaTime

  • deltaTime(): number
  • Returns number

    The time elapsed since the last time this scheduler was run, in seconds.

disableId

  • disableId(id: number): void
  • Disables the system with id {@link id}.

    Parameters

    • id: number

    Returns void

disableName

  • disableName(name: string): void
  • Disables the system named name.

    Parameters

    • name: string

    Returns void

enableId

  • enableId(id: number): void
  • Enables the system with id {@link id}.

    Parameters

    • id: number

    Returns void

enableName

  • enableName(name: string): void
  • Enable the system named name.

    Parameters

    • name: string

    Returns void

findName

  • findName(name: string): number
  • Returns the id of a system with the given name.

    Parameters

    • name: string

    Returns number

findSys

  • Returns the id of a given system.

    Parameters

    Returns number

isEnabledId

  • isEnabledId(id: number): boolean
  • Returns whether the system with id {@link id} is enabled.

    Parameters

    • id: number

    Returns boolean

isEnabledName

  • isEnabledName(name: string): boolean
  • Returns whether the system named name is enabled.

    Parameters

    • name: string

    Returns boolean

isPaused

  • isPaused(): boolean
  • Return whether the scheduler is paused or not.

    Returns boolean

name

  • name(): string
  • Returns the name of this scheduler.

    Returns string

now

  • now(): number
  • Returns number

    The time elapsed since this scheduler was first created, in seconds.

pause

  • pause(): void
  • Pause the scheduler execution.

    Returns void

removeAll

  • removeAll(): void
  • Remove all systems from the scheduler.

    Returns void

removeId

  • removeId(id: number): void
  • Removes the system with id {@link id} from the scheduler.

    Parameters

    • id: number

    Returns void

removeName

  • removeName(name: string): void
  • Removes the system named name from the scheduler.

    Parameters

    • name: string

    Returns void

resume

  • resume(): void
  • Resume the scheduler execution.

    Returns void

run

  • run(): void
  • Run this scheduler.

    Returns void

scheduleFnInternal

  • scheduleFnInternal(name: string, sys: SystemFn): number
  • Parameters

    Returns number

scheduleSysInternal

  • Parameters

    Returns number

step

  • step(): void
  • Step over to the start of the next iteration when scheduler is paused.

    Returns void

stringify

  • stringify(): string
  • Returns a string representation of the fully scheduled system order for debugging/testing purposes.

    Returns string

Generated using TypeDoc