Miscellaneous Functions: Difference between revisions
Jump to navigation
Jump to search
imported>StDoodle No edit summary |
imported>Bale Add chat functions. 'Bout time! |
||
Line 21: | Line 21: | ||
{{Flink|int|get_revision|desc=Returns the current KoLmafia revision number.}} | {{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_version|desc=Returns the most recent KoLmafia version.}} | ||
{{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_private|string|string|desc=Sends a private message to another player.}} | |||
[[Category:Scripting]] | [[Category:Scripting]] |
Revision as of 18:06, 23 January 2011
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.
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.
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_private( string, string )
Sends a private message to another player.