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 > SegmentRef | 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 ="segmentref.html "> SegmentRef</ a > 60</ li > 61</ ul > 62< h1 > Class SegmentRef</ 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 Segment describes a point in a speedrun that is suitable for storing a 73 split time. This stores the name of that segment, an icon, the split times 74 of different comparisons, and a history of segment times.</ p > 75</ div > 76</ div > 77</ section > 78< section class ="tsd-panel tsd-hierarchy "> 79< h3 > Hierarchy</ h3 > 80< ul class ="tsd-hierarchy "> 81< li > 82< span class ="target "> SegmentRef</ span > 83< ul class ="tsd-hierarchy "> 84< li > 85< a href ="segmentrefmut.html "class ="tsd-signature-type "> SegmentRefMut</ a > 86</ li > 87</ ul > 88</ li > 89</ ul > 90</ section > 91< section class ="tsd-panel-group tsd-index-group "> 92< h2 > Index</ h2 > 93< section class ="tsd-panel tsd-index-panel "> 94< div class ="tsd-index-content "> 95< section class ="tsd-index-section "> 96< h3 > Constructors</ h3 > 97< ul class ="tsd-index-list "> 98< li class ="tsd-kind-constructor tsd-parent-kind-class ">< a href ="segmentref.html#constructor "class ="tsd-kind-icon "> constructor</ a ></ li > 99</ ul > 100</ section > 101< section class ="tsd-index-section "> 102< h3 > Properties</ h3 > 103< ul class ="tsd-index-list "> 104< li class ="tsd-kind-property tsd-parent-kind-class ">< a href ="segmentref.html#ptr "class ="tsd-kind-icon "> ptr</ a ></ li > 105</ ul > 106</ section > 107< section class ="tsd-index-section "> 108< h3 > Methods</ h3 > 109< ul class ="tsd-index-list "> 110< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="segmentref.html#bestsegmenttime "class ="tsd-kind-icon "> best< wbr > Segment< wbr > Time</ a ></ li > 111< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="segmentref.html#comparison "class ="tsd-kind-icon "> comparison</ a ></ li > 112< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="segmentref.html#icon "class ="tsd-kind-icon "> icon</ a ></ li > 113< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="segmentref.html#name "class ="tsd-kind-icon "> name</ a ></ li > 114< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="segmentref.html#personalbestsplittime "class ="tsd-kind-icon "> personal< wbr > Best< wbr > Split< wbr > Time</ a ></ li > 115< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="segmentref.html#segmenthistory "class ="tsd-kind-icon "> segment< wbr > History</ a ></ li > 116</ ul > 117</ section > 118</ div > 119</ section > 120</ section > 121< section class ="tsd-panel-group tsd-member-group "> 122< h2 > Constructors</ h2 > 123< section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class "> 124< a name ="constructor "class ="tsd-anchor "></ a > 125< h3 > constructor</ h3 > 126< ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class "> 127< li class ="tsd-signature tsd-kind-icon "> new< wbr > Segment< 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 ="segmentref.html "class ="tsd-signature-type "> SegmentRef</ a ></ li > 128</ ul > 129< ul class ="tsd-descriptions "> 130< li class ="tsd-description "> 131< aside class ="tsd-sources "> 132< ul > 133< li > Defined in livesplit_core.ts:5098</ li > 134</ ul > 135</ aside > 136< div class ="tsd-comment tsd-typography "> 137< div class ="lead "> 138< p > This constructor is an implementation detail. Do not use this.</ p > 139</ div > 140</ div > 141< h4 class ="tsd-parameters-title "> Parameters</ h4 > 142< ul class ="tsd-parameters "> 143< li > 144< h5 > ptr:< span class ="tsd-signature-type "> number</ span ></ h5 > 145</ li > 146</ ul > 147< h4 class ="tsd-returns-title "> Returns< a href ="segmentref.html "class ="tsd-signature-type "> SegmentRef</ a ></ h4 > 148</ li > 149</ ul > 150</ section > 151</ section > 152< section class ="tsd-panel-group tsd-member-group "> 153< h2 > Properties</ h2 > 154< section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class "> 155< a name ="ptr "class ="tsd-anchor "></ a > 156< h3 > ptr</ h3 > 157< div class ="tsd-signature tsd-kind-icon "> ptr< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> number</ span ></ div > 158< aside class ="tsd-sources "> 159< ul > 160< li > Defined in livesplit_core.ts:5033</ li > 161</ ul > 162</ aside > 163</ section > 164</ section > 165< section class ="tsd-panel-group tsd-member-group "> 166< h2 > Methods</ h2 > 167< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 168< a name ="bestsegmenttime "class ="tsd-anchor "></ a > 169< h3 > best< wbr > Segment< wbr > Time</ h3 > 170< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 171< li class ="tsd-signature tsd-kind-icon "> best< wbr > Segment< wbr > Time< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="timeref.html "class ="tsd-signature-type "> TimeRef</ a ></ li > 172</ ul > 173< ul class ="tsd-descriptions "> 174< li class ="tsd-description "> 175< aside class ="tsd-sources "> 176< ul > 177< li > Defined in livesplit_core.ts:5082</ li > 178</ ul > 179</ aside > 180< div class ="tsd-comment tsd-typography "> 181< div class ="lead "> 182< p > Accesses the Best Segment Time.</ p > 183</ div > 184</ div > 185< h4 class ="tsd-returns-title "> Returns< a href ="timeref.html "class ="tsd-signature-type "> TimeRef</ a ></ h4 > 186</ li > 187</ ul > 188</ section > 189< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 190< a name ="comparison "class ="tsd-anchor "></ a > 191< h3 > comparison</ h3 > 192< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 193< li class ="tsd-signature tsd-kind-icon "> comparison< span class ="tsd-signature-symbol "> (</ span > comparison< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> string</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="timeref.html "class ="tsd-signature-type "> TimeRef</ a ></ li > 194</ ul > 195< ul class ="tsd-descriptions "> 196< li class ="tsd-description "> 197< aside class ="tsd-sources "> 198< ul > 199< li > Defined in livesplit_core.ts:5061</ li > 200</ ul > 201</ aside > 202< div class ="tsd-comment tsd-typography "> 203< div class ="lead "> 204< p > Accesses the specified comparison's time. If there's none for this 205 comparison, an empty time is being returned (but not stored in the 206 segment).</ p > 207</ div > 208</ div > 209< h4 class ="tsd-parameters-title "> Parameters</ h4 > 210< ul class ="tsd-parameters "> 211< li > 212< h5 > comparison:< span class ="tsd-signature-type "> string</ span ></ h5 > 213</ li > 214</ ul > 215< h4 class ="tsd-returns-title "> Returns< a href ="timeref.html "class ="tsd-signature-type "> TimeRef</ a ></ h4 > 216</ li > 217</ ul > 218</ section > 219< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 220< a name ="icon "class ="tsd-anchor "></ a > 221< h3 > icon</ h3 > 222< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 223< li class ="tsd-signature tsd-kind-icon "> 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 > 224</ ul > 225< ul class ="tsd-descriptions "> 226< li class ="tsd-description "> 227< aside class ="tsd-sources "> 228< ul > 229< li > Defined in livesplit_core.ts:5049</ li > 230</ ul > 231</ aside > 232< div class ="tsd-comment tsd-typography "> 233< div class ="lead "> 234< p > Accesses the icon of the segment encoded as a Data URL storing the image's 235 data. If the image's data is empty, this returns an empty string instead of 236 a URL.</ p > 237</ div > 238</ div > 239< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 240</ li > 241</ ul > 242</ section > 243< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 244< a name ="name "class ="tsd-anchor "></ a > 245< h3 > name</ h3 > 246< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 247< li class ="tsd-signature tsd-kind-icon "> 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 > 248</ ul > 249< ul class ="tsd-descriptions "> 250< li class ="tsd-description "> 251< aside class ="tsd-sources "> 252< ul > 253< li > Defined in livesplit_core.ts:5037</ li > 254</ ul > 255</ aside > 256< div class ="tsd-comment tsd-typography "> 257< div class ="lead "> 258< p > Accesses the name of the segment.</ p > 259</ div > 260</ div > 261< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 262</ li > 263</ ul > 264</ section > 265< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 266< a name ="personalbestsplittime "class ="tsd-anchor "></ a > 267< h3 > personal< wbr > Best< wbr > Split< wbr > Time</ h3 > 268< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 269< li class ="tsd-signature tsd-kind-icon "> personal< wbr > Best< wbr > Split< wbr > Time< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="timeref.html "class ="tsd-signature-type "> TimeRef</ a ></ li > 270</ ul > 271< ul class ="tsd-descriptions "> 272< li class ="tsd-description "> 273< aside class ="tsd-sources "> 274< ul > 275< li > Defined in livesplit_core.ts:5072</ li > 276</ ul > 277</ aside > 278< div class ="tsd-comment tsd-typography "> 279< div class ="lead "> 280< p > Accesses the split time of the Personal Best for this segment. If it 281 doesn't exist, an empty time is returned.</ p > 282</ div > 283</ div > 284< h4 class ="tsd-returns-title "> Returns< a href ="timeref.html "class ="tsd-signature-type "> TimeRef</ a ></ h4 > 285</ li > 286</ ul > 287</ section > 288< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 289< a name ="segmenthistory "class ="tsd-anchor "></ a > 290< h3 > segment< wbr > History</ h3 > 291< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 292< li class ="tsd-signature tsd-kind-icon "> segment< wbr > History< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< a href ="segmenthistoryref.html "class ="tsd-signature-type "> SegmentHistoryRef</ a ></ li > 293</ ul > 294< ul class ="tsd-descriptions "> 295< li class ="tsd-description "> 296< aside class ="tsd-sources "> 297< ul > 298< li > Defined in livesplit_core.ts:5092</ li > 299</ ul > 300</ aside > 301< div class ="tsd-comment tsd-typography "> 302< div class ="lead "> 303< p > Accesses the Segment History of this segment.</ p > 304</ div > 305</ div > 306< h4 class ="tsd-returns-title "> Returns< a href ="segmenthistoryref.html "class ="tsd-signature-type "> SegmentHistoryRef</ a ></ h4 > 307</ li > 308</ ul > 309</ section > 310</ section > 311</ div > 312< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 313< nav class ="tsd-navigation primary "> 314< ul > 315< li class ="globals "> 316< a href ="../globals.html ">< em > Globals</ em ></ a > 317</ li > 318</ ul > 319</ nav > 320< nav class ="tsd-navigation secondary menu-sticky "> 321< ul class ="before-current "> 322</ ul > 323< ul class ="current "> 324< li class ="current tsd-kind-class "> 325< a href ="segmentref.html "class ="tsd-kind-icon "> Segment< wbr > Ref</ a > 326< ul > 327< li class ="tsd-kind-constructor tsd-parent-kind-class "> 328< a href ="segmentref.html#constructor "class ="tsd-kind-icon "> constructor</ a > 329</ li > 330< li class ="tsd-kind-property tsd-parent-kind-class "> 331< a href ="segmentref.html#ptr "class ="tsd-kind-icon "> ptr</ a > 332</ li > 333< li class ="tsd-kind-method tsd-parent-kind-class "> 334< a href ="segmentref.html#bestsegmenttime "class ="tsd-kind-icon "> best< wbr > Segment< wbr > Time</ a > 335</ li > 336< li class ="tsd-kind-method tsd-parent-kind-class "> 337< a href ="segmentref.html#comparison "class ="tsd-kind-icon "> comparison</ a > 338</ li > 339< li class ="tsd-kind-method tsd-parent-kind-class "> 340< a href ="segmentref.html#icon "class ="tsd-kind-icon "> icon</ a > 341</ li > 342< li class ="tsd-kind-method tsd-parent-kind-class "> 343< a href ="segmentref.html#name "class ="tsd-kind-icon "> name</ a > 344</ li > 345< li class ="tsd-kind-method tsd-parent-kind-class "> 346< a href ="segmentref.html#personalbestsplittime "class ="tsd-kind-icon "> personal< wbr > Best< wbr > Split< wbr > Time</ a > 347</ li > 348< li class ="tsd-kind-method tsd-parent-kind-class "> 349< a href ="segmentref.html#segmenthistory "class ="tsd-kind-icon "> segment< wbr > History</ a > 350</ li > 351</ ul > 352</ li > 353</ ul > 354< ul class ="after-current "> 355</ ul > 356</ nav > 357</ div > 358</ div > 359</ div > 360< footer class ="with-border-bottom "> 361< div class ="container "> 362< h2 > Legend</ h2 > 363< div class ="tsd-legend-group "> 364< ul class ="tsd-legend "> 365< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 366< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 367< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 368< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 369< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 370< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 371< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 372</ ul > 373< ul class ="tsd-legend "> 374< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 375< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 376< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 377< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 378</ ul > 379< ul class ="tsd-legend "> 380< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 381< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 382< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 383< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 384< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 385< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 386</ ul > 387< ul class ="tsd-legend "> 388< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 389< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 390< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 391< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 392< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 393< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 394< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 395</ ul > 396< ul class ="tsd-legend "> 397< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 398< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 399< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 400< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 401</ ul > 402< ul class ="tsd-legend "> 403< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 404< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 405< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 406</ ul > 407< ul class ="tsd-legend "> 408< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 409< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 410< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 411</ ul > 412< ul class ="tsd-legend "> 413< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 414< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 415</ ul > 416</ div > 417</ div > 418</ footer > 419< div class ="container tsd-generator "> 420< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 421</ div > 422< div class ="overlay "></ div > 423< script src ="../assets/js/main.js "></ script > 424< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 425</ body > 426</ html >