Miscellaneous Functions - Revision history

Philmasterplus: Add "gCLI Command Functions" section

2020-12-23T14:55:59Z

Add "gCLI Command Functions" section

← Older revision		Revision as of 14:55, 23 December 2020
Line 23:		Line 23:
	{{Flink\|boolean\|file_to_map\|string\|aggregate\|desc=Loads a map from a tab-delimited text file.}}		{{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.}}		{{Flink\|boolean\|map_to_file\|aggregate\|string\|desc=Saves a map to a tab-delimited text file.}}

			== gCLI Command Functions ==
			{{FunctionEmbed\|cli_execute\|format=signature\|desc=yes}}
			{{FunctionEmbed\|cli_execute_output\|format=signature\|desc=yes}}

	== Map Management Functions ==		== Map Management Functions ==
Line 54:		Line 58:

	== Property Functions ==		== Property Functions ==

	{{Flink\|boolean [string]\|get_all_properties\|string\|boolean\|desc=Returns a map of all user or global properties.}}		{{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_exists\|format=signature\|desc=yes}}
Line 68:		Line 71:
	{{FunctionEmbed\|abort\|format=signature\|desc=yes}}		{{FunctionEmbed\|abort\|format=signature\|desc=yes}}
	{{FunctionEmbed\|all_monsters_with_id\|format=signature\|desc=yes}}		{{FunctionEmbed\|all_monsters_with_id\|format=signature\|desc=yes}}
	~~{{Flink\|boolean\|cli_execute\|string\|desc=Executes the given command as if it were entered into the CLI.}}~~
	{{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\|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\|boolean\|batch_close\|desc=Used to mark the end of a block of functions to operate in batch mode (see page for details).}}

Philmasterplus: /* Other Functions */ Update abort()

2020-12-23T13:35:48Z

Other Functions: Update abort()

← Older revision		Revision as of 13:35, 23 December 2020
Line 66:		Line 66:

	== Other Functions ==		== Other Functions ==
	{{~~Flink\|void~~\|abort\|~~{{opt\|string}}~~\|desc=~~Aborts the current script with an optional message.~~}}		{{FunctionEmbed\|abort\|format=signature\|desc=yes}}
	{{FunctionEmbed\|all_monsters_with_id\|format=signature\|desc=yes}}		{{FunctionEmbed\|all_monsters_with_id\|format=signature\|desc=yes}}
	{{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.}}

Philmasterplus: /* Other Functions */ Add all_monsters_with_id()

2020-12-23T11:56:37Z

Other Functions: Add all_monsters_with_id()

← Older revision		Revision as of 11:56, 23 December 2020
Line 67:		Line 67:
	== Other Functions ==		== Other Functions ==
	{{Flink\|void\|abort\|{{opt\|string}}\|desc=Aborts the current script with an optional message.}}		{{Flink\|void\|abort\|{{opt\|string}}\|desc=Aborts the current script with an optional message.}}
			{{FunctionEmbed\|all_monsters_with_id\|format=signature\|desc=yes}}
	{{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\|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\|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).}}
Line 73:		Line 74:
	{{Flink\|string\|get_version\|desc=Returns the most recent KoLmafia version.}}		{{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.}}		{{Flink\|string\|get_player_id\|string\|desc=Returns the user id number of a given player.}}
	{{FunctionEmbed\|is_dark_mode\|desc=yes}}		{{FunctionEmbed\|is_dark_mode\|format=signature\|desc=yes}}
	{{Flink\|string\|to_json\|aggregate\|desc=Converts a simple aggregate into JSON.}}		{{Flink\|string\|to_json\|aggregate\|desc=Converts a simple aggregate into JSON.}}

Philmasterplus: /* Property Functions */

2020-12-23T10:54:41Z

Property Functions

← Older revision		Revision as of 10:54, 23 December 2020
Line 57:		Line 57:
	{{Flink\|boolean [string]\|get_all_properties\|string\|boolean\|desc=Returns a map of all user or global properties.}}		{{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_exists\|format=signature\|desc=yes}}
	{{~~Flink\|boolean~~\|property_has_default\|~~string name~~\|desc=~~Returns true if the named property in has a default value.~~}}		{{FunctionEmbed\|property_has_default\|format=signature\|desc=yes}}
	{{~~Flink\|string~~\|property_default_value\|~~string name~~\|desc=~~Returns the default value for a built-in property.~~}}		{{FunctionEmbed\|property_default_value\|format=signature\|desc=yes}}
	{{Flink\|string\|get_property\|string}}		{{Flink\|string\|get_property\|string}}
	{{Flink\|string\|get_property\|string\|boolean\|desc=Gets a global or user preference as appropriate.}}		{{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.}}		{{Flink\|void\|set_property\|string\|string\|desc=Sets a global or user preference as appropriate.}}
	{{~~Flink\|string~~\|remove_property\|~~string}}~~		{{FunctionEmbed\|remove_property\|format=signature\|desc=yes}}
	~~{{Flink\|string\|remove_property\|string\|boolean~~\|desc=~~Removes property or resets it to default.~~}}		{{FunctionEmbed\|rename_property\|format=signature\|desc=yes}}
	{{~~Flink\|boolean~~\|rename_property\|~~string\|string~~\|desc=~~Changes name of a property.~~}}

	== Other Functions ==		== Other Functions ==

Philmasterplus: /* Property Functions */

2020-12-23T10:24:47Z

Property Functions

← Older revision		Revision as of 10:24, 23 December 2020
Line 56:		Line 56:

	{{Flink\|boolean [string]\|get_all_properties\|string\|boolean\|desc=Returns a map of all user or global properties.}}		{{Flink\|boolean [string]\|get_all_properties\|string\|boolean\|desc=Returns a map of all user or global properties.}}
	{{~~Flink\|boolean~~\|property_exists\|~~string}}~~		{{FunctionEmbed\|property_exists\|format=signature\|desc=yes}}
	~~{{Flink\|boolean\|property_exists\|string\|boolean~~\|desc=~~Returns true if the named property exists.~~}}
	{{Flink\|boolean\|property_has_default\|string name\|desc=Returns true if the named property in has a default value.}}		{{Flink\|boolean\|property_has_default\|string name\|desc=Returns true if the named property in has a default value.}}
	{{Flink\|string\|property_default_value\|string name\|desc=Returns the default value for a built-in property.}}		{{Flink\|string\|property_default_value\|string name\|desc=Returns the default value for a built-in property.}}

Philmasterplus: /* File Input/Output Functions */

2020-12-21T05:36:19Z

File Input/Output Functions

← Older revision		Revision as of 05:36, 21 December 2020
Line 18:		Line 18:

	== File Input/Output Functions ==		== File Input/Output Functions ==
			{{FunctionEmbed\|buffer_to_file\|format=signature\|desc=yes}}
			{{FunctionEmbed\|file_to_array\|format=signature\|desc=yes}}
			{{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\|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.}}		{{Flink\|boolean\|map_to_file\|aggregate\|string\|desc=Saves a map to a tab-delimited text file.}}
	~~{{FunctionEmbed\|file_to_array\|format=signature\|desc=yes}}~~
	~~{{FunctionEmbed\|file_to_buffer\|format=signature\|desc=yes}}~~

	== Map Management Functions ==		== Map Management Functions ==

Philmasterplus: Add "File Input/Output Functions" section

2020-12-21T05:24:41Z

Add "File Input/Output Functions" section

← Older revision		Revision as of 05:24, 21 December 2020
Line 16:		Line 16:
	{{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\|string\|make_url\|string\|boolean\|boolean\|desc=Crafts the URL to visit.}}		{{Flink\|string\|make_url\|string\|boolean\|boolean\|desc=Crafts the URL to visit.}}

			== File Input/Output Functions ==
			{{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.}}
			{{FunctionEmbed\|file_to_array\|format=signature\|desc=yes}}
			{{FunctionEmbed\|file_to_buffer\|format=signature\|desc=yes}}

	== Map Management Functions ==		== Map Management Functions ==
	''Note: Information about maps (including creating, assigning, and removing keys, can be found at [[Data Structures#Maps\|Map Data Structures]].''		''Note: Information about maps (including creating, assigning, and removing keys, can be found at [[Data Structures#Maps\|Map Data Structures]].''

	~~{{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.}}~~
	~~{{FunctionEmbed\|file_to_array\|format=signature\|desc=yes}}~~
	{{Flink\|int\|count\|aggregate\|desc=Returns the number of defined keys for the specified aggregate.}}		{{Flink\|int\|count\|aggregate\|desc=Returns the number of defined keys for the specified aggregate.}}
	{{Flink\|void\|clear\|aggregate\|desc=Removes all keys from the specified aggregate.}}		{{Flink\|void\|clear\|aggregate\|desc=Removes all keys from the specified aggregate.}}

Philmasterplus: /* Map Management Functions */

2020-12-21T05:06:47Z

Map Management Functions

← Older revision		Revision as of 05:06, 21 December 2020
Line 22:		Line 22:
	{{Flink\|boolean\|file_to_map\|string\|aggregate\|desc=Loads a map from a tab-delimited text file.}}		{{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.}}		{{Flink\|boolean\|map_to_file\|aggregate\|string\|desc=Saves a map to a tab-delimited text file.}}
			{{FunctionEmbed\|file_to_array\|format=signature\|desc=yes}}
	{{Flink\|int\|count\|aggregate\|desc=Returns the number of defined keys for the specified aggregate.}}		{{Flink\|int\|count\|aggregate\|desc=Returns the number of defined keys for the specified aggregate.}}
	{{Flink\|void\|clear\|aggregate\|desc=Removes all keys from the specified aggregate.}}		{{Flink\|void\|clear\|aggregate\|desc=Removes all keys from the specified aggregate.}}

Philmasterplus: /* Other Functions */ is_dark_mode()

2020-12-20T13:23:58Z

Other Functions: is_dark_mode()

← Older revision		Revision as of 13:23, 20 December 2020
Line 70:		Line 70:
	{{Flink\|string\|get_version\|desc=Returns the most recent KoLmafia version.}}		{{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.}}		{{Flink\|string\|get_player_id\|string\|desc=Returns the user id number of a given player.}}
			{{FunctionEmbed\|is_dark_mode\|desc=yes}}
	{{Flink\|string\|to_json\|aggregate\|desc=Converts a simple aggregate into JSON.}}		{{Flink\|string\|to_json\|aggregate\|desc=Converts a simple aggregate into JSON.}}

Fredg1: /* Property Functions */ remove_property return strings

2020-08-20T00:20:18Z

Property Functions: remove_property return strings

← Older revision		Revision as of 00:20, 20 August 2020
Line 58:		Line 58:
	{{Flink\|string\|get_property\|string\|boolean\|desc=Gets a global or user preference as appropriate.}}		{{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.}}		{{Flink\|void\|set_property\|string\|string\|desc=Sets a global or user preference as appropriate.}}
	{{Flink\|~~void~~\|remove_property\|string}}		{{Flink\|string\|remove_property\|string}}
	{{Flink\|~~void~~\|remove_property\|string\|boolean\|desc=Removes property or resets it to default.}}		{{Flink\|string\|remove_property\|string\|boolean\|desc=Removes property or resets it to default.}}
	{{Flink\|boolean\|rename_property\|string\|string\|desc=Changes name of a property.}}		{{Flink\|boolean\|rename_property\|string\|string\|desc=Changes name of a property.}}

← Older revision		Revision as of 14:55, 23 December 2020
Line 23:		Line 23:
	{{Flink\|boolean\|file_to_map\|string\|aggregate\|desc=Loads a map from a tab-delimited text file.}}		{{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.}}		{{Flink\|boolean\|map_to_file\|aggregate\|string\|desc=Saves a map to a tab-delimited text file.}}

			== gCLI Command Functions ==
			{{FunctionEmbed\|cli_execute\|format=signature\|desc=yes}}
			{{FunctionEmbed\|cli_execute_output\|format=signature\|desc=yes}}

	== Map Management Functions ==		== Map Management Functions ==
Line 54:		Line 58:

	== Property Functions ==		== Property Functions ==

	{{Flink\|boolean [string]\|get_all_properties\|string\|boolean\|desc=Returns a map of all user or global properties.}}		{{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_exists\|format=signature\|desc=yes}}
Line 68:		Line 71:
	{{FunctionEmbed\|abort\|format=signature\|desc=yes}}		{{FunctionEmbed\|abort\|format=signature\|desc=yes}}
	{{FunctionEmbed\|all_monsters_with_id\|format=signature\|desc=yes}}		{{FunctionEmbed\|all_monsters_with_id\|format=signature\|desc=yes}}
	~~{{Flink\|boolean\|cli_execute\|string\|desc=Executes the given command as if it were entered into the CLI.}}~~
	{{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\|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\|boolean\|batch_close\|desc=Used to mark the end of a block of functions to operate in batch mode (see page for details).}}

← Older revision		Revision as of 11:56, 23 December 2020
Line 67:		Line 67:
	== Other Functions ==		== Other Functions ==
	{{Flink\|void\|abort\|{{opt\|string}}\|desc=Aborts the current script with an optional message.}}		{{Flink\|void\|abort\|{{opt\|string}}\|desc=Aborts the current script with an optional message.}}
			{{FunctionEmbed\|all_monsters_with_id\|format=signature\|desc=yes}}
	{{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\|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\|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).}}
Line 73:		Line 74:
	{{Flink\|string\|get_version\|desc=Returns the most recent KoLmafia version.}}		{{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.}}		{{Flink\|string\|get_player_id\|string\|desc=Returns the user id number of a given player.}}
	{{FunctionEmbed\|is_dark_mode\|desc=yes}}		{{FunctionEmbed\|is_dark_mode\|format=signature\|desc=yes}}
	{{Flink\|string\|to_json\|aggregate\|desc=Converts a simple aggregate into JSON.}}		{{Flink\|string\|to_json\|aggregate\|desc=Converts a simple aggregate into JSON.}}

← Older revision		Revision as of 10:54, 23 December 2020
Line 57:		Line 57:
	{{Flink\|boolean [string]\|get_all_properties\|string\|boolean\|desc=Returns a map of all user or global properties.}}		{{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_exists\|format=signature\|desc=yes}}
	{{~~Flink\|boolean~~\|property_has_default\|~~string name~~\|desc=~~Returns true if the named property in has a default value.~~}}		{{FunctionEmbed\|property_has_default\|format=signature\|desc=yes}}
	{{~~Flink\|string~~\|property_default_value\|~~string name~~\|desc=~~Returns the default value for a built-in property.~~}}		{{FunctionEmbed\|property_default_value\|format=signature\|desc=yes}}
	{{Flink\|string\|get_property\|string}}		{{Flink\|string\|get_property\|string}}
	{{Flink\|string\|get_property\|string\|boolean\|desc=Gets a global or user preference as appropriate.}}		{{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.}}		{{Flink\|void\|set_property\|string\|string\|desc=Sets a global or user preference as appropriate.}}
	{{~~Flink\|string~~\|remove_property\|~~string}}~~		{{FunctionEmbed\|remove_property\|format=signature\|desc=yes}}
	~~{{Flink\|string\|remove_property\|string\|boolean~~\|desc=~~Removes property or resets it to default.~~}}		{{FunctionEmbed\|rename_property\|format=signature\|desc=yes}}
	{{~~Flink\|boolean~~\|rename_property\|~~string\|string~~\|desc=~~Changes name of a property.~~}}

	== Other Functions ==		== Other Functions ==

← Older revision		Revision as of 10:24, 23 December 2020
Line 56:		Line 56:

	{{Flink\|boolean [string]\|get_all_properties\|string\|boolean\|desc=Returns a map of all user or global properties.}}		{{Flink\|boolean [string]\|get_all_properties\|string\|boolean\|desc=Returns a map of all user or global properties.}}
	{{~~Flink\|boolean~~\|property_exists\|~~string}}~~		{{FunctionEmbed\|property_exists\|format=signature\|desc=yes}}
	~~{{Flink\|boolean\|property_exists\|string\|boolean~~\|desc=~~Returns true if the named property exists.~~}}
	{{Flink\|boolean\|property_has_default\|string name\|desc=Returns true if the named property in has a default value.}}		{{Flink\|boolean\|property_has_default\|string name\|desc=Returns true if the named property in has a default value.}}
	{{Flink\|string\|property_default_value\|string name\|desc=Returns the default value for a built-in property.}}		{{Flink\|string\|property_default_value\|string name\|desc=Returns the default value for a built-in property.}}

← Older revision		Revision as of 05:36, 21 December 2020
Line 18:		Line 18:

	== File Input/Output Functions ==		== File Input/Output Functions ==
			{{FunctionEmbed\|buffer_to_file\|format=signature\|desc=yes}}
			{{FunctionEmbed\|file_to_array\|format=signature\|desc=yes}}
			{{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\|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.}}		{{Flink\|boolean\|map_to_file\|aggregate\|string\|desc=Saves a map to a tab-delimited text file.}}
	~~{{FunctionEmbed\|file_to_array\|format=signature\|desc=yes}}~~
	~~{{FunctionEmbed\|file_to_buffer\|format=signature\|desc=yes}}~~

	== Map Management Functions ==		== Map Management Functions ==