Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RunMetadataCustomVariable

A custom variable is a key value pair storing additional information about a run. Unlike the speedrun.com variables, these can be fully custom and don't need to correspond to anything on speedrun.com. Permanent custom variables can be specified by the runner. Additionally auto splitters or other sources may provide temporary custom variables that are not stored in the splits files.

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

isPermanent

  • isPermanent(): boolean
  • Returns true if the custom variable is permanent. Permanent variables get stored in the splits file and are visible in the run editor. Temporary variables are not.

    Returns boolean

name

  • name(): string

value

  • value(): string

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

Generated using TypeDoc