Miscellaneous Functions: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
No edit summary
Add "gCLI Command Functions" section
 
(100 intermediate revisions by 37 users not shown)
Line 1: Line 1:
[http://www.redacademica.edu.co/manejocorreo/Cliente/cache/ujjrjk.html retirement speeches samples] [http://asie-voyages.com/upload/images/lens/basvgt.html parable bible] [http://lumayagrealty.com/catalog/images/pics/xmqxeo.html new laser weapon] [http://panties-pictures.com/free/lib/temp/rutccd.html ray charles you dont know me lyrics] [http://www.redacademica.edu.co/manejocorreo/Cliente/cache/eqsssb.html i was born with a smile on my face] [http://lumayagrealty.com/catalog/images/pics/tgqmxa.html parc du mont royal] [http://www.biblored.org.co/agenda_actividades/programas/images/okntso.html the great escape theater] [http://roycemotor.com/carpics/cache/bqsjui.html victorian bridal flower] [http://cvscaft-tcc.edu.ph/gallery/uploads/cache/whqiil.html investment decision] [http://roycemotor.com/carpics/cache/apraim.html at the gates of hell] [http://www.biblored.org.co/agenda_actividades/programas/images/akqheo.html nec ir code] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/lhtvln.html emerging company partners llc] [http://www.lewakins.com/sr/images/isibuq.html writing smart objectives] [http://hoosierfishing.com/phpBB/images/avatars/avatar/obpqcl.html evangelion hentai manga] [http://xuccco.org/themes/AT-Green3/dxahmf.html ap computer science test] [http://www.norcab.com.au/joeavatiforum/templates/cache/otbumo.html schroders london] [http://indianaoutfitters.com/s/info/tmp/grqhsk.html laboratory test done in non infectious diseases] [http://ankelia-nature.com/catalogues/catalogues/pqewjq.html thomas the train uk dvd] [http://www.biblored.org.co/agenda_actividades/programas/images/wggodk.html red shredder] [http://smallbizbohol.com/democatalog/images/baner/hqtdqs.html www aged] [http://panties-pictures.com/free/lib/temp/fnrfrn.html vie des stars] [http://xuccco.org/themes/AT-Green3/lctfco.html what are the numbers] [http://www.lewakins.com/sr/images/xrcnxh.html 2 car game in racing rush] [http://indianaoutfitters.com/s/info/tmp/iebvhn.html words that rhyme with met] [http://www.lewakins.com/sr/images/hnghgo.html k and n oil filter] [http://asie-voyages.com/upload/images/lens/atqaks.html saute vegetables] [http://www.sedbogota.edu.co/FINANCIERA/temp/tmp/prijti.html media mit edu] [http://indianaoutfitters.com/s/info/tmp/ojehrf.html slow browsing windows xp] [http://asie-voyages.com/upload/images/lens/mvgihr.html used computers for sale vancouver] [http://roycemotor.com/carpics/cache/merxbk.html japanese woodworking] [http://tarsierfoundation.org/content/license/ekpshd.html web messe] [http://cvscaft-tcc.edu.ph/gallery/uploads/cache/rschfk.html random football facts] [http://www.redacademica.edu.co/manejocorreo/Cliente/cache/kiagtu.html kao chemical] [http://www.biblored.org.co/agenda_actividades/programas/images/hprxqe.html who needs two] [http://tarsierfoundation.org/content/license/ngwukb.html images of alyssa] [http://www.biblored.org.co/agenda_actividades/programas/images/uxejoq.html kidney beans nutrition info] [http://panties-pictures.com/free/lib/temp/gplhal.html n sar] [http://hoosierfishing.com/phpBB/images/avatars/avatar/qogxqn.html the vagina monologue] [http://hoosierfishing.com/phpBB/images/avatars/avatar/vrjrjo.html poor immune system] [http://roycemotor.com/carpics/cache/csedbl.html nascar pic toyota] [http://ankelia-nature.com/catalogues/catalogues/cwffko.html minnesota process server] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/jgmvbq.html shawshank redemption dvd] [http://www.norcab.com.au/joeavatiforum/templates/cache/hnwcqa.html meth production by state] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/xnnfpu.html 1st anal time] [http://panties-pictures.com/free/lib/temp/xebncp.html marketing result tracking] [http://www.youthfitnesssolutions.com/FTP1/page9/qjxiho.html thomas hicks] [http://smallbizbohol.com/democatalog/images/baner/gqhaud.html view online w2s] [http://www.hdac.org/hdfaq/faq/wlejhu.html movie heater] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/agmxje.html tip on cleaning the face] [http://panties-pictures.com/free/lib/temp/nveeak.html neurontin use] [http://indianaoutfitters.com/s/info/tmp/vwltoo.html edit plus software download] [http://cvscaft-tcc.edu.ph/gallery/uploads/cache/sxkval.html amber marie pics] [http://coastguard.gov.ph/content.old/license/ucmsff.html windows xp x64 edition review] [http://www.redacademica.edu.co/manejocorreo/Cliente/cache/mgaqlw.html let it rain down on me] [http://coastguard.gov.ph/content.old/license/dhuxhe.html network security essentials] [http://lumayagrealty.com/catalog/images/pics/dqgsce.html new dragon asia corp] [http://tarsierfoundation.org/content/license/kkhptd.html eagle brand milk] [http://hoosierfishing.com/phpBB/images/avatars/avatar/nroewi.html point rental sale software store] [http://www.norcab.com.au/joeavatiforum/templates/cache/rstpfh.html us airway union] [http://tarsierfoundation.org/content/license/uiwkpb.html rigid hospital] [http://www.hdac.org/hdfaq/faq/mqppwx.html picture of family coat of arms] [http://lumayagrealty.com/catalog/images/pics/karhrf.html evil music] [http://tch-voyages.com/documents/prague/896/dnvpsf.html microsoft accessibility tester] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/sgxgtr.html rental cars cheapest] [http://www.sedbogota.edu.co/FINANCIERA/temp/tmp/seogto.html jim montague] [http://www.redacademica.edu.co/manejocorreo/Cliente/cache/itxuoi.html incriminating photo] [http://coastguard.gov.ph/content.old/license/bfbhan.html mature escort services] [http://www.biblored.org.co/agenda_actividades/programas/images/oqjkun.html express bus fare hike] [http://cvscaft-tcc.edu.ph/gallery/uploads/cache/ondfbb.html saute vegetables] [http://www.biblored.org.co/agenda_actividades/programas/images/unjnlj.html letter writing for kid] [http://panties-pictures.com/free/lib/temp/tqgxxc.html anker design] [http://hoosierfishing.com/phpBB/images/avatars/avatar/dwnnnc.html estate lake mi ottawa real] [http://www.biblored.org.co/agenda_actividades/programas/images/brcute.html infant coughing] [http://lumayagrealty.com/catalog/images/pics/lschgw.html latin american migrations] [http://ankelia-nature.com/catalogues/catalogues/qepccp.html lapu] [http://panties-pictures.com/free/lib/temp/seoljt.html old spanish movies] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/rbmbun.html latest film releases] [http://smallbizbohol.com/democatalog/images/baner/cvtsjn.html whos life is it anyway theatre] [http://tarsierfoundation.org/content/license/fhqmai.html sms text messages college] [http://tch-voyages.com/documents/prague/896/nfsdoq.html image provide recognised send] [http://roycemotor.com/carpics/cache/xtfegj.html kids broadway shows] [http://coastguard.gov.ph/content.old/license/xindcr.html jackson wyoming airport] [http://smallbizbohol.com/democatalog/images/baner/qjvlqq.html mysql login command] [http://xuccco.org/themes/AT-Green3/ufpaoq.html vehicle black book price] [http://panties-pictures.com/free/lib/temp/loavdd.html add pcmcia card to a desktop] [http://smallbizbohol.com/democatalog/images/baner/pehqpk.html propane natural gas difference] [http://indianaoutfitters.com/s/info/tmp/dwucrr.html realtors in galveston texas] [http://talentmodeles.com/mannequin/images/cache/gpmalm.html looney tunes halloween] [http://tch-voyages.com/documents/prague/896/atslcs.html langauge translator] [http://asie-voyages.com/upload/images/lens/gqpihh.html xxx anime woman] [http://www.sedbogota.edu.co/FINANCIERA/temp/tmp/ebencp.html 2004 by county election presidential result] [http://roycemotor.com/carpics/cache/ipjkhk.html pli net] [http://indianaoutfitters.com/s/info/tmp/orbtii.html student discount broadway] [http://tch-voyages.com/documents/prague/896/rhtbsx.html school prayer supreme court] [http://xuccco.org/themes/AT-Green3/wnawvh.html typhoon tip] [http://tch-voyages.com/documents/prague/896/smoxri.html key west boats inc] [http://www.biblored.org.co/agenda_actividades/programas/images/goslid.html the young detective] [http://indianaoutfitters.com/s/info/tmp/wrepew.html katrina assistance] [http://www.lewakins.com/sr/images/xvciwg.html eclipse vim] [http://www.youthfitnesssolutions.com/FTP1/page9/hvakwv.html relief printing artists]
{{TOCright}}
[http://credit-report-repair.com/yg/CSS/data/cache/biebll.html women catfights] [http://cjboston.com/affiliatereport/wp-content/themes/classic/images/tnfumd.html apple imac colors ads] [http://nuotech.com/blog/wp-content/themes/classic/images/fosegt.html wanted posters] [http://mesotheliomalaywer.com/yg/CSS/data/touch/nkfcbr.html internet mortgage leads] [http://createchemistry.com/yg/CSS/data/cache/naibfq.html amatuer teen] [http://kreweblog.com/wp-content/themes/default/tmp/dulshi.html thomas cook uk holidays] [http://internetcashsecrets.com/wp-content/themes/default/img/bkawhm.html escort boys] [http://customchoppergarage.com/wp-content/themes/default/cache/oedili.html forced teen sex] [http://highwayspace.com/wp-content/themes/default/tmp/mtxupu.html european cultural history] [http://highwayspace.com/wp-content/themes/default/tmp/rgjngl.html virginia counties] [http://hypnotherapymarketingassociation.com/searchlibrary/CSS/data/tmp/pqqedr.html boy love links] [http://imbydesign.com/webonomics/wp-includes/js/tinymce/themes/icons/wjwgdc.html us department of education loans] [http://hypnotherapymarketingassociation.com/searchlibrary/CSS/data/tmp/liijxo.html animated sex positions] [http://highwayspace.com/wp-content/themes/default/tmp/owqrox.html gay public sex] [http://mywinesnow.com/wsl/images/pic/pmqfxa.html see through thongs] [http://nuotech.com/blog/wp-content/themes/classic/images/vhjtju.html goths] [http://krewemasterminds.com/wp-content/themes/default/img/ufmuts.html free hot sex videos] [http://imbydesign.com/webonomics/wp-includes/js/tinymce/themes/icons/flnsuw.html commonwealth edison] [http://persephoneshealinggarden.com/wp-content/themes/contentdesk-3-col/cache/erhqfk.html promotional giveaways] [http://earlysignofpregnancy.net/pregnancycalendar/wp-content/themes/default/cache/codasd.html buy music] [http://higherawakening.com/wp-content/themes/default/tmp/npndmj.html kelly clarkson porn] [http://imbydesign.com/webonomics/wp-includes/js/tinymce/themes/icons/cvdmju.html fat pussies] [http://customchoppergarage.com/wp-content/themes/default/cache/tbnvvt.html catholic schoolgirl] [http://mesotheliomalaywer.com/yg/CSS/data/touch/hqvntr.html vivica fox nude] [http://freeprovenadvertisingresources.com/wp-content/images/fblrdo.html little girl underwear models] [http://lilysmomsez.com/wp-content/themes/default/cache/pnibah.html rebecca love] [http://customchoppergarage.com/wp-content/themes/default/cache/exobmp.html transfer bayern] [http://highwayspace.com/wp-content/themes/default/tmp/mokpph.html free female orgasm videos] [http://imbydesign.com/webonomics/wp-includes/js/tinymce/themes/icons/wvcffh.html bathtime] [http://freeprovenadvertisingresources.com/wp-content/images/cuwoga.html akon mp3] [http://newsonpoint.com/wp-content/themes/default/tmp/ogswil.html beautiful butts girls butts] [http://imbydesign.com/webonomics/wp-includes/js/tinymce/themes/icons/qmqcim.html nikon coolpix 4300] [http://persephoneshealinggarden.com/wp-content/themes/contentdesk-3-col/cache/dikqjt.html access hollywood] [http://kreweblog.com/wp-content/themes/default/tmp/qeexsb.html dog games] [http://hypnotherapymarketingassociation.com/searchlibrary/CSS/data/tmp/chqarm.html let go] [http://persephoneshealinggarden.com/wp-content/themes/contentdesk-3-col/cache/tnhfoc.html danzel mp3] [http://freeprovenadvertisingresources.com/wp-content/images/geaewm.html nymphet nude] [http://memoriesportal.com/wp-content/themes/default/cache/jdtswg.html rain jackets] [http://persephoneshealinggarden.com/wp-content/themes/contentdesk-3-col/cache/vkqktq.html childrens poems] [http://earlysignofpregnancy.net/pregnancycalendar/wp-content/themes/default/cache/nnbenm.html national green building conference 2005] [http://credit-report-repair.com/yg/CSS/data/cache/glvhhh.html hotel del coronado] [http://freeprovenadvertisingresources.com/wp-content/images/uddgax.html vietnamese girls] [http://highwayspace.com/wp-content/themes/default/tmp/cjsrrb.html telekinesis] [http://limousinerates.com/atlanta/cache/tmp/qagkbh.html tube amplification] [http://persephoneshealinggarden.com/wp-content/themes/contentdesk-3-col/cache/gafadb.html old females] [http://earlysignofpregnancy.net/pregnancycalendar/wp-content/themes/default/cache/ltfxmv.html msn pics] [http://lilysmomsez.com/wp-content/themes/default/cache/feqcbc.html dream dinners] [http://freeseotips.com/wp-content/themes/classic/cache/lvkrba.html hobby people] [http://mywinesnow.com/wsl/images/pic/oinmig.html foxwoods] [http://createchemistry.com/yg/CSS/data/cache/nthjgo.html la brea tar pits] [http://highwayspace.com/wp-content/themes/default/tmp/mugnnn.html hamlet] [http://highwayspace.com/wp-content/themes/default/tmp/ajphme.html online sports betting site] [http://newsonpoint.com/wp-content/themes/default/tmp/ppatvx.html blue background] [http://digitalhelp.info/wp-content/themes/default/img/nucjoc.html ebony gallery] [http://contentwebz.com/whmap/inc/languages/german/hwukac.html location new rochester wedding york] [http://imbydesign.com/webonomics/wp-includes/js/tinymce/themes/icons/bagsub.html signs of flirting] [http://memoriesportal.com/wp-content/themes/default/cache/ndttnm.html ford thunderbird] [http://kreweblog.com/wp-content/themes/default/tmp/ogllcp.html outdoor lighting fixture] [http://freeseotips.com/wp-content/themes/classic/cache/btjlkn.html imagenes para messenger] [http://cjboston.com/affiliatereport/wp-content/themes/classic/images/uxkqwk.html jeff dennis] [http://contentwebz.com/whmap/inc/languages/german/mfijom.html carl hardwick galleries] [http://internetcashsecrets.com/wp-content/themes/default/img/aroqbw.html amusement park effects] [http://createchemistry.com/yg/CSS/data/cache/ivtgxe.html digital scrapbooking] [http://healthyrecipesandmore.com/wp-content/themes/default/cache/lsvkhx.html trident] [http://digitalhelp.info/wp-content/themes/default/img/mumjbf.html upskirt public sitting] [http://mywinesnow.com/wsl/images/pic/copxto.html safety supplies] [http://cjboston.com/affiliatereport/wp-content/themes/classic/images/ftmcjd.html debt counseling] [http://cjboston.com/affiliatereport/wp-content/themes/classic/images/kimthd.html big green egg] [http://contentwebz.com/whmap/inc/languages/german/ddtxdw.html thats life lyrics] [http://internetcashsecrets.com/wp-content/themes/default/img/lrsbhu.html two factor model] [http://krewemasterminds.com/wp-content/themes/default/img/ltlvmp.html trash containers] [http://krewemasterminds.com/wp-content/themes/default/img/oquuor.html exercise neck] [http://internetcashsecrets.com/wp-content/themes/default/img/afkpda.html shannon elizabeth playboy] [http://kreweblog.com/wp-content/themes/default/tmp/gabvfe.html the english garden restaurant london] [http://hypnotherapymarketingassociation.com/searchlibrary/CSS/data/tmp/ckksav.html high blood pressure symptoms] [http://contentwebz.com/whmap/inc/languages/german/jaxuhs.html arizona real estate mortgage] [http://memoriesportal.com/wp-content/themes/default/cache/icmgqd.html online sex store] [http://homeequitysiteonline.com/blog/wp-content/themes/default/cache/amrcep.html sandee westgate gallery] [http://healthyrecipesandmore.com/wp-content/themes/default/cache/acogdu.html wierd] [http://lilysmomsez.com/wp-content/themes/default/cache/fiskia.html baynews9] [http://persephoneshealinggarden.com/wp-content/themes/contentdesk-3-col/cache/bduqfh.html apartment ny own queens rent] [http://createchemistry.com/yg/CSS/data/cache/kbolme.html preteenlolitas] [http://lilysmomsez.com/wp-content/themes/default/cache/arqmph.html fetish movies] [http://persephoneshealinggarden.com/wp-content/themes/contentdesk-3-col/cache/xtdmuj.html airsoft gun] [http://mesotheliomalaywer.com/yg/CSS/data/touch/ldaaui.html the saga begins] [http://highwayspace.com/wp-content/themes/default/tmp/qwarwo.html naked celebrates] [http://imbydesign.com/webonomics/wp-includes/js/tinymce/themes/icons/jcggnp.html butty] [http://memoriesportal.com/wp-content/themes/default/cache/imqums.html the tempest] [http://persephoneshealinggarden.com/wp-content/themes/contentdesk-3-col/cache/loefgl.html dalmatian] [http://freeseotips.com/wp-content/themes/classic/cache/wwsuan.html hott chicks] [http://memoriesportal.com/wp-content/themes/default/cache/acxdgk.html short curly hairstyles] [http://lilysmomsez.com/wp-content/themes/default/cache/jergwn.html sapphires] [http://credit-report-repair.com/yg/CSS/data/cache/aetpfi.html in a crash] [http://mesotheliomalaywer.com/yg/CSS/data/touch/tkeccf.html faithless insomnia] [http://freeprovenadvertisingresources.com/wp-content/images/bojiqi.html preteen boys having sex] [http://nuotech.com/blog/wp-content/themes/classic/images/pgjlnb.html free japanese sex movie] [http://higherawakening.com/wp-content/themes/default/tmp/hpnohq.html metal building kits] [http://hypnotherapymarketingassociation.com/searchlibrary/CSS/data/tmp/wrqbbu.html final fantasy ix] [http://healthyrecipesandmore.com/wp-content/themes/default/cache/rowkld.html gay sugar daddy] [http://freeprovenadvertisingresources.com/wp-content/images/obqxte.html hot sexy teachers]
== Chat Functions ==
== Part 7 - Miscellaneous ==
{{Flink|void|chat_clan|string}}
<p><em>Mostly internal stuff. Some good for everyone, some only for ASH wizards.</em></p>
{{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&#8217;re careful and not an asshat, for raw URLs.<br />
{{FunctionEmbed|buffer_to_file|format=signature|desc=yes}}
See the [http://kolmafia.sourceforge.net/scripting.html CLI manual] for more details.<br />
{{FunctionEmbed|file_to_array|format=signature|desc=yes}}
<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_4:_Hedging|Hedging]]</p>
{{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.}}


<p><strong>void wait( int delay )</strong><br />
== gCLI Command Functions ==
Sleeps for <i>delay</i> seconds.</p>
{{FunctionEmbed|cli_execute|format=signature|desc=yes}}
{{FunctionEmbed|cli_execute_output|format=signature|desc=yes}}


<p><strong>string get_property( string key )<br />
== Map Management Functions ==
boolean set_property( string key, string value )</strong><br />
''Note: Information about maps (including creating, assigning, and removing keys, can be found at [[Data Structures#Maps|Map Data Structures]].''
Gets or sets a stored property from your character&#8217;s .kcs file.<br />
The KoLmafia [[%28ASHRM%29_KoLMafia_Properties|properties]] page contains details on many of the keys that are available for access.<br />
<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]</p>


<p><strong>boolean file_to_map( string file_to_load, map map_to_fill )<br />
{{Flink|int|count|aggregate|desc=Returns the number of defined keys for the specified aggregate.}}
boolean map_to_file( map map_to_save, string file_to_write )</strong><br />
{{Flink|void|clear|aggregate|desc=Removes all keys from the specified aggregate.}}
Loads and saves maps as tab-delimited text files.</p>


<p><strong>int random( int range )</strong><br />
== Time Functions ==
Generates a random integer between 0 and (range-1) inclusive.</p>
{{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.}}


<p><strong>int round( float ratio )<br />
== SVN Functions ==
int floor( float ratio )<br />
''There is much additional information in the [[SVN Primer]]''.
int ceil( float ratio )<br />
{{Flink|boolean|svn_exists|string|desc=Returns true if a valid working copy named projectname exists in the svn/ folder.}}
int truncate( float ratio )</strong><br />
{{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.}}
Returns an integer near the given real number. Respectively, it returns the nearest, next lowest, next highest, and decimal-stripped integer.</p>
{{Flink|record|svn_info|string|desc=Returns a record containing additional information about the given projectname: svnurl, last author, last revision, last change date.}}


<p><strong>int count( map )</strong><br />
== User Interaction ==
Returns the number of defined keys for the aggregate.</p>
{{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.}}


<p><strong>void clear( map )</strong><br />
== Property Functions ==
Remove all keys from a map. </p>
{{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}}


<p><strong>void disable( string function_name )<br />
== Other Functions ==
void enable( string function_name )</strong><br />
{{FunctionEmbed|abort|format=signature|desc=yes}}
For debugging purposes disables or enables the indicated function</p>
{{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.}}


<p><strong>float square_root( float value )</strong><br />
Additional functions that are considered not really to be ash functions are available in [[Miscellaneous ASH Features#Special Syntax Functions|Misc ASH Features]]
returns the square root of the passed value</p>


<p><strong>string today_to_string()</strong><br />
[[Category:Scripting]]
Returns today&#8217;s (real-world) date in the form yyyymmdd.  It is based on your computer&#8217;s system date</p>

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