Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CustomVariableJson

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

  • CustomVariableJson

Index

Properties

is_permanent

is_permanent: boolean

States whether the variable is permanent. Temporary variables don't get stored in splits files. They also don't get shown in the run editor.

value

value: string

The current value of the custom variable. This may be provided by the runner in the run editor or it may be provided through other means such as an auto splitter.

Generated using TypeDoc