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 > SegmentHistoryElementRef | 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 ="segmenthistoryelementref.html "> SegmentHistoryElementRef</ a > 60</ li > 61</ ul > 62< h1 > Class SegmentHistoryElementRef</ 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 time achieved for a segment. It is tagged with an index. Only 73 segment times with an index larger than 0 are considered times actually 74 achieved by the runner, while the others are artifacts of route changes and 75 similar algorithmic changes.</ p > 76</ div > 77</ div > 78</ section > 79< section class ="tsd-panel tsd-hierarchy "> 80< h3 > Hierarchy</ h3 > 81< ul class ="tsd-hierarchy "> 82< li > 83< span class ="target "> SegmentHistoryElementRef</ span > 84< ul class ="tsd-hierarchy "> 85< li > 86< a href ="segmenthistoryelementrefmut.html "class ="tsd-signature-type "> SegmentHistoryElementRefMut</ a > 87</ li > 88</ ul > 89</ li > 90</ ul > 91</ section > 92< section class ="tsd-panel-group tsd-index-group "> 93< h2 > Index</ h2 > 94< section class ="tsd-panel tsd-index-panel "> 95< div class ="tsd-index-content "> 96< section class ="tsd-index-section "> 97< h3 > Constructors</ h3 > 98< ul class ="tsd-index-list "> 99< li class ="tsd-kind-constructor tsd-parent-kind-class ">< a href ="segmenthistoryelementref.html#constructor "class ="tsd-kind-icon "> constructor</ a ></ li > 100</ ul > 101</ section > 102< section class ="tsd-index-section "> 103< h3 > Properties</ h3 > 104< ul class ="tsd-index-list "> 105< li class ="tsd-kind-property tsd-parent-kind-class ">< a href ="segmenthistoryelementref.html#ptr "class ="tsd-kind-icon "> ptr</ a ></ li > 106</ ul > 107</ section > 108< section class ="tsd-index-section "> 109< h3 > Methods</ h3 > 110< ul class ="tsd-index-list "> 111< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="segmenthistoryelementref.html#index "class ="tsd-kind-icon "> index</ a ></ li > 112< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="segmenthistoryelementref.html#time "class ="tsd-kind-icon "> time</ a ></ li > 113</ ul > 114</ section > 115</ div > 116</ section > 117</ section > 118< section class ="tsd-panel-group tsd-member-group "> 119< h2 > Constructors</ h2 > 120< section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class "> 121< a name ="constructor "class ="tsd-anchor "></ a > 122< h3 > constructor</ h3 > 123< ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class "> 124< li class ="tsd-signature tsd-kind-icon "> new< wbr > Segment< wbr > History< wbr > Element< 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 ="segmenthistoryelementref.html "class ="tsd-signature-type "> SegmentHistoryElementRef</ a ></ li > 125</ ul > 126< ul class ="tsd-descriptions "> 127< li class ="tsd-description "> 128< aside class ="tsd-sources "> 129< ul > 130< li > Defined in livesplit_core.ts:5248</ li > 131</ ul > 132</ aside > 133< div class ="tsd-comment tsd-typography "> 134< div class ="lead "> 135< p > This constructor is an implementation detail. Do not use this.</ p > 136</ div > 137</ div > 138< h4 class ="tsd-parameters-title "> Parameters</ h4 > 139< ul class ="tsd-parameters "> 140< li > 141< h5 > ptr:< span class ="tsd-signature-type "> number</ span ></ h5 > 142</ li > 143</ ul > 144< h4 class ="tsd-returns-title "> Returns< a href ="segmenthistoryelementref.html "class ="tsd-signature-type "> SegmentHistoryElementRef</ a ></ h4 > 145</ li > 146</ ul > 147</ section > 148</ section > 149< section class ="tsd-panel-group tsd-member-group "> 150< h2 > Properties</ h2 > 151< section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class "> 152< a name ="ptr "class ="tsd-anchor "></ a > 153< h3 > ptr</ h3 > 154< div class ="tsd-signature tsd-kind-icon "> ptr< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> number</ span ></ div > 155< aside class ="tsd-sources "> 156< ul > 157< li > Defined in livesplit_core.ts:5228</ li > 158</ ul > 159</ aside > 160</ section > 161</ section > 162< section class ="tsd-panel-group tsd-member-group "> 163< h2 > Methods</ h2 > 164< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 165< a name ="index "class ="tsd-anchor "></ a > 166< h3 > index</ h3 > 167< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 168< li class ="tsd-signature tsd-kind-icon "> index< 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 > 169</ ul > 170< ul class ="tsd-descriptions "> 171< li class ="tsd-description "> 172< aside class ="tsd-sources "> 173< ul > 174< li > Defined in livesplit_core.ts:5232</ li > 175</ ul > 176</ aside > 177< div class ="tsd-comment tsd-typography "> 178< div class ="lead "> 179< p > Accesses the index of the segment history element.</ p > 180</ div > 181</ div > 182< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> number</ span ></ h4 > 183</ li > 184</ ul > 185</ section > 186< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 187< a name ="time "class ="tsd-anchor "></ a > 188< h3 > time</ h3 > 189< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 190< li class ="tsd-signature tsd-kind-icon "> 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 > 191</ ul > 192< ul class ="tsd-descriptions "> 193< li class ="tsd-description "> 194< aside class ="tsd-sources "> 195< ul > 196< li > Defined in livesplit_core.ts:5242</ li > 197</ ul > 198</ aside > 199< div class ="tsd-comment tsd-typography "> 200< div class ="lead "> 201< p > Accesses the segment time of the segment history element.</ p > 202</ div > 203</ div > 204< h4 class ="tsd-returns-title "> Returns< a href ="timeref.html "class ="tsd-signature-type "> TimeRef</ a ></ h4 > 205</ li > 206</ ul > 207</ section > 208</ section > 209</ div > 210< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 211< nav class ="tsd-navigation primary "> 212< ul > 213< li class ="globals "> 214< a href ="../globals.html ">< em > Globals</ em ></ a > 215</ li > 216</ ul > 217</ nav > 218< nav class ="tsd-navigation secondary menu-sticky "> 219< ul class ="before-current "> 220</ ul > 221< ul class ="current "> 222< li class ="current tsd-kind-class "> 223< a href ="segmenthistoryelementref.html "class ="tsd-kind-icon "> Segment< wbr > History< wbr > Element< wbr > Ref</ a > 224< ul > 225< li class ="tsd-kind-constructor tsd-parent-kind-class "> 226< a href ="segmenthistoryelementref.html#constructor "class ="tsd-kind-icon "> constructor</ a > 227</ li > 228< li class ="tsd-kind-property tsd-parent-kind-class "> 229< a href ="segmenthistoryelementref.html#ptr "class ="tsd-kind-icon "> ptr</ a > 230</ li > 231< li class ="tsd-kind-method tsd-parent-kind-class "> 232< a href ="segmenthistoryelementref.html#index "class ="tsd-kind-icon "> index</ a > 233</ li > 234< li class ="tsd-kind-method tsd-parent-kind-class "> 235< a href ="segmenthistoryelementref.html#time "class ="tsd-kind-icon "> time</ a > 236</ li > 237</ ul > 238</ li > 239</ ul > 240< ul class ="after-current "> 241</ ul > 242</ nav > 243</ div > 244</ div > 245</ div > 246< footer class ="with-border-bottom "> 247< div class ="container "> 248< h2 > Legend</ h2 > 249< div class ="tsd-legend-group "> 250< ul class ="tsd-legend "> 251< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 252< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 253< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 254< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 255< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 256< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 257< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 258</ ul > 259< ul class ="tsd-legend "> 260< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 261< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 262< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 263< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 264</ ul > 265< ul class ="tsd-legend "> 266< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 267< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 268< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 269< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 270< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 271< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 272</ ul > 273< ul class ="tsd-legend "> 274< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 275< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 276< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 277< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 278< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 279< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 280< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 281</ ul > 282< ul class ="tsd-legend "> 283< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 284< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 285< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 286< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 287</ ul > 288< ul class ="tsd-legend "> 289< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 290< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 291< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 292</ ul > 293< ul class ="tsd-legend "> 294< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 295< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 296< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 297</ ul > 298< ul class ="tsd-legend "> 299< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 300< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 301</ ul > 302</ div > 303</ div > 304</ footer > 305< div class ="container tsd-generator "> 306< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 307</ div > 308< div class ="overlay "></ div > 309< script src ="../assets/js/main.js "></ script > 310< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 311</ body > 312</ html >