Class DeltaComponentRefMut

The Delta Component is a component that shows the how far ahead or behind the current attempt is compared to the chosen comparison.

Hierarchy

DeltaComponentRef
- DeltaComponentRefMut
  - DeltaComponent

Index

Constructors

constructor

Properties

ptr

Methods

Constructors

constructor

new DeltaComponentRefMut(ptr: number): DeltaComponentRefMut

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

Parameters
- ptr: number
Returns DeltaComponentRefMut

Properties

ptr

ptr: number

Methods

state

state(timer: TimerRef, layoutSettings: GeneralLayoutSettingsRef): KeyValueComponentState

- Defined in livesplit_core.ts:1846
Calculates the component's state based on the timer and the layout settings provided.

Parameters
- timer: TimerRef
- layoutSettings: GeneralLayoutSettingsRef
Returns KeyValueComponentState

stateAsJson

stateAsJson(timer: TimerRef, layoutSettings: GeneralLayoutSettingsRef): any

- Defined in livesplit_core.ts:1829
Encodes the component's state information as JSON.

Parameters
- timer: TimerRef
- layoutSettings: GeneralLayoutSettingsRef
Returns any

Generated using TypeDoc