Difference between revisions of "Miscellaneous Functions"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
m
imported>StDoodle
Line 18: Line 18:
 
{{Flink|void|enable|string|desc=Enables the specified function (for debugging purposes).}}
 
{{Flink|void|enable|string|desc=Enables the specified function (for debugging purposes).}}
 
{{Flink|buffer|load_html|string|desc=Works like visit_url(), but for debugging.}}
 
{{Flink|buffer|load_html|string|desc=Works like visit_url(), but for debugging.}}
 
+
{{Flink|int|get_revision|desc=Returns the current KoLmafia revision number.}}
 +
{{Flink|string|get_version|desc=Returns the most recent KoLmafia version.}}
 
[[Category:Scripting]]
 
[[Category:Scripting]]

Revision as of 16:39, 29 July 2010

void abort( [string] )

Aborts the current script with an optional message.

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.

boolean cli_execute( string )

Executes the given command as if it were entered into the CLI.

void wait( int )

Sleeps for the specified number of seconds.

boolean user_confirm( string )

Allows user input in Y/N format.

string get_property( string )

Gets a global or user preference as appropriate.

void set_property( string, string )

Sets a global or user preference as appropriate.

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).

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.

boolean is_online( string )

Check to see if a player is online.

void disable( string )

Disables the specified function (for debugging purposes).

void enable( string )

Enables the specified function (for debugging purposes).

buffer load_html( string )

Works like visit_url(), but for debugging.

int get_revision()

Returns the current KoLmafia revision number.

string get_version()

Returns the most recent KoLmafia version.