Class LayoutStateRef

The state object describes the information to visualize for an entire layout. Use this with care, as invalid usage will result in a panic.

Specifically, you should avoid doing the following:

Using out of bounds indices.
Using the wrong getter function on the wrong type of component.

Hierarchy

LayoutStateRef
- LayoutStateRefMut

Index

Constructors

constructor

Properties

ptr

Methods

Constructors

constructor

new LayoutStateRef(ptr: number): LayoutStateRef

- Defined in livesplit_core.ts:3769
This constructor is an implementation detail. Do not use this.

Parameters
- ptr: number
Returns LayoutStateRef

Properties

ptr

ptr: number

Methods

asJson

asJson(): any

- Defined in livesplit_core.ts:3648
Encodes the layout state as JSON. You can use this to visualize all of the components of a layout.

Returns any

componentAsBlankSpace

componentAsBlankSpace(index: number): BlankSpaceComponentStateRef

- Defined in livesplit_core.ts:3679
Gets the Blank Space component state at the specified index.

Parameters
- index: number
Returns BlankSpaceComponentStateRef

componentAsDetailedTimer

componentAsDetailedTimer(index: number): DetailedTimerComponentStateRef

- Defined in livesplit_core.ts:3689
Gets the Detailed Timer component state at the specified index.

Parameters
- index: number
Returns DetailedTimerComponentStateRef

componentAsGraph

componentAsGraph(index: number): GraphComponentStateRef

- Defined in livesplit_core.ts:3699
Gets the Graph component state at the specified index.

Parameters
- index: number
Returns GraphComponentStateRef

componentAsKeyValue

componentAsKeyValue(index: number): KeyValueComponentStateRef

- Defined in livesplit_core.ts:3709
Gets the Key Value component state at the specified index.

Parameters
- index: number
Returns KeyValueComponentStateRef

componentAsSeparator

componentAsSeparator(index: number): SeparatorComponentStateRef

- Defined in livesplit_core.ts:3719
Gets the Separator component state at the specified index.

Parameters
- index: number
Returns SeparatorComponentStateRef

componentAsSplits

componentAsSplits(index: number): SplitsComponentStateRef

- Defined in livesplit_core.ts:3729
Gets the Splits component state at the specified index.

Parameters
- index: number
Returns SplitsComponentStateRef

componentAsText

componentAsText(index: number): TextComponentStateRef

- Defined in livesplit_core.ts:3739
Gets the Text component state at the specified index.

Parameters
- index: number
Returns TextComponentStateRef

componentAsTimer

componentAsTimer(index: number): TimerComponentStateRef

- Defined in livesplit_core.ts:3749
Gets the Timer component state at the specified index.

Parameters
- index: number
Returns TimerComponentStateRef

componentAsTitle

componentAsTitle(index: number): TitleComponentStateRef

- Defined in livesplit_core.ts:3759
Gets the Title component state at the specified index.

Parameters
- index: number
Returns TitleComponentStateRef

componentType

componentType(index: number): string

- Defined in livesplit_core.ts:3669
Returns a string describing the type of the Component at the specified index.

Parameters
- index: number
Returns string

len

len(): number

- Defined in livesplit_core.ts:3658
Gets the number of Components in the Layout State.

Returns number

Generated using TypeDoc