Class KeyValueComponentState

The state object describes the information to visualize for a key value based component.

Hierarchy

KeyValueComponentStateRefMut
- KeyValueComponentState

Index

Constructors

constructor

Properties

ptr

Methods

Constructors

constructor

new KeyValueComponentState(ptr: number): KeyValueComponentState

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

Parameters
- ptr: number
Returns KeyValueComponentState

Properties

ptr

ptr: number

Methods

dispose

dispose(): void

- Defined in livesplit_core.ts:2990
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

key

key(): string

Inherited from KeyValueComponentStateRefMut.key
- Defined in livesplit_core.ts:2927
The key to visualize.

Returns string

semanticColor

semanticColor(): string

Inherited from KeyValueComponentStateRefMut.semanticColor
- Defined in livesplit_core.ts:2947
The semantic coloring information the value carries.

Returns string

value

value(): string

Inherited from KeyValueComponentStateRefMut.value
- Defined in livesplit_core.ts:2937
The value to visualize.

Returns string

with

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

- Defined in livesplit_core.ts:2978
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: KeyValueComponentState) => T
  - - (obj: KeyValueComponentState): T
    - Parameters
      - obj: KeyValueComponentState
      Returns T
Returns T

Generated using TypeDoc