UpdatableSchedulerScope

since: 3.1.1b127

Allows to create scoped updatables, which should be updated manually by developer, e.g. when specific conditions met.

Index

Constructors

• constructor

Methods

• clearAll
• create
• createRawHandle
• executeTickForScope
• getCurrentTick
• setCurrentTick

Constructors

constructor

• new UpdatableSchedulerScope(): UpdatableSchedulerScope

• Returns UpdatableSchedulerScope

Methods

publicclearAll

• clearAll(): void

• Returns void

publiccreate

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

• Provides a way to directly create scoped ticking function without linking to any object, which will update when executeTickForScope is called by developer (excluding UpdatableScheduler.getMainServerScope and UpdatableScheduler.getMainClientScope scopes where updates called automatically).

  ---

  Parameters

  • func: () => void

  • optionalthisObj: Scriptable

  Returns UpdatableHandle

publiccreateRawHandle

• createRawHandle(func: () => void, object?: Scriptable): number

• Parameters

  • func: () => void

  • optionalobject: Scriptable

  Returns number

publicexecuteTickForScope

• executeTickForScope(tickNo: number, timeLimitUs?: number): void

• Parameters

  • tickNo: number

  • optionaltimeLimitUs: number

    default -1

  Returns void

publicgetCurrentTick

• getCurrentTick(): number

• Set to 0 when scope is created, increases every tick by 1 with executeTickForScope.

  ---

  Returns number

publicsetCurrentTick

• setCurrentTick(tickNo: number): void

• Parameters

  • tickNo: number

  Returns void