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