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 > TimeRefMut | 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 ="timerefmut.html "> TimeRefMut</ a > 60</ li > 61</ ul > 62< h1 > Class TimeRefMut</ 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< a href ="timeref.html "class ="tsd-signature-type "> TimeRef</ a > 82< ul class ="tsd-hierarchy "> 83< li > 84< span class ="target "> TimeRefMut</ span > 85< ul class ="tsd-hierarchy "> 86< li > 87< a href ="time.html "class ="tsd-signature-type "> Time</ a > 88</ li > 89</ ul > 90</ li > 91</ ul > 92</ li > 93</ ul > 94</ section > 95< section class ="tsd-panel-group tsd-index-group "> 96< h2 > Index</ h2 > 97< section class ="tsd-panel tsd-index-panel "> 98< div class ="tsd-index-content "> 99< section class ="tsd-index-section tsd-is-inherited "> 100< h3 > Constructors</ h3 > 101< ul class ="tsd-index-list "> 102< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< a href ="timerefmut.html#constructor "class ="tsd-kind-icon "> constructor</ a ></ li > 103</ ul > 104</ section > 105< section class ="tsd-index-section tsd-is-inherited "> 106< h3 > Properties</ h3 > 107< ul class ="tsd-index-list "> 108< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< a href ="timerefmut.html#ptr "class ="tsd-kind-icon "> ptr</ a ></ li > 109</ ul > 110</ section > 111< section class ="tsd-index-section tsd-is-inherited "> 112< h3 > Methods</ h3 > 113< ul class ="tsd-index-list "> 114< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="timerefmut.html#clone "class ="tsd-kind-icon "> clone</ a ></ li > 115< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="timerefmut.html#gametime "class ="tsd-kind-icon "> game< wbr > Time</ a ></ li > 116< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="timerefmut.html#index "class ="tsd-kind-icon "> index</ a ></ li > 117< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="timerefmut.html#realtime "class ="tsd-kind-icon "> real< wbr > Time</ a ></ li > 118</ ul > 119</ section > 120</ div > 121</ section > 122</ section > 123< section class ="tsd-panel-group tsd-member-group tsd-is-inherited "> 124< h2 > Constructors</ h2 > 125< section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited "> 126< a name ="constructor "class ="tsd-anchor "></ a > 127< h3 > constructor</ h3 > 128< ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited "> 129< li class ="tsd-signature tsd-kind-icon "> new< wbr > Time< wbr > Ref< wbr > Mut< 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 ="timerefmut.html "class ="tsd-signature-type "> TimeRefMut</ a ></ li > 130</ ul > 131< ul class ="tsd-descriptions "> 132< li class ="tsd-description "> 133< aside class ="tsd-sources "> 134< p > Inherited from< a href ="timeref.html "> TimeRef</ a > .< a href ="timeref.html#constructor "> constructor</ a ></ p > 135< ul > 136< li > Defined in livesplit_core.ts:6625</ li > 137</ ul > 138</ aside > 139< div class ="tsd-comment tsd-typography "> 140< div class ="lead "> 141< p > This constructor is an implementation detail. Do not use this.</ p > 142</ div > 143</ div > 144< h4 class ="tsd-parameters-title "> Parameters</ h4 > 145< ul class ="tsd-parameters "> 146< li > 147< h5 > ptr:< span class ="tsd-signature-type "> number</ span ></ h5 > 148</ li > 149</ ul > 150< h4 class ="tsd-returns-title "> Returns< a href ="timerefmut.html "class ="tsd-signature-type "> TimeRefMut</ a ></ h4 > 151</ li > 152</ ul > 153</ section > 154</ section > 155< section class ="tsd-panel-group tsd-member-group tsd-is-inherited "> 156< h2 > Properties</ h2 > 157< section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited "> 158< a name ="ptr "class ="tsd-anchor "></ a > 159< h3 > ptr</ h3 > 160< div class ="tsd-signature tsd-kind-icon "> ptr< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> number</ span ></ div > 161< aside class ="tsd-sources "> 162< p > Inherited from< a href ="timeref.html "> TimeRef</ a > .< a href ="timeref.html#ptr "> ptr</ a ></ p > 163< ul > 164< li > Defined in livesplit_core.ts:6576</ li > 165</ ul > 166</ aside > 167</ section > 168</ section > 169< section class ="tsd-panel-group tsd-member-group tsd-is-inherited "> 170< h2 > Methods</ h2 > 171< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 172< a name ="clone "class ="tsd-anchor "></ a > 173< h3 > clone</ h3 > 174< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 175< 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 > 176</ ul > 177< ul class ="tsd-descriptions "> 178< li class ="tsd-description "> 179< aside class ="tsd-sources "> 180< p > Inherited from< a href ="timeref.html "> TimeRef</ a > .< a href ="timeref.html#clone "> clone</ a ></ p > 181< ul > 182< li > Defined in livesplit_core.ts:6580</ li > 183</ ul > 184</ aside > 185< div class ="tsd-comment tsd-typography "> 186< div class ="lead "> 187< p > Clones the time.</ p > 188</ div > 189</ div > 190< h4 class ="tsd-returns-title "> Returns< a href ="time.html "class ="tsd-signature-type "> Time</ a ></ h4 > 191</ li > 192</ ul > 193</ section > 194< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 195< a name ="gametime "class ="tsd-anchor "></ a > 196< h3 > game< wbr > Time</ h3 > 197< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 198< 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 > 199</ ul > 200< ul class ="tsd-descriptions "> 201< li class ="tsd-description "> 202< aside class ="tsd-sources "> 203< p > Inherited from< a href ="timeref.html "> TimeRef</ a > .< a href ="timeref.html#gametime "> gameTime</ a ></ p > 204< ul > 205< li > Defined in livesplit_core.ts:6603</ li > 206</ ul > 207</ aside > 208< div class ="tsd-comment tsd-typography "> 209< div class ="lead "> 210< p > The Game Time value. This may be null if this time has no Game Time value.</ p > 211</ div > 212</ div > 213< h4 class ="tsd-returns-title "> Returns< a href ="timespanref.html "class ="tsd-signature-type "> TimeSpanRef</ a > 214< span class ="tsd-signature-symbol "> |</ span > 215< span class ="tsd-signature-type "> null</ span > 216</ h4 > 217</ li > 218</ ul > 219</ section > 220< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 221< a name ="index "class ="tsd-anchor "></ a > 222< h3 > index</ h3 > 223< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 224< 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 > 225</ ul > 226< ul class ="tsd-descriptions "> 227< li class ="tsd-description "> 228< aside class ="tsd-sources "> 229< p > Inherited from< a href ="timeref.html "> TimeRef</ a > .< a href ="timeref.html#index "> index</ a ></ p > 230< ul > 231< li > Defined in livesplit_core.ts:6616</ li > 232</ ul > 233</ aside > 234< div class ="tsd-comment tsd-typography "> 235< div class ="lead "> 236< p > Access the time's value for the timing method specified.</ p > 237</ div > 238</ div > 239< h4 class ="tsd-parameters-title "> Parameters</ h4 > 240< ul class ="tsd-parameters "> 241< li > 242< h5 > timingMethod:< span class ="tsd-signature-type "> number</ span ></ h5 > 243</ li > 244</ ul > 245< h4 class ="tsd-returns-title "> Returns< a href ="timespanref.html "class ="tsd-signature-type "> TimeSpanRef</ a > 246< span class ="tsd-signature-symbol "> |</ span > 247< span class ="tsd-signature-type "> null</ span > 248</ h4 > 249</ li > 250</ ul > 251</ section > 252< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 253< a name ="realtime "class ="tsd-anchor "></ a > 254< h3 > real< wbr > Time</ h3 > 255< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 256< 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 > 257</ ul > 258< ul class ="tsd-descriptions "> 259< li class ="tsd-description "> 260< aside class ="tsd-sources "> 261< p > Inherited from< a href ="timeref.html "> TimeRef</ a > .< a href ="timeref.html#realtime "> realTime</ a ></ p > 262< ul > 263< li > Defined in livesplit_core.ts:6590</ li > 264</ ul > 265</ aside > 266< div class ="tsd-comment tsd-typography "> 267< div class ="lead "> 268< p > The Real Time value. This may be null if this time has no Real Time value.</ p > 269</ div > 270</ div > 271< h4 class ="tsd-returns-title "> Returns< a href ="timespanref.html "class ="tsd-signature-type "> TimeSpanRef</ a > 272< span class ="tsd-signature-symbol "> |</ span > 273< span class ="tsd-signature-type "> null</ span > 274</ h4 > 275</ li > 276</ ul > 277</ section > 278</ section > 279</ div > 280< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 281< nav class ="tsd-navigation primary "> 282< ul > 283< li class ="globals "> 284< a href ="../globals.html ">< em > Globals</ em ></ a > 285</ li > 286</ ul > 287</ nav > 288< nav class ="tsd-navigation secondary menu-sticky "> 289< ul class ="before-current "> 290</ ul > 291< ul class ="current "> 292< li class ="current tsd-kind-class "> 293< a href ="timerefmut.html "class ="tsd-kind-icon "> Time< wbr > Ref< wbr > Mut</ a > 294< ul > 295< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited "> 296< a href ="timerefmut.html#constructor "class ="tsd-kind-icon "> constructor</ a > 297</ li > 298< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited "> 299< a href ="timerefmut.html#ptr "class ="tsd-kind-icon "> ptr</ a > 300</ li > 301< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 302< a href ="timerefmut.html#clone "class ="tsd-kind-icon "> clone</ a > 303</ li > 304< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 305< a href ="timerefmut.html#gametime "class ="tsd-kind-icon "> game< wbr > Time</ a > 306</ li > 307< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 308< a href ="timerefmut.html#index "class ="tsd-kind-icon "> index</ a > 309</ li > 310< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 311< a href ="timerefmut.html#realtime "class ="tsd-kind-icon "> real< wbr > Time</ a > 312</ li > 313</ ul > 314</ li > 315</ ul > 316< ul class ="after-current "> 317</ ul > 318</ nav > 319</ div > 320</ div > 321</ div > 322< footer class ="with-border-bottom "> 323< div class ="container "> 324< h2 > Legend</ h2 > 325< div class ="tsd-legend-group "> 326< ul class ="tsd-legend "> 327< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 328< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 329< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 330< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 331< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 332< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 333< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 334</ ul > 335< ul class ="tsd-legend "> 336< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 337< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 338< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 339< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 340</ ul > 341< ul class ="tsd-legend "> 342< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 343< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 344< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 345< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 346< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 347< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 348</ ul > 349< ul class ="tsd-legend "> 350< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 351< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 352< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 353< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 354< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 355< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 356< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 357</ ul > 358< ul class ="tsd-legend "> 359< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 360< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 361< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 362< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 363</ ul > 364< ul class ="tsd-legend "> 365< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 366< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 367< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 368</ ul > 369< ul class ="tsd-legend "> 370< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 371< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 372< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 373</ ul > 374< ul class ="tsd-legend "> 375< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 376< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 377</ ul > 378</ div > 379</ div > 380</ footer > 381< div class ="container tsd-generator "> 382< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 383</ div > 384< div class ="overlay "></ div > 385< script src ="../assets/js/main.js "></ script > 386< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 387</ body > 388</ html >