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