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 > PotentialCleanUpRef | 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 ="potentialcleanupref.html "> PotentialCleanUpRef</ a > 60</ li > 61</ ul > 62< h1 > Class PotentialCleanUpRef</ 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 > Describes a potential clean up that could be applied. You can query a 73 message describing the details of this potential clean up. A potential clean 74 up can then be turned into an actual clean up in order to apply it to the 75 Run.</ p > 76</ div > 77</ div > 78</ section > 79< section class ="tsd-panel tsd-hierarchy "> 80< h3 > Hierarchy</ h3 > 81< ul class ="tsd-hierarchy "> 82< li > 83< span class ="target "> PotentialCleanUpRef</ span > 84< ul class ="tsd-hierarchy "> 85< li > 86< a href ="potentialcleanuprefmut.html "class ="tsd-signature-type "> PotentialCleanUpRefMut</ a > 87</ li > 88</ ul > 89</ li > 90</ ul > 91</ section > 92< section class ="tsd-panel-group tsd-index-group "> 93< h2 > Index</ h2 > 94< section class ="tsd-panel tsd-index-panel "> 95< div class ="tsd-index-content "> 96< section class ="tsd-index-section "> 97< h3 > Constructors</ h3 > 98< ul class ="tsd-index-list "> 99< li class ="tsd-kind-constructor tsd-parent-kind-class ">< a href ="potentialcleanupref.html#constructor "class ="tsd-kind-icon "> constructor</ a ></ li > 100</ ul > 101</ section > 102< section class ="tsd-index-section "> 103< h3 > Properties</ h3 > 104< ul class ="tsd-index-list "> 105< li class ="tsd-kind-property tsd-parent-kind-class ">< a href ="potentialcleanupref.html#ptr "class ="tsd-kind-icon "> ptr</ a ></ li > 106</ ul > 107</ section > 108< section class ="tsd-index-section "> 109< h3 > Methods</ h3 > 110< ul class ="tsd-index-list "> 111< li class ="tsd-kind-method tsd-parent-kind-class ">< a href ="potentialcleanupref.html#message "class ="tsd-kind-icon "> message</ 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 > Potential< wbr > Clean< wbr > UpRef< 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 ="potentialcleanupref.html "class ="tsd-signature-type "> PotentialCleanUpRef</ 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:3654</ 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 ="potentialcleanupref.html "class ="tsd-signature-type "> PotentialCleanUpRef</ 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:3643</ 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 ="message "class ="tsd-anchor "></ a > 165< h3 > message</ h3 > 166< ul class ="tsd-signatures tsd-kind-method tsd-parent-kind-class "> 167< li class ="tsd-signature tsd-kind-icon "> message< 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:3648</ li > 174</ ul > 175</ aside > 176< div class ="tsd-comment tsd-typography "> 177< div class ="lead "> 178< p > Accesses the message describing the potential clean up that can be applied 179 to a Run.</ 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 > 187</ div > 188< div class ="col-4 col-menu menu-sticky-wrap menu-highlight "> 189< nav class ="tsd-navigation primary "> 190< ul > 191< li class ="globals "> 192< a href ="../globals.html ">< em > Globals</ em ></ a > 193</ li > 194</ ul > 195</ nav > 196< nav class ="tsd-navigation secondary menu-sticky "> 197< ul class ="before-current "> 198</ ul > 199< ul class ="current "> 200< li class ="current tsd-kind-class "> 201< a href ="potentialcleanupref.html "class ="tsd-kind-icon "> Potential< wbr > Clean< wbr > UpRef</ a > 202< ul > 203< li class ="tsd-kind-constructor tsd-parent-kind-class "> 204< a href ="potentialcleanupref.html#constructor "class ="tsd-kind-icon "> constructor</ a > 205</ li > 206< li class ="tsd-kind-property tsd-parent-kind-class "> 207< a href ="potentialcleanupref.html#ptr "class ="tsd-kind-icon "> ptr</ a > 208</ li > 209< li class ="tsd-kind-method tsd-parent-kind-class "> 210< a href ="potentialcleanupref.html#message "class ="tsd-kind-icon "> message</ a > 211</ li > 212</ ul > 213</ li > 214</ ul > 215< ul class ="after-current "> 216</ ul > 217</ nav > 218</ div > 219</ div > 220</ div > 221< footer class ="with-border-bottom "> 222< div class ="container "> 223< h2 > Legend</ h2 > 224< div class ="tsd-legend-group "> 225< ul class ="tsd-legend "> 226< li class ="tsd-kind-module ">< span class ="tsd-kind-icon "> Module</ span ></ li > 227< li class ="tsd-kind-object-literal ">< span class ="tsd-kind-icon "> Object literal</ span ></ li > 228< li class ="tsd-kind-variable ">< span class ="tsd-kind-icon "> Variable</ span ></ li > 229< li class ="tsd-kind-function ">< span class ="tsd-kind-icon "> Function</ span ></ li > 230< li class ="tsd-kind-function tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Function with type parameter</ span ></ li > 231< li class ="tsd-kind-index-signature ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 232< li class ="tsd-kind-type-alias ">< span class ="tsd-kind-icon "> Type alias</ span ></ li > 233</ ul > 234< ul class ="tsd-legend "> 235< li class ="tsd-kind-enum ">< span class ="tsd-kind-icon "> Enumeration</ span ></ li > 236< li class ="tsd-kind-enum-member ">< span class ="tsd-kind-icon "> Enumeration member</ span ></ li > 237< li class ="tsd-kind-property tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Property</ span ></ li > 238< li class ="tsd-kind-method tsd-parent-kind-enum ">< span class ="tsd-kind-icon "> Method</ span ></ li > 239</ ul > 240< ul class ="tsd-legend "> 241< li class ="tsd-kind-interface ">< span class ="tsd-kind-icon "> Interface</ span ></ li > 242< li class ="tsd-kind-interface tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Interface with type parameter</ span ></ li > 243< li class ="tsd-kind-constructor tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 244< li class ="tsd-kind-property tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Property</ span ></ li > 245< li class ="tsd-kind-method tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Method</ span ></ li > 246< li class ="tsd-kind-index-signature tsd-parent-kind-interface ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 247</ ul > 248< ul class ="tsd-legend "> 249< li class ="tsd-kind-class ">< span class ="tsd-kind-icon "> Class</ span ></ li > 250< li class ="tsd-kind-class tsd-has-type-parameter ">< span class ="tsd-kind-icon "> Class with type parameter</ span ></ li > 251< li class ="tsd-kind-constructor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Constructor</ span ></ li > 252< li class ="tsd-kind-property tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Property</ span ></ li > 253< li class ="tsd-kind-method tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Method</ span ></ li > 254< li class ="tsd-kind-accessor tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Accessor</ span ></ li > 255< li class ="tsd-kind-index-signature tsd-parent-kind-class ">< span class ="tsd-kind-icon "> Index signature</ span ></ li > 256</ ul > 257< ul class ="tsd-legend "> 258< li class ="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited constructor</ span ></ li > 259< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited property</ span ></ li > 260< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited method</ span ></ li > 261< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited ">< span class ="tsd-kind-icon "> Inherited accessor</ span ></ li > 262</ ul > 263< ul class ="tsd-legend "> 264< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected property</ span ></ li > 265< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected method</ span ></ li > 266< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected ">< span class ="tsd-kind-icon "> Protected accessor</ span ></ li > 267</ ul > 268< ul class ="tsd-legend "> 269< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private property</ span ></ li > 270< li class ="tsd-kind-method tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private method</ span ></ li > 271< li class ="tsd-kind-accessor tsd-parent-kind-class tsd-is-private ">< span class ="tsd-kind-icon "> Private accessor</ span ></ li > 272</ ul > 273< ul class ="tsd-legend "> 274< li class ="tsd-kind-property tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static property</ span ></ li > 275< li class ="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static ">< span class ="tsd-kind-icon "> Static method</ span ></ li > 276</ ul > 277</ div > 278</ div > 279</ footer > 280< div class ="container tsd-generator "> 281< p > Generated using< a href ="http://typedoc.org/ "target ="_blank "> TypeDoc</ a ></ p > 282</ div > 283< div class ="overlay "></ div > 284< script src ="../assets/js/main.js "></ script > 285< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' );</ script > 286</ body > 287</ html >