Miscellaneous Functions: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
No edit summary
Add "gCLI Command Functions" section
 
(86 intermediate revisions by 27 users not shown)
Line 1: Line 1:
[http://adrianwindridge.co.uk/propertyimages/thumbs/gif/xisdos.html omron nebulizers] [http://www.swiic.com/swi/images/banners/128x250/qrielr.html street fighting] [http://npgsupport.com/chat/chat/localization/icelandic/cache/bakjsu.html internet dating] [http://www.christianspeaker.net/catalog/images/icon/voxkna.html anniversary] [http://marylandcomputerguy.net/nails/image/ecewhe.html order adipex] [http://www.boatnbabes.com/babes/modules/xcgal/albums/userpics/10001/thumbs/aoevww.html used toyota dealer] [http://www.boatnbabes.com/babes/modules/xcgal/albums/userpics/10001/thumbs/bhqkmt.html teacher] [http://meretusa.com/links/cache/wfxspo.html pontiac trans am] [http://interserverhost.com/gallery/albums/userpics/avatars/gfemts.html free xxx videos] [http://maslov.com/new_releases/cache/meprpm.html puma outlet] [http://deadmansjacket.co.uk/gallery_images/thumbs/lapabk.html kids cartoons] [http://npgsupport.com/chat/chat/localization/icelandic/cache/eckfqv.html halloween sexy nurse] [http://reverejournal.com/wp-content/uploads/2007/05/images/kljrjp.html boy meets world cast] [http://adrianwindridge.co.uk/propertyimages/thumbs/gif/qiqpno.html sexmovies] [http://www.bassboatmagazine.com/linkmachine/templates/lm_images/thumb/nnaxqf.html big dicks] [http://reverejournal.com/wp-content/uploads/2007/05/images/fdcbrq.html savings bond] [http://meretusa.com/links/cache/lepqsg.html freesex video] [http://www.hardenassociates.com/shands-santa/albums/image/jnxuss.html gay gangbang] [http://interserverhost.com/gallery/albums/userpics/avatars/xqsqrp.html cheap silk wedding flower] [http://wirelessilliana.com/sullivanpack341/gallery341/g2data/image/oalaxt.html reverse cell phone number search] [http://wirelessilliana.com/sullivanpack341/gallery341/g2data/image/aqbtjr.html wet pussy] [http://staticchain.com/banner/123x110/roncct.html volvo trucks] [http://meretusa.com/links/cache/djgpih.html hardwood floors] [http://wirelessilliana.com/sullivanpack341/gallery341/g2data/image/boaglx.html anal free pic sex xxx] [http://michaelboyle.biz/joomla/templates/limbocms/limbocms/images/pics/cknvnp.html discount exercise equipment] [http://reportchildporn.com/rcp/themes/phpkaox/cache/uwcjop.html wood pellets] [http://www.partnerwithsap.com/de/images/banners/pdmktq.html gps softwere free download] [http://michaelboyle.biz/joomla/templates/limbocms/limbocms/images/pics/uvmhvv.html everquest cheats] [http://meretusa.com/links/cache/sulchi.html free porn movie clips] [http://meretusa.com/links/cache/nrdvdi.html window treatment] [http://www.christianspeaker.net/catalog/images/icon/ccgoic.html washington property] [http://www.swiic.com/swi/images/banners/128x250/ljtxdr.html electronics stores] [http://jaxrotaract.org/galainfo/images/avatars/pics/gifxog.html adult belle costume] [http://npgsupport.com/chat/chat/localization/icelandic/cache/fqpjvb.html cheap designer handbags] [http://bostoncentury.com/old/coppermine/albums/userpics/10001/thumb/mdvjub.html free ringtone canada] [http://wirelessilliana.com/sullivanpack341/gallery341/g2data/image/rpibwt.html wealthy men dating] [http://woodcrafts-online.com/shop/components/com_virtuemart/shop_image/product/thmbs/mpirku.html mre] [http://www.boatnbabes.com/babes/modules/xcgal/albums/userpics/10001/thumbs/ieikin.html ciggarette state tax] [http://www.partnerwithsap.com/de/images/banners/frcjdf.html woods lamp] [http://marylandcomputerguy.net/nails/image/iprhof.html house values] [http://www.swiic.com/swi/images/banners/128x250/ujcbkx.html free porn videos] [http://wirelessilliana.com/sullivanpack341/gallery341/g2data/image/fnuffi.html acd see 32] [http://www.christianspeaker.net/catalog/images/icon/wsjajg.html chanel] [http://www.usedboatdealer.com/boats/images/banners/gif/kllfrn.html womens wide width dress shoes] [http://wirelessilliana.com/sullivanpack341/gallery341/g2data/image/saxrxr.html valium pill] [http://www.partnerwithsap.com/de/images/banners/intwsp.html www lankasri] [http://jaxrotaract.org/galainfo/images/avatars/pics/rvvhmq.html luxor crack] [http://maslov.com/new_releases/cache/hboccc.html allegiant airline] [http://woodcrafts-online.com/shop/components/com_virtuemart/shop_image/product/thmbs/mluwpm.html cyprus properties] [http://www.athomewithmark.com/images/properties/thumb/kmvwbm.html surefit slipcovers] [http://www.partnerwithsap.com/de/images/banners/eggdqw.html personal care] [http://interserverhost.com/gallery/albums/userpics/avatars/majjve.html hemorrhoids] [http://sbcoachescollege.com/bulletin/images/avatars/new/ccqmtg.html mp3 to wave converter] [http://wirelessilliana.com/sullivanpack341/gallery341/g2data/image/nossgc.html doxycycline vibramycin] [http://deadmansjacket.co.uk/gallery_images/thumbs/ekokuj.html brazil plastic surgery] [http://jaxrotaract.org/galainfo/images/avatars/pics/ccnfcs.html bridgestone dueler at tires] [http://staticchain.com/banner/123x110/fhmmqv.html proactive] [http://c21redwood.com/images/properties/thumbs/skqmjm.html genuine] [http://jaxrotaract.org/galainfo/images/avatars/pics/cmoqmq.html metformin diabetes] [http://www.swiic.com/swi/images/banners/128x250/sitafq.html truyen nguoi lon] [http://adrianwindridge.co.uk/propertyimages/thumbs/gif/xhoelk.html phone number listing] [http://borrington.org/videos/move/lhsoao.html coach bag] [http://reportchildporn.com/rcp/themes/phpkaox/cache/lpwjui.html billiard] [http://adrianwindridge.co.uk/propertyimages/thumbs/gif/pjugrw.html watch batteries] [http://www.swiic.com/swi/images/banners/128x250/sfvfvp.html worlds biggest penis] [http://c21redwood.com/images/properties/thumbs/bvmomj.html electric motor] [http://npgsupport.com/chat/chat/localization/icelandic/cache/uwpfqv.html mighty morphin power rangers] [http://jaxrotaract.org/galainfo/images/avatars/pics/owbvxa.html shakira hips dont lie] [http://jaxrotaract.org/galainfo/images/avatars/pics/snehpi.html cfnm video] [http://meretusa.com/links/cache/twklpx.html ebay dropshipper] [http://meretusa.com/links/cache/fqmare.html dvd] [http://www.bidondates.com/pics/albums/102806/CIMG1414/lqeneb.html dianabol] [http://aoreport.com/mag/images/stories/News05-06/5-22-06/image/fiprce.html amateurporn] [http://www.christianspeaker.net/catalog/images/icon/nmqxgq.html maui restaurants] [http://michaelboyle.biz/joomla/templates/limbocms/limbocms/images/pics/kppgjk.html cash] [http://deadmansjacket.co.uk/gallery_images/thumbs/imgdxl.html mercury outboard motor part] [http://marylandcomputerguy.net/nails/image/mdngas.html spiderman 2] [http://www.athomewithmark.com/images/properties/thumb/xbvreu.html free making money online] [http://c21redwood.com/images/properties/thumbs/vwglsf.html plumbing courses] [http://maslov.com/new_releases/cache/spsmnk.html free download jet audio 6] [http://borrington.org/videos/move/hbbwam.html hardcore movies] [http://meretusa.com/links/cache/bruagq.html best casin0] [http://npgsupport.com/chat/chat/localization/icelandic/cache/fmrhae.html learning games] [http://www.usedboatdealer.com/boats/images/banners/gif/cmiaps.html porn star houston] [http://michaelboyle.biz/joomla/templates/limbocms/limbocms/images/pics/hjcrle.html interest calculation] [http://reverejournal.com/wp-content/uploads/2007/05/images/xhlhgs.html forrester] [http://c21redwood.com/images/properties/thumbs/bnlcih.html quilt patterns] [http://shopwhat.com/photo/image/bnnqba.html free dvd player] [http://adrianwindridge.co.uk/propertyimages/thumbs/gif/wqrqei.html free phone] [http://bostoncentury.com/old/coppermine/albums/userpics/10001/thumb/xjlofg.html cheap airline tickets south america] [http://meretusa.com/links/cache/ocxdlt.html free business cards] [http://www.christianspeaker.net/catalog/images/icon/uccdix.html zip code lookup] [http://www.christianspeaker.net/catalog/images/icon/tdafmx.html mobile office] [http://www.jericogt.com/design/schema/images/news/thumb/1/ltrkho.html teen hardcore] [http://aoreport.com/mag/images/stories/News05-06/5-22-06/image/qxfgpm.html companies house] [http://michaelboyle.biz/joomla/templates/limbocms/limbocms/images/pics/knpmpk.html zoog disney] [http://bostoncentury.com/old/coppermine/albums/userpics/10001/thumb/umradu.html lorazepam information] [http://borrington.org/videos/move/imcilw.html masuimi max] [http://meretusa.com/links/cache/vldfri.html payday loan no direct deposit] [http://michaelboyle.biz/joomla/templates/limbocms/limbocms/images/pics/kkhkfj.html shelby cobra] [http://naked.eskout.cn/free-milf-pictures.html free milf pictures] [http://naked.eskout.cn/male-stripper.html male stripper videos] [http://movies.eskout.cn/weight-loss.html weight loss dietary supplement] [http://porn.eskout.cn/black-women-naked.html black women naked] [http://anal.eskout.cn/medical-billing.html medical billing and coding degree] [http://fuck.eskout.cn/freeteenporn.html freeteenporn] [http://lesbian.eskout.cn/clitorous.html clitorous] [http://lesbian.eskout.cn/young-teen-lolitas.html young teen lolitas] [http://sex.eskout.cn/amature-wife.html amature wife] [http://xxx.eskout.cn/lesbian-movie.html lesbian movie] [http://teen.eskout.cn/free-illustrated.html free illustrated erotic stories] [http://anal.eskout.cn/flower-girl-gifts.html flower girl gifts] [http://hentai.eskout.cn/little-boys-nude.html little boys nude] [http://www.bush89.freehosting.net home] [http://playboy.eskout.cn/latex-fuck.html latex fuck] [http://fuck.eskout.cn/natalie-portman.html natalie portman sex] [http://anal.eskout.cn/contractor-bonding.html contractor bonding insurance] [http://teens.eskout.cn/sucking-hard.html sucking hard] [http://girls.eskout.cn/honolulu-real.html honolulu real estate sale] [http://girls.eskout.cn/maui-dinner-cruise.html maui dinner cruise] [http://lesbian.eskout.cn/office-sex.html office sex] [http://hardcore.eskout.cn/park-fly-nashville.html park fly nashville] [http://girl.eskout.cn/free-gagging-on.html free gagging on cum movies] [http://porn.eskout.cn/breast-cancer-ribbon.html breast cancer ribbon] [http://teens.eskout.cn/blue-ridge-georgia.html blue ridge georgia cabin rentals] [http://playboy.eskout.cn/gigi-domai.html gigi domai] [http://playboy.eskout.cn/australian-domain.html australian domain names] [http://porno.eskout.cn/weddings-scottsdale.html weddings scottsdale] [http://www.babiyolga84.s5.com home] [http://playboy.eskout.cn/scarlett-johansson.html scarlett johansson naked] [http://women.eskout.cn/homemade-gourmet.html homemade gourmet chocolates] [http://porn.eskout.cn/zwanger.html zwanger] [http://hentai.eskout.cn/amateur-sex-video.html amateur sex video] [http://xxx.eskout.cn/seattle-escort.html seattle escort] [http://naked.eskout.cn/mom-blowjob.html mom blowjob] [http://xxx.eskout.cn/hairless-teens.html hairless teens] [http://incest.eskout.cn/little-girl-bbs.html little girl bbs] [http://nude.eskout.cn/herbal-detox.html herbal detox] [http://www.tastysalmagundi.4t.com map] [http://naked.eskout.cn/ankh.html ankh] [http://naked.eskout.cn/mai-hoshino.html mai hoshino] [http://teens.eskout.cn/longest-yard.html longest yard soundtrack] [http://playboy.eskout.cn/ssss.html ssss] [http://naked.eskout.cn/upsk.html upsk] [http://playboy.eskout.cn/hot-teen-pics.html hot teen pics] [http://incest.eskout.cn/big-tit-toons.html big tit toons] [http://incest.eskout.cn/naked-boating.html naked boating] [http://anal.eskout.cn/spice-girls-stop.html spice girls stop] [http://hardcore.eskout.cn/wyoming-elk-hunts.html wyoming elk hunts] [http://girls.eskout.cn/boys-boxers.html boys boxers] [http://hentai.eskout.cn/xoxota.html xoxota] [http://naked.eskout.cn/option-software.html option software] [http://teens.eskout.cn/young-asians.html young asians] [http://incest.eskout.cn/pee-panties.html pee panties] [http://anal.eskout.cn/lesbain-hentai.html lesbain hentai] [http://fuck.eskout.cn/assfucked.html assfucked] [http://blondes.eskout.cn/suck-big-cock.html suck big cock] [http://www.solmarishk.00author.com page] [http://porn.eskout.cn/danni-ashe.html danni ashe] [http://hentai.eskout.cn/diamond-powders.html diamond powders grit polishing abrasive] [http://fuck.eskout.cn/nude-picture.html nude picture] [http://incest.eskout.cn/teen-slave.html teen slave] [http://personales.ciudad.com.ar/eev-07/ home] [http://hardcore.eskout.cn/lactating-nipples.html lactating nipples] [http://girl.eskout.cn/zapa.html zapa] [http://incest.eskout.cn/horse-cum.html horse cum] [http://lesbian.eskout.cn/moms-can-fuck.html moms can fuck] [http://girls.eskout.cn/forearm-workout.html forearm workout] [http://sex.eskout.cn/booby-traps.html booby traps] [http://fuck.eskout.cn/animated-hentai.html animated hentai] [http://naked.eskout.cn/sugar-hill-gang.html sugar hill gang] [http://girls.eskout.cn/nice-pussy.html nice pussy] [http://teen.eskout.cn/topless-beach.html topless beach babes] [http://blondes.eskout.cn/anel-sex.html anel sex] [http://lesbian.eskout.cn/selling-a-used-car.html selling a used car] [http://xxx.eskout.cn/hot-black-boys.html hot black boys] [http://playboy.eskout.cn/paris-hilton-sex.html paris hilton sex clips] [http://blondes.eskout.cn/black-tight-pussy.html black tight pussy] [http://girl.eskout.cn/highland-village.html highland village realty] [http://porn.eskout.cn/mj-morning-show.html mj morning show] [http://nude.eskout.cn/toddler-sex.html toddler sex] [http://anal.eskout.cn/fat-penis.html fat penis] [http://teen.eskout.cn/small-cock.html small cock] [http://nude.eskout.cn/nude-shakira.html nude shakira] [http://girls.eskout.cn/prescription.html prescription pills shopping] [http://www.mosrealt2007.bz.tc page] [http://porno.eskout.cn/erotic-nudes.html erotic nudes] [http://sex.eskout.cn/xxl-magazine.html xxl magazine] [http://girl.eskout.cn/euro-sex-parties.html euro sex parties] [http://incest.eskout.cn/zorritas.html zorritas] [http://girls.eskout.cn/unwanted-sex.html unwanted sex] [http://fuck.eskout.cn/nypd-rant.html nypd rant] [http://nude.eskout.cn/pussy-shots.html pussy shots] [http://blondes.eskout.cn/every-little.html every little thing she does is magic] [http://movies.eskout.cn/cache-creek-casino.html cache creek casino] [http://incest.eskout.cn/vancouver-map.html vancouver map] [http://girls.eskout.cn/farm-cum.html farm cum] [http://naked.eskout.cn/virginia-madsen.html virginia madsen nude] [http://naked.eskout.cn/charisma-carpenter.html charisma carpenter playboy] [http://hardcore.eskout.cn/impossible-is.html impossible is nothing] == Part 7 - Miscellaneous ==
{{TOCright}}
<p><em>Mostly internal stuff. Some good for everyone, some only for ASH wizards.</em></p>
== Chat Functions ==
{{Flink|void|chat_clan|string}}
{{Flink|void|chat_clan|string|string|desc=Sends a message to clan chat.}}
{{Flink|void|chat_macro|string|desc=Submits a chat macro to KoL.}}
{{Flink|void|chat_notify|string|string|desc=Sends a notification to the player's own chat.}}
{{Flink|void|chat_private|string|string|desc=Sends a private message to another player.}}
{{Flink|boolean|is_online|string|desc=Check to see if a player is online.}}
{{Flink|boolean [string]|who_clan|desc=Returns a list of whom is in your clan and if they are in chat.}}
{{Flink|boolean|can_faxbot|monster|desc=Check to see if a monster can be faxed.}}
{{Flink|boolean|faxbot|monster|desc=Attempts to receive a fax of a given monster.}}


<p><strong>void print( string output )</strong><br />
== Debugging Functions ==
<strong>void print( string output, string color )</strong><br />
{{Flink|void|disable|string|desc=Disables the specified function.}}
Prints <i>output</i> to the CLI buffer and displays it in the status line of the main Adventuring window.  If <i>color</i> is specified any HTML in <i>output</i> is escaped and the string is wrapped in a font tag before being printed.</p>
{{Flink|void|enable|string|desc=Enables the specified function.}}
{{Flink|buffer|load_html|string|desc=Works like visit_url(), but for debugging.}}
{{Flink|string|make_url|string|boolean|boolean|desc=Crafts the URL to visit.}}


<p><strong>boolean cli_execute( string command )</strong><br />
== File Input/Output Functions ==
Executes the given command as if it were entered into the graphical CLI window. This can be used for CLI commands or, if you
{{FunctionEmbed|buffer_to_file|format=signature|desc=yes}}
{{FunctionEmbed|file_to_array|format=signature|desc=yes}}
{{FunctionEmbed|file_to_buffer|format=signature|desc=yes}}
{{Flink|boolean|file_to_map|string|aggregate|desc=Loads a map from a tab-delimited text file.}}
{{Flink|boolean|map_to_file|aggregate|string|desc=Saves a map to a tab-delimited text file.}}
 
== gCLI Command Functions ==
{{FunctionEmbed|cli_execute|format=signature|desc=yes}}
{{FunctionEmbed|cli_execute_output|format=signature|desc=yes}}
 
== Map Management Functions ==
''Note: Information about maps (including creating, assigning, and removing keys, can be found at [[Data Structures#Maps|Map Data Structures]].''
 
{{Flink|int|count|aggregate|desc=Returns the number of defined keys for the specified aggregate.}}
{{Flink|void|clear|aggregate|desc=Removes all keys from the specified aggregate.}}
 
== Time Functions ==
{{Flink|string|format_date_time|string|string|string|desc=Reformats dates.}}
{{Flink|int|gameday_to_int|desc=Returns the current KoL date as an integer.}}
{{Flink|string|gameday_to_string|desc=Returns the current KoL date as a string.}}
{{Flink|int|gametime_to_int|desc=Returns the current KoL time in ms as an integer.}}
{{Flink|string|now_to_string|string|desc=Returns current local time/date in SimpleDateFormat format.}}
{{Flink|string|time_to_string|desc=Returns the current local time in HH:mm:ss z format.}}
{{Flink|string|today_to_string|desc=Returns the current local day in ISO format.}}
 
== SVN Functions ==
''There is much additional information in the [[SVN Primer]]''.
{{Flink|boolean|svn_exists|string|desc=Returns true if a valid working copy named projectname exists in the svn/ folder.}}
{{Flink|boolean|svn_at_head|string|desc=Returns true if projectname exists, is a valid working copy, and is currently at the same revision number as the repository.}}
{{Flink|record|svn_info|string|desc=Returns a record containing additional information about the given projectname: svnurl, last author, last revision, last change date.}}
 
== User Interaction ==
{{Flink|void|print|string|{{opt|string}}|desc=Prints to CLI and status line of Adventuring window, optionally in a specified color.}}
{{Flink|void|print_html|string|desc=Prints to CLI, parsing any included html.}}
{{Flink|void|logprint|string|desc=Prints to the session log.}}
{{Flink|void|wait|int}}
{{Flink|void|waitq|int|desc=Sleeps for the specified number of seconds.}}
{{Flink|boolean|user_confirm|string|desc=Allows user input in Y/N format.}}
 
== Property Functions ==
{{Flink|boolean [string]|get_all_properties|string|boolean|desc=Returns a map of all user or global properties.}}
{{FunctionEmbed|property_exists|format=signature|desc=yes}}
{{FunctionEmbed|property_has_default|format=signature|desc=yes}}
{{FunctionEmbed|property_default_value|format=signature|desc=yes}}
{{Flink|string|get_property|string}}
{{Flink|string|get_property|string|boolean|desc=Gets a global or user preference as appropriate.}}
{{Flink|void|set_property|string|string|desc=Sets a global or user preference as appropriate.}}
{{FunctionEmbed|remove_property|format=signature|desc=yes}}
{{FunctionEmbed|rename_property|format=signature|desc=yes}}
 
== Other Functions ==
{{FunctionEmbed|abort|format=signature|desc=yes}}
{{FunctionEmbed|all_monsters_with_id|format=signature|desc=yes}}
{{Flink|void|batch_open|desc=Used to mark the beginning of a block of functions to operate in batch mode (see page for {{f|batch_close}} for details).}}
{{Flink|boolean|batch_close|desc=Used to mark the end of a block of functions to operate in batch mode (see page for details).}}
{{Flink|int|get_revision|desc=Returns the current KoLmafia revision number.}}
{{Flink|string|get_version|desc=Returns the most recent KoLmafia version.}}
{{Flink|string|get_player_id|string|desc=Returns the user id number of a given player.}}
{{FunctionEmbed|is_dark_mode|format=signature|desc=yes}}
{{Flink|string|to_json|aggregate|desc=Converts a simple aggregate into JSON.}}
 
Additional functions that are considered not really to be ash functions are available in [[Miscellaneous ASH Features#Special Syntax Functions|Misc ASH Features]]
 
[[Category:Scripting]]

Latest revision as of 14:55, 23 December 2020

Chat Functions

void chat_clan( string )

void chat_clan( string, string )

Sends a message to clan chat.

void chat_macro( string )

Submits a chat macro to KoL.

void chat_notify( string, string )

Sends a notification to the player's own chat.

void chat_private( string, string )

Sends a private message to another player.

boolean is_online( string )

Check to see if a player is online.

boolean [string] who_clan()

Returns a list of whom is in your clan and if they are in chat.

boolean can_faxbot( monster )

Check to see if a monster can be faxed.

boolean faxbot( monster )

Attempts to receive a fax of a given monster.


Debugging Functions

void disable( string )

Disables the specified function.

void enable( string )

Enables the specified function.

buffer load_html( string )

Works like visit_url(), but for debugging.

string make_url( string, boolean, boolean )

Crafts the URL to visit.


File Input/Output Functions

boolean buffer_to_filebuffer, string )

Saves a buffer to a text file. Returns true on success, false on failure.

string [int] file_to_arraystring )

Reads data from a text file and returns a map of strings containing each line.

buffer file_to_bufferstring )

Loads the entire contents of a text file into a buffer.

boolean file_to_map( string, aggregate )

Loads a map from a tab-delimited text file.

boolean map_to_file( aggregate, string )

Saves a map to a tab-delimited text file.


gCLI Command Functions

boolean cli_executestring )

Executes a string as a gCLI command. Returns true on success, false on failure.

string cli_execute_outputstring )

Executes a gCLI command, capturing and returning the gCLI output.

Map Management Functions

Note: Information about maps (including creating, assigning, and removing keys, can be found at Map Data Structures.

int count( aggregate )

Returns the number of defined keys for the specified aggregate.

void clear( aggregate )

Removes all keys from the specified aggregate.


Time Functions

string format_date_time( string, string, string )

Reformats dates.

int gameday_to_int()

Returns the current KoL date as an integer.

string gameday_to_string()

Returns the current KoL date as a string.

int gametime_to_int()

Returns the current KoL time in ms as an integer.

string now_to_string( string )

Returns current local time/date in SimpleDateFormat format.

string time_to_string()

Returns the current local time in HH:mm:ss z format.

string today_to_string()

Returns the current local day in ISO format.


SVN Functions

There is much additional information in the SVN Primer.

boolean svn_exists( string )

Returns true if a valid working copy named projectname exists in the svn/ folder.

boolean svn_at_head( string )

Returns true if projectname exists, is a valid working copy, and is currently at the same revision number as the repository.

record svn_info( string )

Returns a record containing additional information about the given projectname: svnurl, last author, last revision, last change date.


User Interaction

void print( string, [string] )

Prints to CLI and status line of Adventuring window, optionally in a specified color.

void print_html( string )

Prints to CLI, parsing any included html.

void logprint( string )

Prints to the session log.

void wait( int )

void waitq( int )

Sleeps for the specified number of seconds.

boolean user_confirm( string )

Allows user input in Y/N format.


Property Functions

boolean [string] get_all_properties( string, boolean )

Returns a map of all user or global properties.

boolean property_existsstring, boolean? )

Checks whether a property exists.

boolean property_has_defaultstring )

Checks if a property has a built-in default value.

string property_default_valuestring )

Returns the default value of a property, or an empty string if a default value does not exist.

string get_property( string )

string get_property( string, boolean )

Gets a global or user preference as appropriate.

void set_property( string, string )

Sets a global or user preference as appropriate.

string remove_propertystring, boolean? )

Removes or resets a property and returns its previous value.

boolean rename_propertystring, string )

Renames a property. Returns true on success, false on failure.

Other Functions

void abortstring? )

Immediately halts the current script and all queued functions.

boolean [monster] all_monsters_with_id()

Returns a map of all monsters that have a non-zero monster ID.

void batch_open()

Used to mark the beginning of a block of functions to operate in batch mode (see page for batch_close() for details).

boolean batch_close()

Used to mark the end of a block of functions to operate in batch mode (see page for details).

int get_revision()

Returns the current KoLmafia revision number.

string get_version()

Returns the most recent KoLmafia version.

string get_player_id( string )

Returns the user id number of a given player.

boolean is_dark_mode()

Checks if the current KoLmafia theme is dark mode.

string to_json( aggregate )

Converts a simple aggregate into JSON.


Additional functions that are considered not really to be ash functions are available in Misc ASH Features