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 > CurrentComparisonComponentStateRefMut | 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 ="currentcomparisoncomponentstaterefmut.html "> CurrentComparisonComponentStateRefMut</ a > 60</ li > 61</ ul > 62< h1 > Class CurrentComparisonComponentStateRefMut</ 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 ="currentcomparisoncomponentstateref.html "class ="tsd-signature-type "> CurrentComparisonComponentStateRef</ a > 81< ul class ="tsd-hierarchy "> 82< li > 83< span class ="target "> CurrentComparisonComponentStateRefMut</ span > 84< ul class ="tsd-hierarchy "> 85< li > 86< a href ="currentcomparisoncomponentstate.html "class ="tsd-signature-type "> CurrentComparisonComponentState</ 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 ="currentcomparisoncomponentstaterefmut.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 ="currentcomparisoncomponentstaterefmut.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 ="currentcomparisoncomponentstaterefmut.html#comparison "class ="tsd-kind-icon "> comparison</ a ></ li > 114< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< a href ="currentcomparisoncomponentstaterefmut.html#text "class ="tsd-kind-icon "> text</ a ></ li > 115</ ul > 116</ section > 117</ div > 118</ section > 119</ section > 120< section class ="tsd-panel-group tsd-member-group tsd-is-inherited "> 121< h2 > Constructors</ h2 > 122< section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited "> 123< a name ="constructor "class ="tsd-anchor "></ a > 124< h3 > constructor</ h3 > 125< ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited "> 126< li class ="tsd-signature tsd-kind-icon "> new< wbr > Current< wbr > Comparison< 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 ="currentcomparisoncomponentstaterefmut.html "class ="tsd-signature-type "> CurrentComparisonComponentStateRefMut</ a ></ li > 127</ ul > 128< ul class ="tsd-descriptions "> 129< li class ="tsd-description "> 130< aside class ="tsd-sources "> 131< p > Inherited from< a href ="currentcomparisoncomponentstateref.html "> CurrentComparisonComponentStateRef</ a > .< a href ="currentcomparisoncomponentstateref.html#constructor "> constructor</ a ></ p > 132< ul > 133< li > Defined in livesplit_core.ts:1771</ li > 134</ ul > 135</ aside > 136< div class ="tsd-comment tsd-typography "> 137< div class ="lead "> 138< p > This constructor is an implementation detail. Do not use this.</ p > 139</ div > 140</ div > 141< h4 class ="tsd-parameters-title "> Parameters</ h4 > 142< ul class ="tsd-parameters "> 143< li > 144< h5 > ptr:< span class ="tsd-signature-type "> number</ span ></ h5 > 145</ li > 146</ ul > 147< h4 class ="tsd-returns-title "> Returns< a href ="currentcomparisoncomponentstaterefmut.html "class ="tsd-signature-type "> CurrentComparisonComponentStateRefMut</ a ></ h4 > 148</ li > 149</ ul > 150</ section > 151</ section > 152< section class ="tsd-panel-group tsd-member-group tsd-is-inherited "> 153< h2 > Properties</ h2 > 154< section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited "> 155< a name ="ptr "class ="tsd-anchor "></ a > 156< h3 > ptr</ h3 > 157< div class ="tsd-signature tsd-kind-icon "> ptr< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> number</ span ></ div > 158< aside class ="tsd-sources "> 159< p > Inherited from< a href ="currentcomparisoncomponentstateref.html "> CurrentComparisonComponentStateRef</ a > .< a href ="currentcomparisoncomponentstateref.html#ptr "> ptr</ a ></ p > 160< ul > 161< li > Defined in livesplit_core.ts:1750</ li > 162</ ul > 163</ aside > 164</ section > 165</ section > 166< section class ="tsd-panel-group tsd-member-group tsd-is-inherited "> 167< h2 > Methods</ h2 > 168< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 169< a name ="comparison "class ="tsd-anchor "></ a > 170< h3 > comparison</ h3 > 171< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 172< li class ="tsd-signature tsd-kind-icon "> comparison< 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 > 173</ ul > 174< ul class ="tsd-descriptions "> 175< li class ="tsd-description "> 176< aside class ="tsd-sources "> 177< p > Inherited from< a href ="currentcomparisoncomponentstateref.html "> CurrentComparisonComponentStateRef</ a > .< a href ="currentcomparisoncomponentstateref.html#comparison "> comparison</ a ></ p > 178< ul > 179< li > Defined in livesplit_core.ts:1765</ li > 180</ ul > 181</ aside > 182< div class ="tsd-comment tsd-typography "> 183< div class ="lead "> 184< p > The name of the comparison that is currently selected to be compared 185 against.</ 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 ="text "class ="tsd-anchor "></ a > 194< h3 > text</ h3 > 195< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 196< li class ="tsd-signature tsd-kind-icon "> text< 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 ="currentcomparisoncomponentstateref.html "> CurrentComparisonComponentStateRef</ a > .< a href ="currentcomparisoncomponentstateref.html#text "> text</ a ></ p > 202< ul > 203< li > Defined in livesplit_core.ts:1754</ li > 204</ ul > 205</ aside > 206< div class ="tsd-comment tsd-typography "> 207< div class ="lead "> 208< p > The label's text.</ 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 > 216</ div > 217< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 218< nav class ="tsd-navigation primary "> 219< ul > 220< li class ="globals "> 221< a href ="../globals.html ">< em > Globals</ em ></ a > 222</ li > 223</ ul > 224</ nav > 225< nav class ="tsd-navigation secondary menu-sticky "> 226< ul class ="before-current "> 227</ ul > 228< ul class ="current "> 229< li class ="current tsd-kind-class "> 230< a href ="currentcomparisoncomponentstaterefmut.html "class ="tsd-kind-icon "> Current< wbr > Comparison< wbr > Component< wbr > State< wbr > Ref< wbr > Mut</ a > 231< ul > 232< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited "> 233< a href ="currentcomparisoncomponentstaterefmut.html#constructor "class ="tsd-kind-icon "> constructor</ a > 234</ li > 235< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited "> 236< a href ="currentcomparisoncomponentstaterefmut.html#ptr "class ="tsd-kind-icon "> ptr</ a > 237</ li > 238< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 239< a href ="currentcomparisoncomponentstaterefmut.html#comparison "class ="tsd-kind-icon "> comparison</ a > 240</ li > 241< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited "> 242< a href ="currentcomparisoncomponentstaterefmut.html#text "class ="tsd-kind-icon "> text</ a > 243</ li > 244</ ul > 245</ li > 246</ ul > 247< ul class ="after-current "> 248</ ul > 249</ nav > 250</ div > 251</ div > 252</ div > 253< footer class ="with-border-bottom "> 254< div class ="container "> 255< h2 > Legend</ h2 > 256< div class ="tsd-legend-group "> 257< ul class ="tsd-legend "> 258< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 259< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 260< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 261< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 262< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 263< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 264< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 265</ ul > 266< ul class ="tsd-legend "> 267< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 268< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 269< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 270< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 271</ ul > 272< ul class ="tsd-legend "> 273< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 274< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 275< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 276< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 277< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 278< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 279</ ul > 280< ul class ="tsd-legend "> 281< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 282< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 283< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 284< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 285< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 286< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 287< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 288</ ul > 289< ul class ="tsd-legend "> 290< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 291< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 292< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 293< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 294</ ul > 295< ul class ="tsd-legend "> 296< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 297< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 298< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 299</ ul > 300< ul class ="tsd-legend "> 301< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 302< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 303< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 304</ ul > 305< ul class ="tsd-legend "> 306< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 307< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 308</ ul > 309</ div > 310</ div > 311</ footer > 312< div class ="container tsd-generator "> 313< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 314</ div > 315< div class ="overlay "></ div > 316< script src ="../assets/js/main.js "></ script > 317< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 318</ body > 319</ html >