Class TimerComponentState

The state object describes the information to visualize for this component.

Hierarchy

TimerComponentStateRefMut
- TimerComponentState

Index

Constructors

constructor

Properties

ptr

Methods

Constructors

constructor

new TimerComponentState(ptr: number): TimerComponentState

Inherited from TimerComponentStateRefMut.constructor
- Defined in livesplit_core.ts:8393
This constructor is an implementation detail. Do not use this.

Parameters
- ptr: number
Returns TimerComponentState

Properties

ptr

ptr: number

Methods

dispose

dispose(): void

- Defined in livesplit_core.ts:8426
Disposes the object, allowing it to clean up all of its memory. You need to call this for every object that you don't use anymore and hasn't already been disposed.

Returns void

fraction

fraction(): string

Inherited from TimerComponentStateRefMut.fraction
- Defined in livesplit_core.ts:8373
The fractional part of the time shown (including the dot).

Returns string

semanticColor

semanticColor(): string

Inherited from TimerComponentStateRefMut.semanticColor
- Defined in livesplit_core.ts:8383
The semantic coloring information the time carries.

Returns string

time

time(): string

Inherited from TimerComponentStateRefMut.time
- Defined in livesplit_core.ts:8363
The time shown by the component without the fractional part.

Returns string

with

with<T>(closure: (obj: TimerComponentState) => T): T

- Defined in livesplit_core.ts:8414
Allows for scoped usage of the object. The object is guaranteed to get disposed once this function returns. You are free to dispose the object early yourself anywhere within the scope. The scope's return value gets carried to the outside of this function.

Type parameters
- T
Parameters
- closure: (obj: TimerComponentState) => T
  - - (obj: TimerComponentState): T
    - Parameters
      - obj: TimerComponentState
      Returns T
Returns T

Generated using TypeDoc