Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RunMetadata

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

constructor

Properties

ptr

ptr: number

Methods

customVariables

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

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

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

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