UpdatableScheduler

since: 3.1.1b127

Experimental module used to create and manage scoped updatables. Updatables provide the proper way to manage objects that update their state every tick. Updatables may not be notified every tick, if there are too many, to avoid user interface freezes.

Index

Functions

• createNewScope
• createOnClient
• createOnServer
• destroyRawHandle
• getByRawHandle
• getMainClientScope
• getMainServerScope
• getScopeByRawHandle
• isHandleAlive
• scheduleByRawHandle
• setRecurringScheduleByRawHandle

Functions

createNewScope

• createNewScope(name: string): UpdatableSchedulerScope

• Parameters

  • name: string

  Returns UpdatableSchedulerScope

createOnClient

• createOnClient(updatable: IUpdatable): UpdatableHandle
• createOnClient(func: () => void, thisObj?: Scriptable): UpdatableHandle

• Creates updatable of given object on client, which will update every local tick.

  ---

  Parameters

  • updatable: IUpdatable

  Returns UpdatableHandle

createOnServer

• createOnServer(updatable: IUpdatable): UpdatableHandle
• createOnServer(func: () => void, thisObj?: Scriptable): UpdatableHandle

• Creates updatable of given object on server, which will update every tick.

  ---

  Parameters

  • updatable: IUpdatable

  Returns UpdatableHandle

destroyRawHandle

• destroyRawHandle(handle: number): boolean

• Parameters

  • handle: number

  Returns boolean

getByRawHandle

• getByRawHandle(): IUpdatable

• Returns IUpdatable

getMainClientScope

• getMainClientScope(): UpdatableSchedulerScope

• Returns UpdatableSchedulerScope

getMainServerScope

• getMainServerScope(): UpdatableSchedulerScope

• Returns UpdatableSchedulerScope

getScopeByRawHandle

• getScopeByRawHandle(): UpdatableSchedulerScope

• Returns UpdatableSchedulerScope

isHandleAlive

• isHandleAlive(handle: number): boolean

• Parameters

  • handle: number

  Returns boolean

scheduleByRawHandle

• scheduleByRawHandle(handle: number, tickAt: number, tickUntil: number): void

• Parameters

  • handle: number

  • tickAt: number

  • tickUntil: number

    default -1

  Returns void

setRecurringScheduleByRawHandle

• setRecurringScheduleByRawHandle(handle: number, tickAt: number, tickUntil: number): void

• Parameters

  • handle: number

  • tickAt: number

  • tickUntil: number

    default -1

  Returns void