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 > ParseRunResultRef | 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 ="parserunresultref.html "> ParseRunResultRef</ a > 60</ li > 61</ ul > 62< h1 > Class ParseRunResultRef</ 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 parsed by the Composite Parser. This contains the Run itself and 73 information about which parser parsed it.</ p > 74</ div > 75</ div > 76</ section > 77< section class ="tsd-panel tsd-hierarchy "> 78< h3 > Hierarchy</ h3 > 79< ul class ="tsd-hierarchy "> 80< li > 81< span class ="target "> ParseRunResultRef</ span > 82< ul class ="tsd-hierarchy "> 83< li > 84< a href ="parserunresultrefmut.html "class ="tsd-signature-type "> ParseRunResultRefMut</ a > 85</ li > 86</ ul > 87</ li > 88</ ul > 89</ section > 90< section class ="tsd-panel-group tsd-index-group "> 91< h2 > Index</ h2 > 92< section class ="tsd-panel tsd-index-panel "> 93< div class ="tsd-index-content "> 94< section class ="tsd-index-section "> 95< h3 > Constructors</ h3 > 96< ul class ="tsd-index-list "> 97< li class ="tsd-kind-constructor tsd-parent-kind-class ">< a href ="parserunresultref.html#constructor "class ="tsd-kind-icon "> constructor</ a ></ li > 98</ ul > 99</ section > 100< section class ="tsd-index-section "> 101< h3 > Properties</ h3 > 102< ul class ="tsd-index-list "> 103< li class ="tsd-kind-property tsd-parent-kind-class ">< a href ="parserunresultref.html#ptr "class ="tsd-kind-icon "> ptr</ a ></ li > 104</ ul > 105</ section > 106< section class ="tsd-index-section "> 107< h3 > Methods</ h3 > 108< ul class ="tsd-index-list "> 109< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="parserunresultref.html#isgenerictimer "class ="tsd-kind-icon "> is< wbr > Generic< wbr > Timer</ a ></ li > 110< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="parserunresultref.html#parsedsuccessfully "class ="tsd-kind-icon "> parsed< wbr > Successfully</ a ></ li > 111< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="parserunresultref.html#timerkind "class ="tsd-kind-icon "> timer< wbr > Kind</ a ></ li > 112</ ul > 113</ section > 114</ div > 115</ section > 116</ section > 117< section class ="tsd-panel-group tsd-member-group "> 118< h2 > Constructors</ h2 > 119< section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class "> 120< a name ="constructor "class ="tsd-anchor "></ a > 121< h3 > constructor</ h3 > 122< ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class "> 123< li class ="tsd-signature tsd-kind-icon "> new< wbr > Parse< wbr > Run< wbr > Result< 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 ="parserunresultref.html "class ="tsd-signature-type "> ParseRunResultRef</ a ></ li > 124</ ul > 125< ul class ="tsd-descriptions "> 126< li class ="tsd-description "> 127< aside class ="tsd-sources "> 128< ul > 129< li > Defined in livesplit_core.ts:3405</ li > 130</ ul > 131</ aside > 132< div class ="tsd-comment tsd-typography "> 133< div class ="lead "> 134< p > This constructor is an implementation detail. Do not use this.</ p > 135</ div > 136</ div > 137< h4 class ="tsd-parameters-title "> Parameters</ h4 > 138< ul class ="tsd-parameters "> 139< li > 140< h5 > ptr:< span class ="tsd-signature-type "> number</ span ></ h5 > 141</ li > 142</ ul > 143< h4 class ="tsd-returns-title "> Returns< a href ="parserunresultref.html "class ="tsd-signature-type "> ParseRunResultRef</ a ></ h4 > 144</ li > 145</ ul > 146</ section > 147</ section > 148< section class ="tsd-panel-group tsd-member-group "> 149< h2 > Properties</ h2 > 150< section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class "> 151< a name ="ptr "class ="tsd-anchor "></ a > 152< h3 > ptr</ h3 > 153< div class ="tsd-signature tsd-kind-icon "> ptr< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> number</ span ></ div > 154< aside class ="tsd-sources "> 155< ul > 156< li > Defined in livesplit_core.ts:3371</ li > 157</ ul > 158</ aside > 159</ section > 160</ section > 161< section class ="tsd-panel-group tsd-member-group "> 162< h2 > Methods</ h2 > 163< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 164< a name ="isgenerictimer "class ="tsd-anchor "></ a > 165< h3 > is< wbr > Generic< wbr > Timer</ h3 > 166< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 167< li class ="tsd-signature tsd-kind-icon "> is< wbr > Generic< wbr > Timer< 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 > 168</ ul > 169< ul class ="tsd-descriptions "> 170< li class ="tsd-description "> 171< aside class ="tsd-sources "> 172< ul > 173< li > Defined in livesplit_core.ts:3399</ li > 174</ ul > 175</ aside > 176< div class ="tsd-comment tsd-typography "> 177< div class ="lead "> 178< p > Checks whether the Parser parsed a generic timer. Since a generic timer can 179 have any name, it may clash with the specific timer formats that 180 livesplit-core supports. With this function you can determine if a generic 181 timer format was parsed, instead of one of the more specific timer formats.</ p > 182</ div > 183</ div > 184< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> boolean</ span ></ h4 > 185</ li > 186</ ul > 187</ section > 188< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 189< a name ="parsedsuccessfully "class ="tsd-anchor "></ a > 190< h3 > parsed< wbr > Successfully</ h3 > 191< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 192< li class ="tsd-signature tsd-kind-icon "> parsed< wbr > Successfully< 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 > 193</ ul > 194< ul class ="tsd-descriptions "> 195< li class ="tsd-description "> 196< aside class ="tsd-sources "> 197< ul > 198< li > Defined in livesplit_core.ts:3375</ li > 199</ ul > 200</ aside > 201< div class ="tsd-comment tsd-typography "> 202< div class ="lead "> 203< p > Returns true if the Run got parsed successfully. false is returned otherwise.</ p > 204</ div > 205</ div > 206< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> boolean</ span ></ h4 > 207</ li > 208</ ul > 209</ section > 210< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 211< a name ="timerkind "class ="tsd-anchor "></ a > 212< h3 > timer< wbr > Kind</ h3 > 213< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 214< li class ="tsd-signature tsd-kind-icon "> timer< wbr > Kind< 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 > 215</ ul > 216< ul class ="tsd-descriptions "> 217< li class ="tsd-description "> 218< aside class ="tsd-sources "> 219< ul > 220< li > Defined in livesplit_core.ts:3386</ li > 221</ ul > 222</ aside > 223< div class ="tsd-comment tsd-typography "> 224< div class ="lead "> 225< p > Accesses the name of the Parser that parsed the Run. You may not call this 226 if the Run wasn't parsed successfully.</ p > 227</ div > 228</ div > 229< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 230</ li > 231</ ul > 232</ section > 233</ section > 234</ div > 235< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 236< nav class ="tsd-navigation primary "> 237< ul > 238< li class ="globals "> 239< a href ="../globals.html ">< em > Globals</ em ></ a > 240</ li > 241</ ul > 242</ nav > 243< nav class ="tsd-navigation secondary menu-sticky "> 244< ul class ="before-current "> 245</ ul > 246< ul class ="current "> 247< li class ="current tsd-kind-class "> 248< a href ="parserunresultref.html "class ="tsd-kind-icon "> Parse< wbr > Run< wbr > Result< wbr > Ref</ a > 249< ul > 250< li class ="tsd-kind-constructor tsd-parent-kind-class "> 251< a href ="parserunresultref.html#constructor "class ="tsd-kind-icon "> constructor</ a > 252</ li > 253< li class ="tsd-kind-property tsd-parent-kind-class "> 254< a href ="parserunresultref.html#ptr "class ="tsd-kind-icon "> ptr</ a > 255</ li > 256< li class ="tsd-kind-method tsd-parent-kind-class "> 257< a href ="parserunresultref.html#isgenerictimer "class ="tsd-kind-icon "> is< wbr > Generic< wbr > Timer</ a > 258</ li > 259< li class ="tsd-kind-method tsd-parent-kind-class "> 260< a href ="parserunresultref.html#parsedsuccessfully "class ="tsd-kind-icon "> parsed< wbr > Successfully</ a > 261</ li > 262< li class ="tsd-kind-method tsd-parent-kind-class "> 263< a href ="parserunresultref.html#timerkind "class ="tsd-kind-icon "> timer< wbr > Kind</ a > 264</ li > 265</ ul > 266</ li > 267</ ul > 268< ul class ="after-current "> 269</ ul > 270</ nav > 271</ div > 272</ div > 273</ div > 274< footer class ="with-border-bottom "> 275< div class ="container "> 276< h2 > Legend</ h2 > 277< div class ="tsd-legend-group "> 278< ul class ="tsd-legend "> 279< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 280< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 281< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 282< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 283< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 284< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 285< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 286</ ul > 287< ul class ="tsd-legend "> 288< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 289< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 290< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 291< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 292</ ul > 293< ul class ="tsd-legend "> 294< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 295< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 296< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 297< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 298< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 299< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 300</ ul > 301< ul class ="tsd-legend "> 302< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 303< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 304< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 305< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 306< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 307< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 308< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 309</ ul > 310< ul class ="tsd-legend "> 311< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 312< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 313< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 314< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 315</ ul > 316< ul class ="tsd-legend "> 317< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 318< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 319< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 320</ ul > 321< ul class ="tsd-legend "> 322< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 323< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 324< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 325</ ul > 326< ul class ="tsd-legend "> 327< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 328< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 329</ ul > 330</ div > 331</ div > 332</ footer > 333< div class ="container tsd-generator "> 334< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 335</ div > 336< div class ="overlay "></ div > 337< script src ="../assets/js/main.js "></ script > 338< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 339</ body > 340</ html >