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