UpdatableHandle

since: 3.1.1b127 arm64

Index

Constructors

• constructor

Methods

• destroy
• getHandle
• getObject
• getScope
• isAlive
• replaceUpdatableHandle
• schedule
• setRecurringSchedule

Constructors

publicconstructor

• new UpdatableHandle(handle: number): UpdatableHandle

• Parameters

  • handle: number

  Returns UpdatableHandle

Methods

publicdestroy

• destroy(): boolean

• Returns boolean

publicgetHandle

• getHandle(): number

• Returns number

publicgetObject

• getObject(): IUpdatable

• Returns IUpdatable

publicgetScope

• getScope(): UpdatableSchedulerScope

• Returns UpdatableSchedulerScope

publicisAlive

• isAlive(): boolean

• Returns boolean

publicreplaceUpdatableHandle

• replaceUpdatableHandle(handle: number): number

• internal

  Parameters

  • handle: number

    handle number to replace in current object

  Returns number

publicschedule

• schedule(tickIn: number, tickUntil: number): this

• Parameters

  • tickIn: number

  • tickUntil: number

    default -1

  Returns this

publicsetRecurringSchedule

• setRecurringSchedule(tickIn: number, tickUntil: number): this

• Parameters

  • tickIn: number

  • tickUntil: number

    default -1

  Returns this