Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RunMetadataCustomVariableRefMut

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

Properties

Methods

Constructors

constructor

Properties

ptr

ptr: number

Methods

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

Generated using TypeDoc