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