Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SumOfBestComponent

The Sum of Best Segments Component shows the fastest possible time to complete a run of this category, based on information collected from all the previous attempts. This often matches up with the sum of the best segment times of all the segments, but that may not always be the case, as skipped segments may introduce combined segments that may be faster than the actual sum of their best segment times. The name is therefore a bit misleading, but sticks around for historical reasons.

Hierarchy

Index

Constructors

constructor

Properties

ptr

ptr: number

Methods

dispose

  • dispose(): void
  • 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

  • Converts the component into a generic component suitable for using with a layout.

    Returns Component

state

stateAsJson

with

  • 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

    Returns T

Static new

  • Creates a new Sum of Best Segments Component.

    Returns SumOfBestComponent

Generated using TypeDoc