Search results

! ASH Accessor Function / Notes

! ASH Accessor Function / Notes

function1={{Function| function2={{Function|

...use your current [[Choice Adventures|choice adventure preferences]]. This function returns the HTML of the choice result page (not just what is displayed, but <p>A handy use for this function is to finish up choices that were started in the relay browser, or were int

function1={{Function| ...eeds to run a choice or combat, using your current KoLmafia settings. This function returns the HTML from the page (not just what is displayed, but all markup)

function1={{Function| function2={{Function|

function1={{Function|

<p>This function was added in [https://kolmafia.us/threads/17892-add-a-bunch-of-ash-support-

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function| ...es match the selector. In the event the selector uses invalid syntax, this function will error with "invalid xpath expression"|

function1={{Function|

...set - Adds all current active effects on the player. Users will find this function extremely useful.

function1={{Function| function_description=This function returns a list of all available in-game outfits.|

function1={{Function| function_description=This function returns image file name of outfit tattoo. If the outfit doesn't exist, retu

function1={{Function|

| function1= {{Function

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function will the total number of free rests available to your character. These rest

function1={{Function| special=When this function is called by any script that is not a relay override, it returns an empty s

function1={{Function| special=When this function is called by any script that is not a relay override, it returns an empty s

function1={{Function| special=When this function is called by any script that is not a relay override, it returns an empty s

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function returns an integer indexed list of all currently defined mood names.|

function1={{Function| function_description=This function will return true if a specified monster is currently {{kolwiki|Banishing|ba

function1={{Function| function_description=This function returns a list of all KoL outfits that the character currently owns and can

function1={{Function| function_description=This function returns a list of all currently defined custom outfits. This list begins wi

function1={{Function|

function1={{Function| special=When not logged in, this function returns false.

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| special=If no match is found for {{pspan|convert}}, this function returns $bounty[ none ].|

function1={{Function|

function1={{Function| function_description=This function returns true if familiar equipment is locked, otherwise it returns false.|

function1={{Function| ...ocking}} is false. If there is no need to change locking status, then this function will do nothing.|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function returns true if there are any goals that match {{pspan|type}}.|

function1={{Function| function_description=This function returns an integer indexed map of all active adventuring goals that have no

function1={{Function| function_description=This function returns true if you are wearing all parts of the outfit {{Pspan|name}}.|

function1={{Function|

function1={{Function| function_description=This function returns true if you are on the "Avatar of Boris" challenge path and his min

function1={{Function| function_description=This function returns true if the Hippy Stone in your campground is currently broken.|

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function returns the total number of adventures used by the logged-in character sinc

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function returns a string identifying how an item is crafted and any other requireme

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| description=Following example creates a function that notifies you if items in your shop are above a given percent. The curr

function1={{Function| cli_equiv=The CLI command "refresh" with the parameter "shop" has the same function.|

function1={{Function| more_info=This function will only return the character's class skill or Shadow Noodles. Other stunn

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| special=When not logged in, this function returns 0.

BatBrain is a function library intended to greatly simplify writing a [[Custom_Combat_Script#Consu ...ng a combat script, you may have to deal with one. Fortunately, there are some functions for dealing with spreads:

function1={{Function| function_description=This function check if item can be discarded, returning true if it can other false. Keep

function1={{Function| description=The following example creates a function called "in_shop" which tells you how many of a given item is currently in y

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function returns true if the logged-in character has completed the Deep Fat Friars q

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

! ASH Accessor Function / Notes ! ASH Accessor Function / Notes

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| ...m {{pspan|it}} from {{pspan|master}}. If {{pspan|qty}} is less than 1, the function will return true without purchasing anything. Otherwise it returns true if

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function will return the identity of your current familiar. If you have a Doppelshif

function1={{Function| function_description=This function returns true if the logged-in character has has access to Little Canadia.|

function1={{Function| function_description=This function returns true if the logged-in character has has access to the Gnomish Gnoma

function1={{Function| function_description=This function returns true if the logged-in character has has access to the inside of Deg

function1={{Function| ...so if you call this function and then unlock a new NPC store, calling this function again will return the new availability state of the item.|

function1={{Function| special=This function returns "None" when not logged in.|

function1={{Function| special=This function returns "None" when not logged in.|

function1={{Function| ...itions. Auto-adventuring through KoLmafia or the [[adventure|adventure()]] function will stop if your current conditions are met.|

function1={{Function| ...=Returns the url that would be visited if this was a {{f|visit_url}}. This function was intended for troubleshooting crafted urls and has no use outside of deb

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function returns an array of the items which compose an outfit. This works for both

function1={{Function| function_description=This function allows mafia to send notifications to chat.|

function1={{Function| function_description=This function returns true if the logged-in character has learned the password to the Kno

function1={{Function| function_description=This function returns true if the logged-in character had successfully used the Spooky Ma

function1={{Function|

function1={{Function|

function1={{Function| ...t match the actual amount of MP reduction (and therefore the value of this function).|

function1={{Function| * Preferences function: pref(text)

function1={{Function| * Preferences function: pref(text)

function1={{Function| function_description=This function returns the character in {{pspan|source}} which is at position {{pspan|inde

...eing true (and will automatically be so, if you use the {{fa|test_button}} function). ...e_field}} and {{fa|write_textarea}}) can be passed the name of a validator function that can check (and possibly modify) the field value. Any validation failur

function1={{Function| function_description=This function will initiate a countdown from {{pspan|secs}} seconds to 0, during which ti

function1={{Function| ...he item used to get the dwelling). Note that if you have no dwelling, this function will return $item[big rock].|

ZLib is a function library intended to make life easier for both script authors and script use {{HideLink|excise}}{{Function|

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| function2={{Function|

function1={{Function|

...l it without using the return value in any way, KoLmafia will abort if the function fails:

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| ...o be promoted for the general public's use. When using a daily build, this function returns the most recent official version.|

...No value can be assigned to '''void''' nor can a value be returned from a function of datatype '''void'''. Be careful when doing math with integers! As with some other strongly-typed languages, numbers are converted to integers at every

...l''' modifier will attempt to maximize all elements, even if it means that some of the elements will get no boost at all. Some extra provided keywords are useful in PvP minigames. '''number''' increases

function1={{Function| ...ly in a Casual ascension. In any other path (including Unrestricted) this function returns false.|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function first resets the matcher {{pspan|pattern}}. It then scans the input sequenc

function1={{Function| function_description=This function first resets the matcher {{pspan|pattern}}. It then scans the input sequenc

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| ...y non-negative integer smaller than or equal to the value returned by this function is guaranteed to be a valid [[group|group()]] parameter for this matcher.|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function2={{Function|

: ''type'' is an optional parameter which must match the return value of the function. If not specified, ''type'' defaults to void. ...H code will result in an error, because the <code>func_inside_bar()</code> function is not visible from within <code>foo()</code>:

...ly every possible pattern of characters you might want to search for. Only some of the generally most common forms of regexes will be described on this pag ...type. Defining a matcher also requires the use of the {{f|create_matcher}} function.

function1={{Function|

function1={{Function| ...monster is specified and no monster has been fought in this session, this function returns $monster[none]. This is because mafia forgets the value when it log

function1={{Function| ...tion=Replaces the center image of the Cyrpt (it's blank, don't worry) with some information regarding the noncombats of the zones.|

function1={{Function|

function1={{Function|

function1={{Function|

|description=This function returns a price no more than 18 hours old by checking {{f|mall_price}} if { function checkPrice(shopfor) {

function1={{Function| function2={{Function|

...s the same restrictions as {{f|mall_price}}. Unlike {{f|mall_price}}, this function will never hit the server.</p>

function1={{Function| * Path function: path(text)

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function| ...om the relay request being handled. Unlike the [[form_field|form_field()]] function, this allows iterating over all the fields,

function1={{Function| special=If no match is found for {{pspan|convert}}, this function returns $stat[ none ].|

function1={{Function| cli_equiv=The CCS entry of "try to steal an item" accomplishes the same function. (You can change your CCS with the command "ccs" on the CLI.)|

function1={{Function| special=Note that this function is case-sensitive, as with direct casting. Anything besides the following l

...variable declared inside of a function will be accessible only inside that function (including inside of control structures), but is considered to not exist by ...fined variable, and then declare a variable with the same name inside of a function (as their scopes overlap).

function1={{Function|

function1={{Function| description=Removes the border that KoL uses to frame some tables.|

function1={{Function|

...eserved for special usage by KoLmafia. They can not be used as variable or function names.

function1={{Function| function_description=This function returns true if the logged-in character has completed Doc Galaktik's Quest

function1={{Function| <p>Note that this function does not return any information regarding the mini-moon.|

function1={{Function|

If you find yourself here in search of a function, please note that you will need to look for an alternative.

Errors happen. When they do, it helps to have some idea of what what wrong. Whenever a script runs the [[abort|abort()]] function, this error is generated.

function1={{Function|

function1={{Function|

Enables the script writer to invoke a function whose name is known at runtime. Constructor function used to populate a record.

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function returns the total number of adventures used thus far by the logged-in chara

function1={{Function| <p>The main difference between this function and {{f|visit_url}} is that this function will only contact the server once each time the script is run; from then on

function1={{Function| ...are not in a sign with access to a special eatery, or not logged in, this function returns $item[none].|

function1={{Function| special=This function returns false if no character is logged in.|

function1={{Function| ...s not reflect whether or not the items were actually consumed.) Using this function, rather than {{f|eat}}, will suppress the warning dialogs that may otherwis

function1={{Function| function2={{Function|

* ASH function [[form_fields|form_fields()]], which returns a string[string] map with all Additionally, there are some excellent tools for writing form elements in interface scripts on the [http

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function|

Note that although some of these functions have an ASH derivative that may be easier to use, the tw ! Related ASH function / Notes

function1={{Function| description=The following function sets the MCD to the maximum possible value.|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| special=String converted by this function can be returned to their original form with [[url_decode|url_decode()]].|

function1={{Function| special=String converted by this function can be returned to their original form with [[url_encode|url_encode()]].|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| ...ltiple times in a row; however, they cannot be the first character or this function will return false).|

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

mmg was removed from KoL and KoLmafia in 2019. This function is obsolete.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

This function was removed when the make money game was removed from KoL.

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

This one is tricky! The function takes a 'Familiar' type, and will error when you feed it a string. Therefor Another tricky function in that it only takes an "Item". Syntax is:

function1={{Function| special=This function returns an empty string when not logged in.|

...e out slime damage that will be taken. Note that it is defined OUTSIDE any function! f) Time for the main function. I have 3 inputs. How many turns to adventure, when I should use a Chamois(

...se all 10 usages per day. Note the stills_available() function. I then buy some basic booze if needed, then use create() to make the appropriate upgrade to ## If we don't have enough, go buy some of the basic booze.

f) Finally, note the have_effect() function. It tests to see if your character has a specific buff/debuff. If so, the r

...ing, you can mall-sell certain items, auto-sell some of them, or pulverize some.

c) item_amount($item[xxx]) is a function that will tell you how many of an item you currently possess. ...tem[xxx]) is what you use to buy stuff from the mall. You NEED to use this function as it specifically overrides your normal preferences. If you use the 'acqui

...ing everything that comes before {{pspan|start}} in {{pspan|search}}. This function returns the position where {{pspan|find}} first occurs in {{pspan|search}}, <p>This function returns a 0-indexed value, meaning that the first character of {{pspan|sear

...h the string {{pspan|search}}, looking for the string {{pspan|find}}. This function returns the position where {{pspan|find}} last occurs in {{pspan|search}}.< <p>This function returns a 0-indexed value, meaning that the first character of {{pspan|sear

function1={{Function| function2={{Function|

function1={{Function| ...ch are both case-sensitive (it will not match on "You gain 10 meat"). This function can be used for parsing meat gains and losses from combat and kmails (thoug

function1={{Function| ...se-sensitive, so it will not match on "You Acquire 10 broken skulls". This function can be used for parsing item acquisition from combat and kmails (though onl

function1={{Function|

function1={{Function| p1desc={{pspan|func}} is the name of the function you wish to enable.

function1={{Function| ...ont size, tables, font colours, etc can all be specified. This can produce some interesting effects in scripts. For example, producing pleasing layouts, su

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| special=This function uses the last monster encountered, so it will base its calculations on your

function1={{Function| special=This function uses the last monster encountered, so it will base its calculations on your

function1={{Function| function_description=This function attempts to use an item during a combat round, and returns the html respons

function1={{Function| cli_equiv=The CCS entry of "run away" accomplishes the same function. (You can change your CCS with the command "ccs" on the CLI.)|

function1={{Function| function_description=This function attempts to use two items in a combat round (for those with the skill Ambid

function1={{Function| cli_equiv=The CCS entry of "attack with weapon" accomplishes the same function. (You can change your CCS with the command "ccs" on the CLI.)|

function1={{Function| function2={{Function|

function1={{Function| special=When not logged in, this function returns $location[none].|

function1={{Function| cli_equiv=The CLI command "refresh" with the parameter "status" has the same function.|

function1={{Function|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| function_description=This function will initiate a countdown from {{pspan|secs}} seconds to 0, during which ti

function1={{Function| p1desc={{pspan|func}} is the name of the function you wish to disable.

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

|description=This function checks whether the string "Hello World!" contains the word "World". |description=This function checks whether a character is in a clan.

function1={{Function| ...te a new key in a map (defined outside the function to hopefully eliminate some confusion).|

function1={{Function| function_description=This function allows you to send ingame private messages through chat to any player.|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function_description=This function returns true if you have all parts of the outfit {{Pspan|name}} and meet al

function1={{Function| function_description=This function attempts to put on the outfit specified as {{pspan|name}}, and returns true

function1={{Function| special=Note that while this function does take class weapons and the jewel-eyed wizard hat into account, it does

function1={{Function| ...t match the actual amount of MP reduction (and therefore the value of this function).|

function1={{Function| function2={{Function|

function1={{Function| function_description=This is the ceiling function, which returns the smallest integer greater than or equal to the supplied {

function1={{Function| function2={{Function|

! ASH Accessor Function / Notes

! ASH Accessor Function / Notes

function1={{Function|

function1={{Function| ...the specified familiar {{pspan|buddy}} is your current familiar after the function's completion (so it will return true if you try to switch to your current f

function1={{Function| function_description=This function returns true if the logged-in character has unlocked the Black Market. Othe

function1={{Function| function_description=This function returns true if the logged-in character has unlocked their guild store. Oth

function1={{Function| ...cked the hippy store. Otherwise, it returns false. Note: technically, this function checks for the hippy store + island access; it never checks to see if you h

function1={{Function| function_description=This function returns true if the logged-in character has completed the White Citadel Que

function1={{Function| description=A universal consume function.|

function1={{Function| ...{{pspan|check_me}} on your character, false if you cannot. Note that this function doesn't check for whether or not you actually have the item; just whether y

function1={{Function| ...kingly labeled as "3-handed" in KoL are actually 2-handed in reality, this function will return 3.|

function1={{Function| ...ot have any stat requirements. If {{pspan|check_me}} is not a weapon, this function returns $stat[none].|

function1={{Function| ...ct transformations of familiars due to wardrobe or doppleshifting, so this function is incapable of detecting such transformation if it is called during combat

function1={{Function| cli_equiv=The CLI commands "equip" and others function similarly, if the parameter "list" or no parameters are given.|

function1={{Function| ...for the final result), only the last stage of requirements is listed. This function will parse items that can be created through multi-use of items as well as

function1={{Function| function_description=This function checks to see if the item {{pspan|check_me}} can be sent as a gift, returni

function1={{Function| function_description=This function checks to see if the item {{pspan|check_me}} can be put in a display case,

function1={{Function|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| ...f {{pspan|get}} is not a hermit item, this function will return true. This function will fail to return any value and abort completely if unable to buy the req

function1={{Function| ...with a non-usable item, a message saying so will print to the CLI and the function will return true.|

function1={{Function| cli_equiv=The CLI commands "pull" and "hagnk" function similarly.|

function1={{Function|

function1={{Function| * Caution is required when using more than one batchable function in a single batch, since they won't be executed in the same order you wrote

function1={{Function|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function| function_description=This function will visit the council and print the text there to the CLI. It is useful in

function1={{Function| function_description=This function returns a map of every monster in a given location. Useful for iterating ov

...itions. Auto-adventuring through KoLmafia or the [[adventure|adventure()]] function will stop if your current conditions are met.</p> <p>Note that this function adds items in "+ mode" rather than the standard "total mode" done via the A

function1={{Function| function_description=This function will read a line from the active [[Custom Combat Script|CCS]] for a given r

function1={{Function| p3desc={{Pspan|filterFunc}} is a macro or the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-parama

The main() function in the ASH script being consulted must accept three parameters:

function1={{Function|

function1={{Function| function_description=This function finds all (non-overlapping) matches of the regular expression {{pspan|group

function1={{Function|

function1={{Function| p1desc={{pspan|target}} is the minimum HP desired after the function is run.|

function1={{Function| p1desc={{pspan|target}} is the minimum MP desired after the function is run.|

function1={{Function| ...have_effect}}. If the effect is an intrinsic that you currently have, this function returns 2147483547 (which is 100 less than a signed integer's upper limit).

function1={{Function|

function1={{Function| description=The following prints a friendly reminder to grab some lucre if you don't have Olfaction.|

function1={{Function|

function1={{Function|

function1={{Function| description=The following function will use your shop when acquiring an item however it will not purchase anyt

function1={{Function| function_description=This function will return true if you are under the Bad Moon sign. If you are under any o

function1={{Function| function2={{Function|

<p>This function was added in [https://kolmafia.us/threads/20796-add-runtime-library-functio

function1={{Function| ...n average return per monster for a given location. It calls the preceeding function.|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| <p>Note that the function will return true for items that can be bought in sign stores, even if you c

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| <li> Most values will be 1 to represent the item exists; some can be as high as 9, such as pretty bouquets and fences.</li>

function1={{Function|

function1={{Function| description=This function attempts to create a Divine, or gives a warning if still uses aren't availa

function1={{Function| // Just to save some space later on.

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function| function2={{Function|

! ASH Accessor Function / Notes

function1={{Function|

function1={{Function|

function1={{Function| function_description=This is a raw crafting function that will attempt to craft raw materials without considering the outcome of

function1={{Function| function_description=Retrieves some variable-length internal data that isn't readily readable via [[file_to_map

function1={{Function| special=When not logged in the function returns 0.0

function1={{Function| special=When not logged in the function returns 0.0

function1={{Function|

function1={{Function|

! ASH Accessor Function / Notes

function1={{Function| ...ber, from a minimum of 0 to a maximum of {{pspan|range}}-1. Note that this function aborts with an error if you attempt to supply 1 for {{pspan|range}} (not th

This function returns true if the character is out of Hardcore or Ronin, false otherwise. Essentially the top three overloaded functions call the bottom function, telling it NOT to create the item.

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function| function2={{Function|

! ASH Accessor Function / Notes

There are two forms of this function. In a combat consult script, this returns a buffer, but otherwise it return function1={{Function|

function1={{Function|

Some command names can be followed by a question mark (shown as [?] ), in which ...me can be used in the obvious way, however this may sometimes fail because some items have numbers as part of their names. KoL's fuzzy matching will someti

|more_info=Note that this function returns an empty string if the page does not exist or if the request times ...ome people claim that it is better to [[append|append]] the result of this function to a buffer instead of saving it as a string when dealing with an especiall

function1={{Function| function_description=This is the floor function, which returns the largest integer less than or equal to the supplied {{psp

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| function_description=This function checks to see if the item {{pspan|check_me}} can be traded via the Mall, re

...ement, if specified. Note that the value's datatype must match that of the function itself (void functions can only use return by itself).

...ny time you can declare a variable: as a top level (global) variable, as a function parameter, or as a local variable in any scope. ...a from a map any time you can provide a data value: in an expression, as a function parameter, on the right side of an assignment statement, from a "return" st

...ll execute it as though it was typed in through the normal interface. This function will return <code>true</code> if the gCLI command executed properly, and <c ...where no ASH function exists to handle a task (e.g. creating moods). This function provides an escape hatch for such tasks by using gCLI commands from within

...evel command; attempting to import another script inside a closure (e.g. a function or a loop) will result in an error. ...licitly called by the importing script. To do so, the script calls it as a function with the name <code>main@filename()</code>.

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function| special=When no character is logged in, this function returns the Character ID of the last logged-in character or 0 if no charact

function1={{Function| description=This example function will return the total number of knob goblin firecrackers in your inventory,

function1={{Function| ...assing $stat[submuscle], $stat[submysticality], or $stat[submoxie] to this function will always return 0.|

function1={{Function| description=The following function attempts to set your MCD to the maximum.|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function| ...an item, or an item that cannot be autosold, will still return true as the function has done as much as it could.|

function1={{Function| This function and it's CLI equivalent "acquire" will not purchase items from the mall tha

|description=This function is often used for basic error handling.

...listed; this list is intended to be kept current, but it is possible that some functions added since the above revision may be missing. (Please feel free The CLI command "[[ashref]]" shows every implemented ash function for your mafia version. A guide to add new functions via a script can be fo

function1={{Function| ...the logged-in character's particular stat as an int.</p><p>Note that this function also accepts $stat[submuscle], $stat[submysticality], and $stat[submoxie] a

...er_confirm|user_confirm( string )]] (which returns a boolean), but not the function [[to_url|to_url( location )]] (which returns a string).

function1={{Function| special=When not logged in, this function returns 15.

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| description=The function will calculate the average damage you will take from each monster in a give

function1={{Function|

function1={{Function| description=The function will calculate the average damage you will take from a given monster, if yo

function1={{Function| special=This function returns 0 when not logged in.

function1={{Function| description=This example attempts to eat some food giving moxie substats if today is a moxie day.|

function1={{Function| description=The following function checks to see if tomorrow will be a stat day benefiting your primary stat.|

function1={{Function| special=When not logged in, this function returns $stat[muscle].

function1={{Function| description=This example function ensures that the MCD is set to 5 before attacking the Bonerdagon.|

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| special=When not logged in, this function returns false.

function1={{Function| special=When not logged in, this function returns false.

function1={{Function| special=When not logged in, this function returns false.

function1={{Function| special=When not logged in, this function returns $stat[moxie] (Needs spading).

function1={{Function|

! ASH Accessor Function / Notes

function1={{Function| ...r Oxygenarian path. If the character is subject to those restrictions this function returns false.|

function1={{Function| ...r Oxygenarian path. If the character is subject to those restrictions this function returns false.|

function1={{Function| ...ubject to Hardcore restrictions. If not subject to such restrictions this function returns false.|

function1={{Function| special=When not logged in, this function returns 14.

function1={{Function| special=When not logged in, this function returns 0.

function1={{Function| description=Using this function to spend all of your adventures farming the Castle:|

function1={{Function| function_description=This function returns true if the logged-in character is subject to neither Hardcore nor

function1={{Function| function_description=This function returns the total number of adventures used thus far by the logged-in chara

...ction. No check is made to verify that the chopped-off portion of the old function name actually matches the type of its parameter.

! ASH Accessor Function / Notes

function1={{Function| special=When not logged in, this function returns $[[class]][none].

function1={{Function| special=When not logged in, this function returns 1.

! ASH Accessor Function / Notes

function1={{Function| special=When not logged in, this function returns an empty string.

function1={{Function| special=When not logged in, this function returns 0.

{{Flink|void|disable|string|desc=Disables the specified function.}} {{Flink|void|enable|string|desc=Enables the specified function.}}

...ts the desired location a specified number of times, using a combat filter function defined elsewhere in your script.}}

...equip requirement stat for the specified item. If it is not a weapon, this function returns $stat[none].}} {{Flink|string [int]|get_outfits|desc=This function returns a list of all KoL outfits that the character currently owns and ca

...; font-size: 0.875em; font-weight: bold; padding: 0; margin: 0 0 0 0.4em;">FUNCTION CATEGORIES</span><br /> * [[Ash Functions|Master Function List]]

! ASH Accessor Function / Notes

! ASH Accessor Function / Notes

! ASH Accessor Function / Notes

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function| special=This function returns "0" when not logged in.|

function1={{Function|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

...e> module. To use these functions, you must use the <code>require()</code> function to import them: The <code>require()</code> function is usually called once at the top of the script.

...439-you-can-create-a-bottle-of-sea-wine-by-using-a-bunch-of-sea-grapes-add-some-a.24054/ r19439].</p>

...tion always retrieves the up-to-date internal list of known monsters. This function is needed because <code>$monsters[]</code> contains a list of monsters that

...439-you-can-create-a-bottle-of-sea-wine-by-using-a-bunch-of-sea-grapes-add-some-a.24054/ r19439].

<p>This function was added in [https://kolmafia.us/threads/file_to_string-or-file_to_map-str

...hecks if the current KoLmafia theme is one of the "dark mode" themes. This function was added in [https://kolmafia.us/threads/20566-new-command-is_dark_mode-fo

|description=This function was added in [https://sourceforge.net/p/kolmafia/code/17937 r17937] and [ht

<p>This function was added in [https://kolmafia.us/threads/17892-add-a-bunch-of-ash-support-

<p>This function was added in [https://kolmafia.us/threads/17892-add-a-bunch-of-ash-support-

<p>This function was added in [https://kolmafia.us/threads/17892-add-a-bunch-of-ash-support-

<p>This function was added in [https://kolmafia.us/threads/17892-add-a-bunch-of-ash-support-

|description=This function was added in [https://kolmafia.us/threads/17911-add-ash-convenience-functio |description=The following function call will return <code>true</code>:

|description=This function was added in [https://kolmafia.us/threads/17911-add-ash-convenience-functio |description=The following function call will return <code>true</code>:

|description=<p>This function behaves like {{f|cli_execute}}, except that it captures the text printed to

<p>This function was added in [https://kolmafia.us/threads/20796-add-runtime-library-functio

! ASH Accessor Function / Notes

function1={{Function| function2={{Function|

function1={{Function| function2={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

function1={{Function|

|description=This function was added in [https://sourceforge.net/p/kolmafia/code/19543 r19543] and exp

* Create a file called "AshRef Function List.txt" in the KoLmafia folder. * Copy paste all the functions found between the two debugs into the "AshRef Function List.txt" text file.