Class Component

A Component provides information about a run in a way that is easy to visualize. This type can store any of the components provided by this crate.

Hierarchy

ComponentRefMut
- Component

Index

Constructors

constructor

Properties

ptr

Methods

Constructors

constructor

new Component(ptr: number): Component

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

Parameters
- ptr: number
Returns Component

Properties

ptr

ptr: number

Methods

dispose

dispose(): void

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

with

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

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

Generated using TypeDoc