Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RunMetadataRef

The Run Metadata stores additional information about a run, like the platform and region of the game. All of this information is optional.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • This constructor is an implementation detail. Do not use this.

    Parameters

    • ptr: number

    Returns RunMetadataRef

Properties

ptr

ptr: number

Methods

customVariables

  • Returns an iterator iterating over all the custom variables and their values. This includes both temporary and permanent variables.

    Returns RunMetadataCustomVariablesIter

platformName

  • platformName(): string

  • Accesses the name of the platform this game is run on. This may be empty if it's not specified.

    Returns string

regionName

  • regionName(): string

  • Accesses the name of the region this game is from. This may be empty if it's not specified.

    Returns string

runId

  • runId(): string

  • Accesses the speedrun.com Run ID of the run. This Run ID specify which Record on speedrun.com this run is associated with. This should be changed once the Personal Best doesn't match up with that record anymore. This may be empty if there's no association.

    Returns string

speedrunComVariables

  • Returns an iterator iterating over all the speedrun.com variables and their values that have been specified.

    Returns RunMetadataSpeedrunComVariablesIter

usesEmulator

  • usesEmulator(): boolean

  • Returns true if this speedrun is done on an emulator. However false may also indicate that this information is simply not known.

    Returns boolean

Generated using TypeDoc