Class TimeSpan

A Time Span represents a certain span of time.

Hierarchy

TimeSpanRefMut
- TimeSpan

Index

Constructors

constructor

Properties

ptr

Methods

Constructors

constructor

new TimeSpan(ptr: number): TimeSpan

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

Parameters
- ptr: number
Returns TimeSpan

Properties

ptr

ptr: number

Methods

clone

clone(): TimeSpan

Inherited from TimeSpanRefMut.clone
- Defined in livesplit_core.ts:7683
Clones the Time Span.

Returns TimeSpan

dispose

dispose(): void

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

totalSeconds

totalSeconds(): number

Inherited from TimeSpanRefMut.totalSeconds
- Defined in livesplit_core.ts:7694
Returns the total amount of seconds (including decimals) this Time Span represents.

Returns number

with

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

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

Static fromSeconds

fromSeconds(seconds: number): TimeSpan

- Defined in livesplit_core.ts:7746
Creates a new Time Span from a given amount of seconds.

Parameters
- seconds: number
Returns TimeSpan

Static parse

parse(text: string): TimeSpan

- Defined in livesplit_core.ts:7754
Parses a Time Span from a string. Returns null if the time can't be parsed.

Parameters
- text: string
Returns TimeSpan

Generated using TypeDoc