This constructor is an implementation detail. Do not use this.
Returns the amount of runs that have been attempted with these splits.
Accesses the an attempt history element by its index. This does not store the actual segment times, just the overall attempt information. Information about the individual segments is stored within each segment. You may not provide an out of bounds index.
Returns the amount attempt history elements are stored in this Run.
Accesses the Auto Splitter Settings that are encoded as XML.
Accesses the name of the category this Run is for.
Clones the Run object.
Accesses a custom comparison stored in this Run by its index. This includes
Personal Best but excludes all the other Comparison Generators. You may
not provide an out of bounds index.
Returns the amount of custom comparisons stored in this Run.
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 an extended category name that possibly includes the region, platform and variables, depending on the arguments provided. An extended category name may look like this:
Any% (No Tuner, JPN, Wii Emulator)
Returns a file name (without the extension) suitable for this Run that is built the following way:
Game Name - Category Name
If either is empty, the dash is omitted. Special characters that cause problems in file names are also omitted. If an extended category name is used, the variables of the category are appended in a parenthesis.
Returns a name suitable for this Run that is built the following way:
Game Name - Category Name
If either is empty, the dash is omitted. If an extended category name is used, the variables of the category are appended in a parenthesis.
Accesses the amount of bytes the game icon's data takes up.
Accesses the game icon's data. If there is no game icon, this returns an empty buffer.
Accesses the name of the game this Run is for.
Returns whether the Run has been modified and should be saved so that the changes don't get lost.
Returns the amount of segments stored in this Run.
Marks the Run as modified, so that it is known that there are changes that should be saved.
Accesses additional metadata of this Run, like the platform and region of the game.
Accesses the time an attempt of this Run should start at.
Pushes the segment provided to the end of the list of segments of this Run.
Saves a Run as a LiveSplit splits file (*.lss). If the run is actively in use by a timer, use the appropriate method on the timer instead, in order to properly save the current attempt as well.
Accesses a certain segment of this Run. You may not provide an out of bounds index.
Sets the name of the category this Run is for.
Sets the name of the game this Run is for.
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.
Creates a new Run object with no segments.
Attempts to parse a splits file from an array by invoking the corresponding parser for the file format detected. A path to the splits file can be provided, which helps saving the splits file again later. Additionally you need to specify if additional files, like external images are allowed to be loaded. If you are using livesplit-core in a server-like environment, set this to false. Only client-side applications should set this to true.
Attempts to parse a splits file from a file by invoking the corresponding parser for the file format detected. A path to the splits file can be provided, which helps saving the splits file again later. Additionally you need to specify if additional files, like external images are allowed to be loaded. If you are using livesplit-core in a server-like environment, set this to false. Only client-side applications should set this to true. On Unix you pass a file descriptor to this function. On Windows you pass a file handle to this function. The file descriptor / handle does not get closed.
Generated using TypeDoc
A Run stores the split times for a specific game and category of a runner.