Miscellaneous Functions: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
No edit summary
imported>StDoodle
No edit summary
Line 4: Line 4:
{{Flink|void|logprint|string|desc=Prints to the session log.}}
{{Flink|void|logprint|string|desc=Prints to the session log.}}
{{Flink|boolean|cli_execute|string|desc=Executes the given command as if it were entered into the CLI.}}
{{Flink|boolean|cli_execute|string|desc=Executes the given command as if it were entered into the CLI.}}
{{Flink|void|wait|int|desc=Sleeps for the specified number of seconds.}}
{{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.}}
{{Flink|boolean|user_confirm|string|desc=Allows user input in Y/N format.}}
{{Flink|string|get_property|string|desc=Gets a global or user preference as appropriate.}}
{{Flink|string|get_property|string|desc=Gets a global or user preference as appropriate.}}

Revision as of 18:22, 27 November 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 )

void waitq( 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.