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.
Map Management Functions
Note: Information about maps (including creating, assigning, and removing keys, can be found at Map Data Structures.
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.
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_exists( string )
boolean property_exists( string, boolean )
Returns true if the named property exists.
boolean property_has_default( string name )
Returns true if the named property in has a default value.
string property_default_value( string name )
Returns the default value for a built-in property.
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.
void remove_property( string )
void remove_property( string, boolean )
Removes property or resets it to default.
boolean rename_property( string, string )
Changes name of a property.
Other Functions
void abort( [string] )
Aborts the current script with an optional message.
boolean cli_execute( string )
Executes the given command as if it were entered into the CLI.
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.
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