UpdatableHandle

since: 3.1.1b127

Index

Constructors

• constructor

Methods

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

Constructors

publicconstructor

• new UpdatableHandle(handle: number): UpdatableHandle

• Parameters

  • handle: number

  Returns UpdatableHandle

Methods

publicdestroy

• destroy(): boolean

• Returns boolean

publicgetHandle

• getHandle(): number

• Unique updatable handle identifier, cannot be reused between sessions.

  ---

  Returns number

publicgetObject

• getObject(): IUpdatable

• Returns object that is being hold by this handle, can be both, script object in which updatable is located (or thisObj) and java interface with single method.

  ---

  Returns IUpdatable

publicgetScope

• getScope(): UpdatableSchedulerScope

• Returns UpdatableSchedulerScope

publicisAlive

• isAlive(): boolean

• Returns boolean

publicschedule

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

• By default, recurring schedule is set to 1 and performs indefinitely.

  ---

  Parameters

  • tickIn: number

    minimum ticks after which update is executed

  • optionaltickUntil: number

    maximum ticks after which update is executed, determined randomly from minimum to maximum, if not set, always uses minimum, default -1

  Returns this

publicsetRecurringSchedule

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

• Parameters

  • tickIn: number

    minimum ticks after which update is executed

  • optionaltickUntil: number

    maximum ticks after which update is executed, determined randomly from minimum to maximum, if not set, always uses minimum, default -1

  Returns this