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