fork/livesplit-core
git clone https://git.julia.blue/fork/livesplit-core
ee16b86
v0.11.0
1<!doctype html > 2< html class ="default no-js "> 3< head > 4< meta charset ="utf-8 "> 5< meta http-equiv ="X-UA-Compatible "content ="IE=edge "> 6< title > RunRef | livesplit</ title > 7< meta name ="description "content =""> 8< meta name ="viewport "content ="width=device-width, initial-scale=1 "> 9< link rel ="stylesheet "href ="../assets/css/main.css "> 10</ head > 11< body > 12< header > 13< div class ="tsd-page-toolbar "> 14< div class ="container "> 15< div class ="table-wrap "> 16< div class ="table-cell "id ="tsd-search "data-index ="../assets/js/search.js "data-base =".. "> 17< div class ="field "> 18< label for ="tsd-search-field "class ="tsd-widget search no-caption "> Search</ label > 19< input id ="tsd-search-field "type ="text "/> 20</ div > 21< ul class ="results "> 22< li class ="state loading "> Preparing search index...</ li > 23< li class ="state failure "> The search index is not available</ li > 24</ ul > 25< a href ="../index.html "class ="title "> livesplit</ a > 26</ div > 27< div class ="table-cell "id ="tsd-widgets "> 28< div id ="tsd-filter "> 29< a href ="# "class ="tsd-widget options no-caption "data-toggle ="options "> Options</ a > 30< div class ="tsd-filter-group "> 31< div class ="tsd-select "id ="tsd-filter-visibility "> 32< span class ="tsd-select-label "> All</ span > 33< ul class ="tsd-select-list "> 34< li data-value ="public "> Public</ li > 35< li data-value ="protected "> Public/Protected</ li > 36< li data-value ="private "class ="selected "> All</ li > 37</ ul > 38</ div > 39< input type ="checkbox "id ="tsd-filter-inherited "checked /> 40< label class ="tsd-widget "for ="tsd-filter-inherited "> Inherited</ label > 41< input type ="checkbox "id ="tsd-filter-externals "checked /> 42< label class ="tsd-widget "for ="tsd-filter-externals "> Externals</ label > 43< input type ="checkbox "id ="tsd-filter-only-exported "/> 44< label class ="tsd-widget "for ="tsd-filter-only-exported "> Only exported</ label > 45</ div > 46</ div > 47< a href ="# "class ="tsd-widget menu no-caption "data-toggle ="menu "> Menu</ a > 48</ div > 49</ div > 50</ div > 51</ div > 52< div class ="tsd-page-title "> 53< div class ="container "> 54< ul class ="tsd-breadcrumb "> 55< li > 56< a href ="../globals.html "> Globals</ a > 57</ li > 58< li > 59< a href ="runref.html "> RunRef</ a > 60</ li > 61</ ul > 62< h1 > Class RunRef</ h1 > 63</ div > 64</ div > 65</ header > 66< div class ="container container-main "> 67< div class ="row "> 68< div class ="col-8 col-content "> 69< section class ="tsd-panel tsd-comment "> 70< div class ="tsd-comment tsd-typography "> 71< div class ="lead "> 72< p > A Run stores the split times for a specific game and category of a runner.</ p > 73</ div > 74</ div > 75</ section > 76< section class ="tsd-panel tsd-hierarchy "> 77< h3 > Hierarchy</ h3 > 78< ul class ="tsd-hierarchy "> 79< li > 80< span class ="target "> RunRef</ span > 81< ul class ="tsd-hierarchy "> 82< li > 83< a href ="runrefmut.html "class ="tsd-signature-type "> RunRefMut</ a > 84</ li > 85</ ul > 86</ li > 87</ ul > 88</ section > 89< section class ="tsd-panel-group tsd-index-group "> 90< h2 > Index</ h2 > 91< section class ="tsd-panel tsd-index-panel "> 92< div class ="tsd-index-content "> 93< section class ="tsd-index-section "> 94< h3 > Constructors</ h3 > 95< ul class ="tsd-index-list "> 96< li class ="tsd-kind-constructor tsd-parent-kind-class ">< a href ="runref.html#constructor "class ="tsd-kind-icon "> constructor</ a ></ li > 97</ ul > 98</ section > 99< section class ="tsd-index-section "> 100< h3 > Properties</ h3 > 101< ul class ="tsd-index-list "> 102< li class ="tsd-kind-property tsd-parent-kind-class ">< a href ="runref.html#ptr "class ="tsd-kind-icon "> ptr</ a ></ li > 103</ ul > 104</ section > 105< section class ="tsd-index-section "> 106< h3 > Methods</ h3 > 107< ul class ="tsd-index-list "> 108< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#attemptcount "class ="tsd-kind-icon "> attempt< wbr > Count</ a ></ li > 109< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#attempthistoryindex "class ="tsd-kind-icon "> attempt< wbr > History< wbr > Index</ a ></ li > 110< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#attempthistorylen "class ="tsd-kind-icon "> attempt< wbr > History< wbr > Len</ a ></ li > 111< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#autosplittersettings "class ="tsd-kind-icon "> auto< wbr > Splitter< wbr > Settings</ a ></ li > 112< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#categoryname "class ="tsd-kind-icon "> category< wbr > Name</ a ></ li > 113< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#clone "class ="tsd-kind-icon "> clone</ a ></ li > 114< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#customcomparison "class ="tsd-kind-icon "> custom< wbr > Comparison</ a ></ li > 115< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#customcomparisonslen "class ="tsd-kind-icon "> custom< wbr > Comparisons< wbr > Len</ a ></ li > 116< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#extendedcategoryname "class ="tsd-kind-icon "> extended< wbr > Category< wbr > Name</ a ></ li > 117< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#extendedfilename "class ="tsd-kind-icon "> extended< wbr > File< wbr > Name</ a ></ li > 118< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#extendedname "class ="tsd-kind-icon "> extended< wbr > Name</ a ></ li > 119< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#gameicon "class ="tsd-kind-icon "> game< wbr > Icon</ a ></ li > 120< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#gamename "class ="tsd-kind-icon "> game< wbr > Name</ a ></ li > 121< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#hasbeenmodified "class ="tsd-kind-icon "> has< wbr > Been< wbr > Modified</ a ></ li > 122< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#len "class ="tsd-kind-icon "> len</ a ></ li > 123< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#metadata "class ="tsd-kind-icon "> metadata</ a ></ li > 124< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#offset "class ="tsd-kind-icon "> offset</ a ></ li > 125< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#saveaslss "class ="tsd-kind-icon "> save< wbr > AsLss</ a ></ li > 126< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="runref.html#segment "class ="tsd-kind-icon "> segment</ a ></ li > 127</ ul > 128</ section > 129</ div > 130</ section > 131</ section > 132< section class ="tsd-panel-group tsd-member-group "> 133< h2 > Constructors</ h2 > 134< section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class "> 135< a name ="constructor "class ="tsd-anchor "></ a > 136< h3 > constructor</ h3 > 137< ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class "> 138< li class ="tsd-signature tsd-kind-icon "> new< wbr > Run< wbr > Ref< span class ="tsd-signature-symbol "> (</ span > ptr< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> number</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="runref.html "class ="tsd-signature-type "> RunRef</ a ></ li > 139</ ul > 140< ul class ="tsd-descriptions "> 141< li class ="tsd-description "> 142< aside class ="tsd-sources "> 143< ul > 144< li > Defined in livesplit_core.ts:4118</ li > 145</ ul > 146</ aside > 147< div class ="tsd-comment tsd-typography "> 148< div class ="lead "> 149< p > This constructor is an implementation detail. Do not use this.</ p > 150</ div > 151</ div > 152< h4 class ="tsd-parameters-title "> Parameters</ h4 > 153< ul class ="tsd-parameters "> 154< li > 155< h5 > ptr:< span class ="tsd-signature-type "> number</ span ></ h5 > 156</ li > 157</ ul > 158< h4 class ="tsd-returns-title "> Returns< a href ="runref.html "class ="tsd-signature-type "> RunRef</ a ></ h4 > 159</ li > 160</ ul > 161</ section > 162</ section > 163< section class ="tsd-panel-group tsd-member-group "> 164< h2 > Properties</ h2 > 165< section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class "> 166< a name ="ptr "class ="tsd-anchor "></ a > 167< h3 > ptr</ h3 > 168< div class ="tsd-signature tsd-kind-icon "> ptr< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> number</ span ></ div > 169< aside class ="tsd-sources "> 170< ul > 171< li > Defined in livesplit_core.ts:3901</ li > 172</ ul > 173</ aside > 174</ section > 175</ section > 176< section class ="tsd-panel-group tsd-member-group "> 177< h2 > Methods</ h2 > 178< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 179< a name ="attemptcount "class ="tsd-anchor "></ a > 180< h3 > attempt< wbr > Count</ h3 > 181< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 182< li class ="tsd-signature tsd-kind-icon "> attempt< wbr > Count< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> number</ span ></ li > 183</ ul > 184< ul class ="tsd-descriptions "> 185< li class ="tsd-description "> 186< aside class ="tsd-sources "> 187< ul > 188< li > Defined in livesplit_core.ts:3992</ li > 189</ ul > 190</ aside > 191< div class ="tsd-comment tsd-typography "> 192< div class ="lead "> 193< p > Returns the amount of runs that have been attempted with these splits.</ p > 194</ div > 195</ div > 196< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> number</ span ></ h4 > 197</ li > 198</ ul > 199</ section > 200< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 201< a name ="attempthistoryindex "class ="tsd-anchor "></ a > 202< h3 > attempt< wbr > History< wbr > Index</ h3 > 203< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 204< li class ="tsd-signature tsd-kind-icon "> attempt< wbr > History< wbr > Index< span class ="tsd-signature-symbol "> (</ span > index< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> number</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="attemptref.html "class ="tsd-signature-type "> AttemptRef</ a ></ li > 205</ ul > 206< ul class ="tsd-descriptions "> 207< li class ="tsd-description "> 208< aside class ="tsd-sources "> 209< ul > 210< li > Defined in livesplit_core.ts:4068</ li > 211</ ul > 212</ aside > 213< div class ="tsd-comment tsd-typography "> 214< div class ="lead "> 215< p > Accesses the an attempt history element by its index. This does not store 216 the actual segment times, just the overall attempt information. Information 217 about the individual segments is stored within each segment. You may not 218 provide an out of bounds index.</ p > 219</ div > 220</ div > 221< h4 class ="tsd-parameters-title "> Parameters</ h4 > 222< ul class ="tsd-parameters "> 223< li > 224< h5 > index:< span class ="tsd-signature-type "> number</ span ></ h5 > 225</ li > 226</ ul > 227< h4 class ="tsd-returns-title "> Returns< a href ="attemptref.html "class ="tsd-signature-type "> AttemptRef</ a ></ h4 > 228</ li > 229</ ul > 230</ section > 231< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 232< a name ="attempthistorylen "class ="tsd-anchor "></ a > 233< h3 > attempt< wbr > History< wbr > Len</ h3 > 234< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 235< li class ="tsd-signature tsd-kind-icon "> attempt< wbr > History< wbr > Len< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> number</ span ></ li > 236</ ul > 237< ul class ="tsd-descriptions "> 238< li class ="tsd-description "> 239< aside class ="tsd-sources "> 240< ul > 241< li > Defined in livesplit_core.ts:4055</ li > 242</ ul > 243</ aside > 244< div class ="tsd-comment tsd-typography "> 245< div class ="lead "> 246< p > Returns the amount attempt history elements are stored in this Run.</ p > 247</ div > 248</ div > 249< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> number</ span ></ h4 > 250</ li > 251</ ul > 252</ section > 253< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 254< a name ="autosplittersettings "class ="tsd-anchor "></ a > 255< h3 > auto< wbr > Splitter< wbr > Settings</ h3 > 256< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 257< li class ="tsd-signature tsd-kind-icon "> auto< wbr > Splitter< wbr > Settings< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span ></ li > 258</ ul > 259< ul class ="tsd-descriptions "> 260< li class ="tsd-description "> 261< aside class ="tsd-sources "> 262< ul > 263< li > Defined in livesplit_core.ts:4112</ li > 264</ ul > 265</ aside > 266< div class ="tsd-comment tsd-typography "> 267< div class ="lead "> 268< p > Accesses the Auto Splitter Settings that are encoded as XML.</ p > 269</ div > 270</ div > 271< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 272</ li > 273</ ul > 274</ section > 275< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 276< a name ="categoryname "class ="tsd-anchor "></ a > 277< h3 > category< wbr > Name</ h3 > 278< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 279< li class ="tsd-signature tsd-kind-icon "> category< wbr > Name< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span ></ li > 280</ ul > 281< ul class ="tsd-descriptions "> 282< li class ="tsd-description "> 283< aside class ="tsd-sources "> 284< ul > 285< li > Defined in livesplit_core.ts:3936</ li > 286</ ul > 287</ aside > 288< div class ="tsd-comment tsd-typography "> 289< div class ="lead "> 290< p > Accesses the name of the category this Run is for.</ p > 291</ div > 292</ div > 293< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 294</ li > 295</ ul > 296</ section > 297< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 298< a name ="clone "class ="tsd-anchor "></ a > 299< h3 > clone</ h3 > 300< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 301< li class ="tsd-signature tsd-kind-icon "> clone< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="run.html "class ="tsd-signature-type "> Run</ a ></ li > 302</ ul > 303< ul class ="tsd-descriptions "> 304< li class ="tsd-description "> 305< aside class ="tsd-sources "> 306< ul > 307< li > Defined in livesplit_core.ts:3905</ li > 308</ ul > 309</ aside > 310< div class ="tsd-comment tsd-typography "> 311< div class ="lead "> 312< p > Clones the Run object.</ p > 313</ div > 314</ div > 315< h4 class ="tsd-returns-title "> Returns< a href ="run.html "class ="tsd-signature-type "> Run</ a ></ h4 > 316</ li > 317</ ul > 318</ section > 319< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 320< a name ="customcomparison "class ="tsd-anchor "></ a > 321< h3 > custom< wbr > Comparison</ h3 > 322< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 323< li class ="tsd-signature tsd-kind-icon "> custom< wbr > Comparison< span class ="tsd-signature-symbol "> (</ span > index< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> number</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span ></ li > 324</ ul > 325< ul class ="tsd-descriptions "> 326< li class ="tsd-description "> 327< aside class ="tsd-sources "> 328< ul > 329< li > Defined in livesplit_core.ts:4102</ li > 330</ ul > 331</ aside > 332< div class ="tsd-comment tsd-typography "> 333< div class ="lead "> 334< p > Accesses a custom comparison stored in this Run by its index. This includes 335< code > Personal Best</ code > but excludes all the other Comparison Generators. You may 336 not provide an out of bounds index.</ p > 337</ div > 338</ div > 339< h4 class ="tsd-parameters-title "> Parameters</ h4 > 340< ul class ="tsd-parameters "> 341< li > 342< h5 > index:< span class ="tsd-signature-type "> number</ span ></ h5 > 343</ li > 344</ ul > 345< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 346</ li > 347</ ul > 348</ section > 349< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 350< a name ="customcomparisonslen "class ="tsd-anchor "></ a > 351< h3 > custom< wbr > Comparisons< wbr > Len</ h3 > 352< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 353< li class ="tsd-signature tsd-kind-icon "> custom< wbr > Comparisons< wbr > Len< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> number</ span ></ li > 354</ ul > 355< ul class ="tsd-descriptions "> 356< li class ="tsd-description "> 357< aside class ="tsd-sources "> 358< ul > 359< li > Defined in livesplit_core.ts:4090</ li > 360</ ul > 361</ aside > 362< div class ="tsd-comment tsd-typography "> 363< div class ="lead "> 364< p > Returns the amount of custom comparisons stored in this Run.</ p > 365</ div > 366</ div > 367< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> number</ span ></ h4 > 368</ li > 369</ ul > 370</ section > 371< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 372< a name ="extendedcategoryname "class ="tsd-anchor "></ a > 373< h3 > extended< wbr > Category< wbr > Name</ h3 > 374< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 375< li class ="tsd-signature tsd-kind-icon "> extended< wbr > Category< wbr > Name< span class ="tsd-signature-symbol "> (</ span > showRegion< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> boolean</ span > , showPlatform< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> boolean</ span > , showVariables< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> boolean</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span ></ li > 376</ ul > 377< ul class ="tsd-descriptions "> 378< li class ="tsd-description "> 379< aside class ="tsd-sources "> 380< ul > 381< li > Defined in livesplit_core.ts:3982</ li > 382</ ul > 383</ aside > 384< div class ="tsd-comment tsd-typography "> 385< div class ="lead "> 386< p > Returns an extended category name that possibly includes the region, 387 platform and variables, depending on the arguments provided. An extended 388 category name may look like this:</ p > 389</ div > 390< p > Any% (No Tuner, JPN, Wii Emulator)</ p > 391</ div > 392< h4 class ="tsd-parameters-title "> Parameters</ h4 > 393< ul class ="tsd-parameters "> 394< li > 395< h5 > showRegion:< span class ="tsd-signature-type "> boolean</ span ></ h5 > 396</ li > 397< li > 398< h5 > showPlatform:< span class ="tsd-signature-type "> boolean</ span ></ h5 > 399</ li > 400< li > 401< h5 > showVariables:< span class ="tsd-signature-type "> boolean</ span ></ h5 > 402</ li > 403</ ul > 404< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 405</ li > 406</ ul > 407</ section > 408< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 409< a name ="extendedfilename "class ="tsd-anchor "></ a > 410< h3 > extended< wbr > File< wbr > Name</ h3 > 411< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 412< li class ="tsd-signature tsd-kind-icon "> extended< wbr > File< wbr > Name< span class ="tsd-signature-symbol "> (</ span > useExtendedCategoryName< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> boolean</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span ></ li > 413</ ul > 414< ul class ="tsd-descriptions "> 415< li class ="tsd-description "> 416< aside class ="tsd-sources "> 417< ul > 418< li > Defined in livesplit_core.ts:3953</ li > 419</ ul > 420</ aside > 421< div class ="tsd-comment tsd-typography "> 422< div class ="lead "> 423< p > Returns a file name (without the extension) suitable for this Run that 424 is built the following way:</ p > 425</ div > 426< p > Game Name - Category Name</ p > 427< p > If either is empty, the dash is omitted. Special characters that cause 428 problems in file names are also omitted. If an extended category name is 429 used, the variables of the category are appended in a parenthesis.</ p > 430</ div > 431< h4 class ="tsd-parameters-title "> Parameters</ h4 > 432< ul class ="tsd-parameters "> 433< li > 434< h5 > useExtendedCategoryName:< span class ="tsd-signature-type "> boolean</ span ></ h5 > 435</ li > 436</ ul > 437< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 438</ li > 439</ ul > 440</ section > 441< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 442< a name ="extendedname "class ="tsd-anchor "></ a > 443< h3 > extended< wbr > Name</ h3 > 444< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 445< li class ="tsd-signature tsd-kind-icon "> extended< wbr > Name< span class ="tsd-signature-symbol "> (</ span > useExtendedCategoryName< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> boolean</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span ></ li > 446</ ul > 447< ul class ="tsd-descriptions "> 448< li class ="tsd-description "> 449< aside class ="tsd-sources "> 450< ul > 451< li > Defined in livesplit_core.ts:3968</ li > 452</ ul > 453</ aside > 454< div class ="tsd-comment tsd-typography "> 455< div class ="lead "> 456< p > Returns a name suitable for this Run that is built the following way:</ p > 457</ div > 458< p > Game Name - Category Name</ p > 459< p > If either is empty, the dash is omitted. If an extended category name is 460 used, the variables of the category are appended in a parenthesis.</ p > 461</ div > 462< h4 class ="tsd-parameters-title "> Parameters</ h4 > 463< ul class ="tsd-parameters "> 464< li > 465< h5 > useExtendedCategoryName:< span class ="tsd-signature-type "> boolean</ span ></ h5 > 466</ li > 467</ ul > 468< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 469</ li > 470</ ul > 471</ section > 472< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 473< a name ="gameicon "class ="tsd-anchor "></ a > 474< h3 > game< wbr > Icon</ h3 > 475< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 476< li class ="tsd-signature tsd-kind-icon "> game< wbr > Icon< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span ></ li > 477</ ul > 478< ul class ="tsd-descriptions "> 479< li class ="tsd-description "> 480< aside class ="tsd-sources "> 481< ul > 482< li > Defined in livesplit_core.ts:3926</ li > 483</ ul > 484</ aside > 485< div class ="tsd-comment tsd-typography "> 486< div class ="lead "> 487< p > Accesses the Data URL storing the game icon's data. If there is no game 488 icon, this returns an empty string instead of a URL.</ p > 489</ div > 490</ div > 491< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 492</ li > 493</ ul > 494</ section > 495< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 496< a name ="gamename "class ="tsd-anchor "></ a > 497< h3 > game< wbr > Name</ h3 > 498< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 499< li class ="tsd-signature tsd-kind-icon "> game< wbr > Name< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span ></ li > 500</ ul > 501< ul class ="tsd-descriptions "> 502< li class ="tsd-description "> 503< aside class ="tsd-sources "> 504< ul > 505< li > Defined in livesplit_core.ts:3915</ li > 506</ ul > 507</ aside > 508< div class ="tsd-comment tsd-typography "> 509< div class ="lead "> 510< p > Accesses the name of the game this Run is for.</ p > 511</ div > 512</ div > 513< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 514</ li > 515</ ul > 516</ section > 517< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 518< a name ="hasbeenmodified "class ="tsd-anchor "></ a > 519< h3 > has< wbr > Been< wbr > Modified</ h3 > 520< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 521< li class ="tsd-signature tsd-kind-icon "> has< wbr > Been< wbr > Modified< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> boolean</ span ></ li > 522</ ul > 523< ul class ="tsd-descriptions "> 524< li class ="tsd-description "> 525< aside class ="tsd-sources "> 526< ul > 527< li > Defined in livesplit_core.ts:4034</ li > 528</ ul > 529</ aside > 530< div class ="tsd-comment tsd-typography "> 531< div class ="lead "> 532< p > Returns whether the Run has been modified and should be saved so that the 533 changes don't get lost.</ p > 534</ div > 535</ div > 536< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> boolean</ span ></ h4 > 537</ li > 538</ ul > 539</ section > 540< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 541< a name ="len "class ="tsd-anchor "></ a > 542< h3 > len</ h3 > 543< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 544< li class ="tsd-signature tsd-kind-icon "> len< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> number</ span ></ li > 545</ ul > 546< ul class ="tsd-descriptions "> 547< li class ="tsd-description "> 548< aside class ="tsd-sources "> 549< ul > 550< li > Defined in livesplit_core.ts:4023</ li > 551</ ul > 552</ aside > 553< div class ="tsd-comment tsd-typography "> 554< div class ="lead "> 555< p > Returns the amount of segments stored in this Run.</ p > 556</ div > 557</ div > 558< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> number</ span ></ h4 > 559</ li > 560</ ul > 561</ section > 562< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 563< a name ="metadata "class ="tsd-anchor "></ a > 564< h3 > metadata</ h3 > 565< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 566< li class ="tsd-signature tsd-kind-icon "> metadata< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="runmetadataref.html "class ="tsd-signature-type "> RunMetadataRef</ a ></ li > 567</ ul > 568< ul class ="tsd-descriptions "> 569< li class ="tsd-description "> 570< aside class ="tsd-sources "> 571< ul > 572< li > Defined in livesplit_core.ts:4003</ li > 573</ ul > 574</ aside > 575< div class ="tsd-comment tsd-typography "> 576< div class ="lead "> 577< p > Accesses additional metadata of this Run, like the platform and region 578 of the game.</ p > 579</ div > 580</ div > 581< h4 class ="tsd-returns-title "> Returns< a href ="runmetadataref.html "class ="tsd-signature-type "> RunMetadataRef</ a ></ h4 > 582</ li > 583</ ul > 584</ section > 585< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 586< a name ="offset "class ="tsd-anchor "></ a > 587< h3 > offset</ h3 > 588< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 589< li class ="tsd-signature tsd-kind-icon "> offset< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="timespanref.html "class ="tsd-signature-type "> TimeSpanRef</ a ></ li > 590</ ul > 591< ul class ="tsd-descriptions "> 592< li class ="tsd-description "> 593< aside class ="tsd-sources "> 594< ul > 595< li > Defined in livesplit_core.ts:4013</ li > 596</ ul > 597</ aside > 598< div class ="tsd-comment tsd-typography "> 599< div class ="lead "> 600< p > Accesses the time an attempt of this Run should start at.</ p > 601</ div > 602</ div > 603< h4 class ="tsd-returns-title "> Returns< a href ="timespanref.html "class ="tsd-signature-type "> TimeSpanRef</ a ></ h4 > 604</ li > 605</ ul > 606</ section > 607< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 608< a name ="saveaslss "class ="tsd-anchor "></ a > 609< h3 > save< wbr > AsLss</ h3 > 610< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 611< li class ="tsd-signature tsd-kind-icon "> save< wbr > AsLss< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span ></ li > 612</ ul > 613< ul class ="tsd-descriptions "> 614< li class ="tsd-description "> 615< aside class ="tsd-sources "> 616< ul > 617< li > Defined in livesplit_core.ts:4080</ li > 618</ ul > 619</ aside > 620< div class ="tsd-comment tsd-typography "> 621< div class ="lead "> 622< p > Saves a Run as a LiveSplit splits file (*.lss). If the run is actively in 623 use by a timer, use the appropriate method on the timer instead, in order to 624 properly save the current attempt as well.</ p > 625</ div > 626</ div > 627< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 628</ li > 629</ ul > 630</ section > 631< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 632< a name ="segment "class ="tsd-anchor "></ a > 633< h3 > segment</ h3 > 634< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 635< li class ="tsd-signature tsd-kind-icon "> segment< span class ="tsd-signature-symbol "> (</ span > index< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> number</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="segmentref.html "class ="tsd-signature-type "> SegmentRef</ a ></ li > 636</ ul > 637< ul class ="tsd-descriptions "> 638< li class ="tsd-description "> 639< aside class ="tsd-sources "> 640< ul > 641< li > Defined in livesplit_core.ts:4045</ li > 642</ ul > 643</ aside > 644< div class ="tsd-comment tsd-typography "> 645< div class ="lead "> 646< p > Accesses a certain segment of this Run. You may not provide an out of bounds 647 index.</ p > 648</ div > 649</ div > 650< h4 class ="tsd-parameters-title "> Parameters</ h4 > 651< ul class ="tsd-parameters "> 652< li > 653< h5 > index:< span class ="tsd-signature-type "> number</ span ></ h5 > 654</ li > 655</ ul > 656< h4 class ="tsd-returns-title "> Returns< a href ="segmentref.html "class ="tsd-signature-type "> SegmentRef</ a ></ h4 > 657</ li > 658</ ul > 659</ section > 660</ section > 661</ div > 662< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 663< nav class ="tsd-navigation primary "> 664< ul > 665< li class ="globals "> 666< a href ="../globals.html ">< em > Globals</ em ></ a > 667</ li > 668</ ul > 669</ nav > 670< nav class ="tsd-navigation secondary menu-sticky "> 671< ul class ="before-current "> 672</ ul > 673< ul class ="current "> 674< li class ="current tsd-kind-class "> 675< a href ="runref.html "class ="tsd-kind-icon "> Run< wbr > Ref</ a > 676< ul > 677< li class ="tsd-kind-constructor tsd-parent-kind-class "> 678< a href ="runref.html#constructor "class ="tsd-kind-icon "> constructor</ a > 679</ li > 680< li class ="tsd-kind-property tsd-parent-kind-class "> 681< a href ="runref.html#ptr "class ="tsd-kind-icon "> ptr</ a > 682</ li > 683< li class ="tsd-kind-method tsd-parent-kind-class "> 684< a href ="runref.html#attemptcount "class ="tsd-kind-icon "> attempt< wbr > Count</ a > 685</ li > 686< li class ="tsd-kind-method tsd-parent-kind-class "> 687< a href ="runref.html#attempthistoryindex "class ="tsd-kind-icon "> attempt< wbr > History< wbr > Index</ a > 688</ li > 689< li class ="tsd-kind-method tsd-parent-kind-class "> 690< a href ="runref.html#attempthistorylen "class ="tsd-kind-icon "> attempt< wbr > History< wbr > Len</ a > 691</ li > 692< li class ="tsd-kind-method tsd-parent-kind-class "> 693< a href ="runref.html#autosplittersettings "class ="tsd-kind-icon "> auto< wbr > Splitter< wbr > Settings</ a > 694</ li > 695< li class ="tsd-kind-method tsd-parent-kind-class "> 696< a href ="runref.html#categoryname "class ="tsd-kind-icon "> category< wbr > Name</ a > 697</ li > 698< li class ="tsd-kind-method tsd-parent-kind-class "> 699< a href ="runref.html#clone "class ="tsd-kind-icon "> clone</ a > 700</ li > 701< li class ="tsd-kind-method tsd-parent-kind-class "> 702< a href ="runref.html#customcomparison "class ="tsd-kind-icon "> custom< wbr > Comparison</ a > 703</ li > 704< li class ="tsd-kind-method tsd-parent-kind-class "> 705< a href ="runref.html#customcomparisonslen "class ="tsd-kind-icon "> custom< wbr > Comparisons< wbr > Len</ a > 706</ li > 707< li class ="tsd-kind-method tsd-parent-kind-class "> 708< a href ="runref.html#extendedcategoryname "class ="tsd-kind-icon "> extended< wbr > Category< wbr > Name</ a > 709</ li > 710< li class ="tsd-kind-method tsd-parent-kind-class "> 711< a href ="runref.html#extendedfilename "class ="tsd-kind-icon "> extended< wbr > File< wbr > Name</ a > 712</ li > 713< li class ="tsd-kind-method tsd-parent-kind-class "> 714< a href ="runref.html#extendedname "class ="tsd-kind-icon "> extended< wbr > Name</ a > 715</ li > 716< li class ="tsd-kind-method tsd-parent-kind-class "> 717< a href ="runref.html#gameicon "class ="tsd-kind-icon "> game< wbr > Icon</ a > 718</ li > 719< li class ="tsd-kind-method tsd-parent-kind-class "> 720< a href ="runref.html#gamename "class ="tsd-kind-icon "> game< wbr > Name</ a > 721</ li > 722< li class ="tsd-kind-method tsd-parent-kind-class "> 723< a href ="runref.html#hasbeenmodified "class ="tsd-kind-icon "> has< wbr > Been< wbr > Modified</ a > 724</ li > 725< li class ="tsd-kind-method tsd-parent-kind-class "> 726< a href ="runref.html#len "class ="tsd-kind-icon "> len</ a > 727</ li > 728< li class ="tsd-kind-method tsd-parent-kind-class "> 729< a href ="runref.html#metadata "class ="tsd-kind-icon "> metadata</ a > 730</ li > 731< li class ="tsd-kind-method tsd-parent-kind-class "> 732< a href ="runref.html#offset "class ="tsd-kind-icon "> offset</ a > 733</ li > 734< li class ="tsd-kind-method tsd-parent-kind-class "> 735< a href ="runref.html#saveaslss "class ="tsd-kind-icon "> save< wbr > AsLss</ a > 736</ li > 737< li class ="tsd-kind-method tsd-parent-kind-class "> 738< a href ="runref.html#segment "class ="tsd-kind-icon "> segment</ a > 739</ li > 740</ ul > 741</ li > 742</ ul > 743< ul class ="after-current "> 744</ ul > 745</ nav > 746</ div > 747</ div > 748</ div > 749< footer class ="with-border-bottom "> 750< div class ="container "> 751< h2 > Legend</ h2 > 752< div class ="tsd-legend-group "> 753< ul class ="tsd-legend "> 754< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 755< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 756< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 757< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 758< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 759< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 760< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 761</ ul > 762< ul class ="tsd-legend "> 763< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 764< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 765< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 766< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 767</ ul > 768< ul class ="tsd-legend "> 769< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 770< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 771< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 772< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 773< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 774< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 775</ ul > 776< ul class ="tsd-legend "> 777< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 778< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 779< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 780< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 781< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 782< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 783< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 784</ ul > 785< ul class ="tsd-legend "> 786< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 787< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 788< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 789< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 790</ ul > 791< ul class ="tsd-legend "> 792< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 793< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 794< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 795</ ul > 796< ul class ="tsd-legend "> 797< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 798< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 799< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 800</ ul > 801< ul class ="tsd-legend "> 802< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 803< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 804</ ul > 805</ div > 806</ div > 807</ footer > 808< div class ="container tsd-generator "> 809< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 810</ div > 811< div class ="overlay "></ div > 812< script src ="../assets/js/main.js "></ script > 813< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 814</ body > 815</ html >