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 > TimeRef | 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 ="timeref.html "> TimeRef</ a > 60</ li > 61</ ul > 62< h1 > Class TimeRef</ 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 time that can store a Real Time and a Game Time. Both of them are 73 optional.</ 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 "> TimeRef</ span > 82< ul class ="tsd-hierarchy "> 83< li > 84< a href ="timerefmut.html "class ="tsd-signature-type "> TimeRefMut</ 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 ="timeref.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 ="timeref.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 ="timeref.html#clone "class ="tsd-kind-icon "> clone</ a ></ li > 110< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="timeref.html#gametime "class ="tsd-kind-icon "> game< wbr > Time</ a ></ li > 111< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="timeref.html#index "class ="tsd-kind-icon "> index</ a ></ li > 112< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="timeref.html#realtime "class ="tsd-kind-icon "> real< wbr > 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 > Time< 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 ="timeref.html "class ="tsd-signature-type "> TimeRef</ 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:6625</ 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 ="timeref.html "class ="tsd-signature-type "> TimeRef</ 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:6576</ 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 ="clone "class ="tsd-anchor "></ a > 166< h3 > clone</ h3 > 167< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 168< 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 ="time.html "class ="tsd-signature-type "> Time</ a ></ 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:6580</ li > 175</ ul > 176</ aside > 177< div class ="tsd-comment tsd-typography "> 178< div class ="lead "> 179< p > Clones the time.</ p > 180</ div > 181</ div > 182< h4 class ="tsd-returns-title "> Returns< a href ="time.html "class ="tsd-signature-type "> Time</ a ></ h4 > 183</ li > 184</ ul > 185</ section > 186< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 187< a name ="gametime "class ="tsd-anchor "></ a > 188< h3 > game< wbr > Time</ h3 > 189< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 190< li class ="tsd-signature tsd-kind-icon "> game< wbr > Time< 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 >< span class ="tsd-signature-symbol "> |</ span >< span class ="tsd-signature-type "> null</ span ></ 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:6603</ li > 197</ ul > 198</ aside > 199< div class ="tsd-comment tsd-typography "> 200< div class ="lead "> 201< p > The Game Time value. This may be null if this time has no Game Time value.</ p > 202</ div > 203</ div > 204< h4 class ="tsd-returns-title "> Returns< a href ="timespanref.html "class ="tsd-signature-type "> TimeSpanRef</ a > 205< span class ="tsd-signature-symbol "> |</ span > 206< span class ="tsd-signature-type "> null</ span > 207</ h4 > 208</ li > 209</ ul > 210</ section > 211< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 212< a name ="index "class ="tsd-anchor "></ a > 213< h3 > index</ h3 > 214< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 215< li class ="tsd-signature tsd-kind-icon "> index< span class ="tsd-signature-symbol "> (</ span > timingMethod< 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 ="timespanref.html "class ="tsd-signature-type "> TimeSpanRef</ a >< span class ="tsd-signature-symbol "> |</ span >< span class ="tsd-signature-type "> null</ span ></ li > 216</ ul > 217< ul class ="tsd-descriptions "> 218< li class ="tsd-description "> 219< aside class ="tsd-sources "> 220< ul > 221< li > Defined in livesplit_core.ts:6616</ li > 222</ ul > 223</ aside > 224< div class ="tsd-comment tsd-typography "> 225< div class ="lead "> 226< p > Access the time's value for the timing method specified.</ p > 227</ div > 228</ div > 229< h4 class ="tsd-parameters-title "> Parameters</ h4 > 230< ul class ="tsd-parameters "> 231< li > 232< h5 > timingMethod:< span class ="tsd-signature-type "> number</ span ></ h5 > 233</ li > 234</ ul > 235< h4 class ="tsd-returns-title "> Returns< a href ="timespanref.html "class ="tsd-signature-type "> TimeSpanRef</ a > 236< span class ="tsd-signature-symbol "> |</ span > 237< span class ="tsd-signature-type "> null</ span > 238</ h4 > 239</ li > 240</ ul > 241</ section > 242< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 243< a name ="realtime "class ="tsd-anchor "></ a > 244< h3 > real< wbr > Time</ h3 > 245< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 246< li class ="tsd-signature tsd-kind-icon "> real< wbr > Time< 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 >< span class ="tsd-signature-symbol "> |</ span >< span class ="tsd-signature-type "> null</ span ></ li > 247</ ul > 248< ul class ="tsd-descriptions "> 249< li class ="tsd-description "> 250< aside class ="tsd-sources "> 251< ul > 252< li > Defined in livesplit_core.ts:6590</ li > 253</ ul > 254</ aside > 255< div class ="tsd-comment tsd-typography "> 256< div class ="lead "> 257< p > The Real Time value. This may be null if this time has no Real Time value.</ p > 258</ div > 259</ div > 260< h4 class ="tsd-returns-title "> Returns< a href ="timespanref.html "class ="tsd-signature-type "> TimeSpanRef</ a > 261< span class ="tsd-signature-symbol "> |</ span > 262< span class ="tsd-signature-type "> null</ span > 263</ h4 > 264</ li > 265</ ul > 266</ section > 267</ section > 268</ div > 269< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 270< nav class ="tsd-navigation primary "> 271< ul > 272< li class ="globals "> 273< a href ="../globals.html ">< em > Globals</ em ></ a > 274</ li > 275</ ul > 276</ nav > 277< nav class ="tsd-navigation secondary menu-sticky "> 278< ul class ="before-current "> 279</ ul > 280< ul class ="current "> 281< li class ="current tsd-kind-class "> 282< a href ="timeref.html "class ="tsd-kind-icon "> Time< wbr > Ref</ a > 283< ul > 284< li class ="tsd-kind-constructor tsd-parent-kind-class "> 285< a href ="timeref.html#constructor "class ="tsd-kind-icon "> constructor</ a > 286</ li > 287< li class ="tsd-kind-property tsd-parent-kind-class "> 288< a href ="timeref.html#ptr "class ="tsd-kind-icon "> ptr</ a > 289</ li > 290< li class ="tsd-kind-method tsd-parent-kind-class "> 291< a href ="timeref.html#clone "class ="tsd-kind-icon "> clone</ a > 292</ li > 293< li class ="tsd-kind-method tsd-parent-kind-class "> 294< a href ="timeref.html#gametime "class ="tsd-kind-icon "> game< wbr > Time</ a > 295</ li > 296< li class ="tsd-kind-method tsd-parent-kind-class "> 297< a href ="timeref.html#index "class ="tsd-kind-icon "> index</ a > 298</ li > 299< li class ="tsd-kind-method tsd-parent-kind-class "> 300< a href ="timeref.html#realtime "class ="tsd-kind-icon "> real< wbr > Time</ a > 301</ li > 302</ ul > 303</ li > 304</ ul > 305< ul class ="after-current "> 306</ ul > 307</ nav > 308</ div > 309</ div > 310</ div > 311< footer class ="with-border-bottom "> 312< div class ="container "> 313< h2 > Legend</ h2 > 314< div class ="tsd-legend-group "> 315< ul class ="tsd-legend "> 316< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 317< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 318< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 319< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 320< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 321< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 322< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 323</ ul > 324< ul class ="tsd-legend "> 325< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 326< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 327< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 328< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 329</ ul > 330< ul class ="tsd-legend "> 331< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 332< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 333< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 334< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 335< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 336< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 337</ ul > 338< ul class ="tsd-legend "> 339< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 340< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 341< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 342< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 343< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 344< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 345< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 346</ ul > 347< ul class ="tsd-legend "> 348< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 349< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 350< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 351< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 352</ ul > 353< ul class ="tsd-legend "> 354< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 355< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 356< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 357</ ul > 358< ul class ="tsd-legend "> 359< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 360< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 361< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 362</ ul > 363< ul class ="tsd-legend "> 364< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 365< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 366</ ul > 367</ div > 368</ div > 369</ footer > 370< div class ="container tsd-generator "> 371< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 372</ div > 373< div class ="overlay "></ div > 374< script src ="../assets/js/main.js "></ script > 375< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 376</ body > 377</ html >