Class CurrentComparisonComponent

The Current Comparison Component is a component that shows the name of the comparison that is currently selected to be compared against.

Hierarchy

CurrentComparisonComponentRefMut
- CurrentComparisonComponent

Index

Constructors

constructor

Properties

ptr

Methods

Constructors

constructor

new CurrentComparisonComponent(ptr: number): CurrentComparisonComponent

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

Parameters
- ptr: number
Returns CurrentComparisonComponent

Properties

ptr

ptr: number

Methods

dispose

dispose(): void

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

intoGeneric

intoGeneric(): Component

- Defined in livesplit_core.ts:1697
Converts the component into a generic component suitable for using with a layout.

Returns Component

state

state(timer: TimerRef): KeyValueComponentState

Inherited from CurrentComparisonComponentRefMut.state
- Defined in livesplit_core.ts:1645
Calculates the component's state based on the timer provided.

Parameters
- timer: TimerRef
Returns KeyValueComponentState

stateAsJson

stateAsJson(timer: TimerRef): any

Inherited from CurrentComparisonComponentRefMut.stateAsJson
- Defined in livesplit_core.ts:1632
Encodes the component's state information as JSON.

Parameters
- timer: TimerRef
Returns any

with

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

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

Static new

new(): CurrentComparisonComponent

- Defined in livesplit_core.ts:1689
Creates a new Current Comparison Component.

Returns CurrentComparisonComponent

Generated using TypeDoc