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 > TextComponentStateRef | 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 ="textcomponentstateref.html "> TextComponentStateRef</ a > 60</ li > 61</ ul > 62< h1 > Class TextComponentStateRef</ 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 "> TextComponentStateRef</ span > 81< ul class ="tsd-hierarchy "> 82< li > 83< a href ="textcomponentstaterefmut.html "class ="tsd-signature-type "> TextComponentStateRefMut</ 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 ="textcomponentstateref.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 ="textcomponentstateref.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 ="textcomponentstateref.html#center "class ="tsd-kind-icon "> center</ a ></ li > 109< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="textcomponentstateref.html#issplit "class ="tsd-kind-icon "> is< wbr > Split</ a ></ li > 110< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="textcomponentstateref.html#left "class ="tsd-kind-icon "> left</ a ></ li > 111< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="textcomponentstateref.html#right "class ="tsd-kind-icon "> right</ a ></ li > 112</ ul > 113</ section > 114</ div > 115</ section > 116</ section > 117< section class ="tsd-panel-group tsd-member-group "> 118< h2 > Constructors</ h2 > 119< section class ="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class "> 120< a name ="constructor "class ="tsd-anchor "></ a > 121< h3 > constructor</ h3 > 122< ul class ="tsd-signatures tsd-kind-constructor tsd-parent-kind-class "> 123< li class ="tsd-signature tsd-kind-icon "> new< wbr > Text< 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 ="textcomponentstateref.html "class ="tsd-signature-type "> TextComponentStateRef</ a ></ li > 124</ ul > 125< ul class ="tsd-descriptions "> 126< li class ="tsd-description "> 127< aside class ="tsd-sources "> 128< ul > 129< li > Defined in livesplit_core.ts:6526</ li > 130</ ul > 131</ aside > 132< div class ="tsd-comment tsd-typography "> 133< div class ="lead "> 134< p > This constructor is an implementation detail. Do not use this.</ p > 135</ div > 136</ div > 137< h4 class ="tsd-parameters-title "> Parameters</ h4 > 138< ul class ="tsd-parameters "> 139< li > 140< h5 > ptr:< span class ="tsd-signature-type "> number</ span ></ h5 > 141</ li > 142</ ul > 143< h4 class ="tsd-returns-title "> Returns< a href ="textcomponentstateref.html "class ="tsd-signature-type "> TextComponentStateRef</ a ></ h4 > 144</ li > 145</ ul > 146</ section > 147</ section > 148< section class ="tsd-panel-group tsd-member-group "> 149< h2 > Properties</ h2 > 150< section class ="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class "> 151< a name ="ptr "class ="tsd-anchor "></ a > 152< h3 > ptr</ h3 > 153< div class ="tsd-signature tsd-kind-icon "> ptr< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-type "> number</ span ></ div > 154< aside class ="tsd-sources "> 155< ul > 156< li > Defined in livesplit_core.ts:6483</ li > 157</ ul > 158</ aside > 159</ section > 160</ section > 161< section class ="tsd-panel-group tsd-member-group "> 162< h2 > Methods</ h2 > 163< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 164< a name ="center "class ="tsd-anchor "></ a > 165< h3 > center</ h3 > 166< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 167< li class ="tsd-signature tsd-kind-icon "> center< 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 > 168</ ul > 169< ul class ="tsd-descriptions "> 170< li class ="tsd-description "> 171< aside class ="tsd-sources "> 172< ul > 173< li > Defined in livesplit_core.ts:6510</ li > 174</ ul > 175</ aside > 176< div class ="tsd-comment tsd-typography "> 177< div class ="lead "> 178< p > Accesses the centered text. If the text isn't centered, an empty string is 179 returned instead.</ p > 180</ div > 181</ div > 182< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 183</ li > 184</ ul > 185</ section > 186< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 187< a name ="issplit "class ="tsd-anchor "></ a > 188< h3 > is< wbr > Split</ h3 > 189< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 190< li class ="tsd-signature tsd-kind-icon "> is< wbr > Split< span class ="tsd-signature-symbol "> (</ span >< span class ="tsd-signature-symbol "> )</ span >< span class ="tsd-signature-symbol "> :</ span >< span class ="tsd-signature-type "> boolean</ 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:6520</ li > 197</ ul > 198</ aside > 199< div class ="tsd-comment tsd-typography "> 200< div class ="lead "> 201< p > Returns whether the text is split up into a left and right part.</ p > 202</ div > 203</ div > 204< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> boolean</ span ></ h4 > 205</ li > 206</ ul > 207</ section > 208< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 209< a name ="left "class ="tsd-anchor "></ a > 210< h3 > left</ h3 > 211< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 212< li class ="tsd-signature tsd-kind-icon "> left< 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 > 213</ ul > 214< ul class ="tsd-descriptions "> 215< li class ="tsd-description "> 216< aside class ="tsd-sources "> 217< ul > 218< li > Defined in livesplit_core.ts:6488</ li > 219</ ul > 220</ aside > 221< div class ="tsd-comment tsd-typography "> 222< div class ="lead "> 223< p > Accesses the left part of the text. If the text isn't split up, an empty 224 string is returned instead.</ p > 225</ div > 226</ div > 227< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 228</ li > 229</ ul > 230</ section > 231< section class ="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class "> 232< a name ="right "class ="tsd-anchor "></ a > 233< h3 > right</ h3 > 234< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 235< li class ="tsd-signature tsd-kind-icon "> right< 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 > 236</ ul > 237< ul class ="tsd-descriptions "> 238< li class ="tsd-description "> 239< aside class ="tsd-sources "> 240< ul > 241< li > Defined in livesplit_core.ts:6499</ li > 242</ ul > 243</ aside > 244< div class ="tsd-comment tsd-typography "> 245< div class ="lead "> 246< p > Accesses the right part of the text. If the text isn't split up, an empty 247 string is returned instead.</ p > 248</ div > 249</ div > 250< h4 class ="tsd-returns-title "> Returns< span class ="tsd-signature-type "> string</ span ></ h4 > 251</ li > 252</ ul > 253</ section > 254</ section > 255</ div > 256< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 257< nav class ="tsd-navigation primary "> 258< ul > 259< li class ="globals "> 260< a href ="../globals.html ">< em > Globals</ em ></ a > 261</ li > 262</ ul > 263</ nav > 264< nav class ="tsd-navigation secondary menu-sticky "> 265< ul class ="before-current "> 266</ ul > 267< ul class ="current "> 268< li class ="current tsd-kind-class "> 269< a href ="textcomponentstateref.html "class ="tsd-kind-icon "> Text< wbr > Component< wbr > State< wbr > Ref</ a > 270< ul > 271< li class ="tsd-kind-constructor tsd-parent-kind-class "> 272< a href ="textcomponentstateref.html#constructor "class ="tsd-kind-icon "> constructor</ a > 273</ li > 274< li class ="tsd-kind-property tsd-parent-kind-class "> 275< a href ="textcomponentstateref.html#ptr "class ="tsd-kind-icon "> ptr</ a > 276</ li > 277< li class ="tsd-kind-method tsd-parent-kind-class "> 278< a href ="textcomponentstateref.html#center "class ="tsd-kind-icon "> center</ a > 279</ li > 280< li class ="tsd-kind-method tsd-parent-kind-class "> 281< a href ="textcomponentstateref.html#issplit "class ="tsd-kind-icon "> is< wbr > Split</ a > 282</ li > 283< li class ="tsd-kind-method tsd-parent-kind-class "> 284< a href ="textcomponentstateref.html#left "class ="tsd-kind-icon "> left</ a > 285</ li > 286< li class ="tsd-kind-method tsd-parent-kind-class "> 287< a href ="textcomponentstateref.html#right "class ="tsd-kind-icon "> right</ a > 288</ li > 289</ ul > 290</ li > 291</ ul > 292< ul class ="after-current "> 293</ ul > 294</ nav > 295</ div > 296</ div > 297</ div > 298< footer class ="with-border-bottom "> 299< div class ="container "> 300< h2 > Legend</ h2 > 301< div class ="tsd-legend-group "> 302< ul class ="tsd-legend "> 303< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 304< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 305< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 306< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 307< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 308< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 309< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 310</ ul > 311< ul class ="tsd-legend "> 312< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 313< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 314< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 315< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 316</ ul > 317< ul class ="tsd-legend "> 318< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 319< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 320< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 321< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 322< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 323< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 324</ ul > 325< ul class ="tsd-legend "> 326< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 327< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 328< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 329< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 330< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 331< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 332< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 333</ ul > 334< ul class ="tsd-legend "> 335< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 336< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 337< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 338< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 339</ ul > 340< ul class ="tsd-legend "> 341< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 342< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 343< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 344</ ul > 345< ul class ="tsd-legend "> 346< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 347< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 348< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 349</ ul > 350< ul class ="tsd-legend "> 351< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 352< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 353</ ul > 354</ div > 355</ div > 356</ footer > 357< div class ="container tsd-generator "> 358< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 359</ div > 360< div class ="overlay "></ div > 361< script src ="../assets/js/main.js "></ script > 362< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 363</ body > 364</ html >