Map to file - Revision history

Philmasterplus: Not the only I/O functions anymore

2020-12-21T05:51:00Z

Not the only I/O functions anymore

← Older revision		Revision as of 05:51, 21 December 2020
Line 29:		Line 29:

	function_description=Saves the data in the {{pspan\|map_to_save}} to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. The {{pspan\|compact}} parameter exists only for backwards compatibility; there is no need to use it in new code (but if you do use it, you must pass the same value to [[file_to_map\|file_to_map()]] to successfully read any records within your map). This function returns the operation's success. If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>		function_description=Saves the data in the {{pspan\|map_to_save}} to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. The {{pspan\|compact}} parameter exists only for backwards compatibility; there is no need to use it in new code (but if you do use it, you must pass the same value to [[file_to_map\|file_to_map()]] to successfully read any records within your map). This function returns the operation's success. If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>
	<p>~~As this &~~ [[file_to_map\|file_to_map()]] ~~are KoLmafia's only I~~/~~O functions, they~~ are invaluable for an ASH scripter wishing to save any script settings or information too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|
			<p>This function and <code>[[file_to_map\|file_to_map()]]</code> are invaluable for an ASH scripter wishing to save any script settings or information too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|

	code1={{CodeSample\|		code1={{CodeSample\|
Line 54:		Line 55:
	}}\|		}}\|

	see_also={{SeeAlso\|file_to_map}}\|		see_also={{SeeAlso\|buffer_to_file\|file_to_array\|file_to_buffer\|file_to_map}}\|
	}}		}}

	[[Category:Miscellaneous Functions]]		[[Category:Miscellaneous Functions]]

Bale at 05:31, 22 May 2010

2010-05-22T05:31:39Z

← Older revision		Revision as of 05:31, 22 May 2010
Line 5:		Line 5:
	FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	~~function_category=Miscellaneous\|~~

	function1={{Function\|		function1={{Function\|
Line 57:		Line 56:
	see_also={{SeeAlso\|file_to_map}}\|		see_also={{SeeAlso\|file_to_map}}\|
	}}		}}

			[[Category:Miscellaneous Functions]]

Jasonharper: Where did you come up with this stuff?

2010-03-11T04:30:39Z

Where did you come up with this stuff?

← Older revision		Revision as of 04:30, 11 March 2010
Line 23:		Line 23:
	parameter1={{Param\|aggregate\|map_to_save}}\|		parameter1={{Param\|aggregate\|map_to_save}}\|
	parameter2={{Param\|string\|file_to_save}}\|		parameter2={{Param\|string\|file_to_save}}\|
	parameter3={{Param\|boolean\|~~condition~~}}\|		parameter3={{Param\|boolean\|compact}}\|
	p1desc={{Pspan\|~~file_to_save~~}} is the ~~filename~~ to save to\|		p1desc={{Pspan\|map_to_save}} is the map to save data from\|
	p2desc={{Pspan\|~~map_to_save~~}} is the ~~map~~ to save ~~data from~~\|		p2desc={{Pspan\|file_to_save}} is the filename to save to\|
	p3desc={{Pspan\|~~condition~~}} is an (optional) ~~condition that must be met for~~ the ~~function to act~~\|		p3desc={{Pspan\|compact}} is an (optional) flag; if omitted or true, record values are written on a single line of the file when possible, rather than one field per line\|
	}}\|		}}\|

	function_description=Saves the data in the {{pspan\|map_to_save}} ~~from~~ to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. If {{pspan\|~~condition~~}} is ~~supplied~~, it must ~~evalute~~ to ~~true in order for the function~~ to ~~proceed~~. This function returns the operation's success ~~(if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true)~~. If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>		function_description=Saves the data in the {{pspan\|map_to_save}} to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. The {{pspan\|compact}} parameter exists only for backwards compatibility; there is no need to use it in new code (but if you do use it, you must pass the same value to [[file_to_map\|file_to_map()]] to successfully read any records within your map). This function returns the operation's success. If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>
	<p>As this & [[file_to_map\|file_to_map()]] are KoLmafia's only I/O functions, they are invaluable for an ASH scripter wishing to save any script settings or information too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|		<p>As this & [[file_to_map\|file_to_map()]] are KoLmafia's only I/O functions, they are invaluable for an ASH scripter wishing to save any script settings or information too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|

StDoodle at 01:51, 11 March 2010

2010-03-11T01:51:15Z

← Older revision		Revision as of 01:51, 11 March 2010
Line 39:		Line 39:
	boolean [string] answers;		boolean [string] answers;
	answers["Chocolate"] = user_confirm( "Do you like chocolate?" );		answers["Chocolate"] = user_confirm( "Do you like chocolate?" );
	answers["~~Kittens~~"] = user_confirm( "Do you like kittens?" );		answers["CuteKittens"] = user_confirm( "Do you like cute kittens?" );
	answers["~~KoL~~"] = user_confirm( "Do you like KoL?" );		answers["ThisGame"] = user_confirm( "Do you like KoL?" );
	if (map_to_file( answers , "WhatYouLike.txt" ))		if (map_to_file( answers , "WhatYouLike.txt" ))
	print( "Your answers were saved successfully." );		print( "Your answers were saved successfully." );
Line 50:		Line 50:
	<pre>		<pre>
	Chocolate false		Chocolate false
	~~Kittens~~ true		CuteKittens true
	~~KoL~~ true		ThisGame true
	</pre>		</pre>
	}}\|		}}\|

StDoodle at 01:48, 11 March 2010

2010-03-11T01:48:56Z

← Older revision		Revision as of 01:48, 11 March 2010
Line 30:		Line 30:

	function_description=Saves the data in the {{pspan\|map_to_save}} from to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. If {{pspan\|condition}} is supplied, it must evalute to true in order for the function to proceed. This function returns the operation's success (if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true). If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>		function_description=Saves the data in the {{pspan\|map_to_save}} from to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. If {{pspan\|condition}} is supplied, it must evalute to true in order for the function to proceed. This function returns the operation's success (if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true). If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>
	<p>As this & [[file_to_map\|file_to_map()]] are KoLmafia's only I/O functions, they are invaluable for an ASH scripter wishing to save any script settings or information ~~that are~~ too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|		<p>As this & [[file_to_map\|file_to_map()]] are KoLmafia's only I/O functions, they are invaluable for an ASH scripter wishing to save any script settings or information too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|

	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Sample\|		title=Code Sample\|
	description=This sample saves a simple map ~~that includes item names keyed by~~ a ~~number~~.\|		description=This sample saves a simple map of a user's responses to questions.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
	string [~~int~~] ~~my_list~~;		boolean [string] answers;
	~~file_to_map~~( "~~SavedList.txt~~" ~~, my_list~~);		answers["Chocolate"] = user_confirm( "Do you like chocolate?" );
	~~for i from 0 to~~ (~~count~~(~~my_list~~) ~~- 1~~) {		answers["Kittens"] = user_confirm( "Do you like kittens?" );
	print( "~~At index:~~ " ~~+ i +~~ " ~~We find:~~ " ~~+ my_list[i]~~ );		answers["KoL"] = user_confirm( "Do you like KoL?" );
	}		if (map_to_file( answers , "WhatYouLike.txt" ))
			print( "Your answers were saved successfully." );
			else
			print( "There was a problem saving your answers." );
	</syntaxhighlight>\|		</syntaxhighlight>\|
	moreinfo=		moreinfo=
	If the file ~~"SavedList.txt" had the following~~:		If the user answered No, Yes, Yes to the questions, they should now have a file that contains:
	<pre>		<pre>
	~~0 StDoodle~~		Chocolate false
	~~1 Grotfang~~		Kittens true
	~~</pre>~~		KoL true
	~~Then the results would be:~~
	~~<pre>~~
	~~At index: 0 We find: StDoodle~~
	~~At index: 1 We find: Grotfang~~
	</pre>		</pre>
	}}\|		}}\|

StDoodle at 01:34, 11 March 2010

2010-03-11T01:34:44Z

← Older revision		Revision as of 01:34, 11 March 2010
Line 29:		Line 29:
	}}\|		}}\|

	function_description=~~Loads~~ data to the {{pspan\|~~map_to_fill~~}} from ~~a saved~~ {{pspan\|~~file_to_load~~}} in your KoLmafia "data" directory. If {{pspan\|condition}} is supplied, it must evalute to true in order for the function to proceed. This function returns the ~~operations~~ success (if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true). If {{pspan\|~~map_to_fill~~}} ~~has not been initialized~~, this function will ~~abort~~ (as ~~oppossed~~ to ~~returning false)~~.\|		function_description=Saves the data in the {{pspan\|map_to_save}} from to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. If {{pspan\|condition}} is supplied, it must evalute to true in order for the function to proceed. This function returns the operation's success (if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true). If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>
			<p>As this & [[file_to_map\|file_to_map()]] are KoLmafia's only I/O functions, they are invaluable for an ASH scripter wishing to save any script settings or information that are too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|

	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Sample\|		title=Code Sample\|
	description=This sample ~~loads~~ a simple map that includes item names keyed by a number.\|		description=This sample saves a simple map that includes item names keyed by a number.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
Line 55:		Line 56:
	}}\|		}}\|

	see_also={{SeeAlso\|~~map_to_file\|~~}}\|		see_also={{SeeAlso\|file_to_map}}\|
	}}		}}

StDoodle at 01:24, 11 March 2010

2010-03-11T01:24:38Z

← Older revision	Revision as of 01:24, 11 March 2010
Line 1:	Line 1:
		{{
		#vardefine:name\|map_to_file}}{{
		#vardefine:return_type\|boolean}}{{

		FunctionPage\|
		name={{#var:name}}\|
		function_category=Miscellaneous\|

		function1={{Function\|
		name={{#var:name}}\|
		aggregate={{#var:aggregate}}\|
		return_type={{#var:return_type}}\|
		return_also={{#var:return_also}}\|
		parameter1={{Param\|aggregate\|map_to_save}}\|
		parameter2={{Param\|string\|file_to_save}}\|
		}}\|

		function2={{Function\|
		name={{#var:name}}\|
		aggregate={{#var:aggregate}}\|
		return_type={{#var:return_type}}\|
		return_also={{#var:return_also}}\|
		parameter1={{Param\|aggregate\|map_to_save}}\|
		parameter2={{Param\|string\|file_to_save}}\|
		parameter3={{Param\|boolean\|condition}}\|
		p1desc={{Pspan\|file_to_save}} is the filename to save to\|
		p2desc={{Pspan\|map_to_save}} is the map to save data from\|
		p3desc={{Pspan\|condition}} is an (optional) condition that must be met for the function to act\|
		}}\|

		function_description=Loads data to the {{pspan\|map_to_fill}} from a saved {{pspan\|file_to_load}} in your KoLmafia "data" directory. If {{pspan\|condition}} is supplied, it must evalute to true in order for the function to proceed. This function returns the operations success (if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true). If {{pspan\|map_to_fill}} has not been initialized, this function will abort (as oppossed to returning false).\|

		code1={{CodeSample\|
		title=Code Sample\|
		description=This sample loads a simple map that includes item names keyed by a number.\|
		code=
		<syntaxhighlight>
		string [int] my_list;
		file_to_map( "SavedList.txt" , my_list);
		for i from 0 to (count(my_list) - 1) {
		print( "At index: " + i + " We find: " + my_list[i] );
		}
		</syntaxhighlight>\|
		moreinfo=
		If the file "SavedList.txt" had the following:
		<pre>
		0 StDoodle
		1 Grotfang
		</pre>
		Then the results would be:
		<pre>
		At index: 0 We find: StDoodle
		At index: 1 We find: Grotfang
		</pre>
		}}\|

		see_also={{SeeAlso\|map_to_file\|}}\|
		}}

StDoodle: Blanked the page

2010-03-11T01:21:15Z

Blanked the page

← Older revision		Revision as of 01:21, 11 March 2010
Line 1:		Line 1:
	~~'''[[boolean]] map_to_file( [[aggregate]] map , [[string]] filename )'''~~

	~~'''[[boolean]] map_to_file( [[aggregate]] map , [[string]] filename , [[boolean]] conditions_to_save )'''~~


	Saves a map as a file, and returns a [[boolean]] of the operation's success. Additionally, map_to_file() can also host a [[boolean]] conditional, so that the saving operation will only be executed when it evaluates as true.

	When map_to_file() saves, if the specified filename does not exist, it will create a new file of that name, and store the data inside of it. If map_to_file()'s specified save filename already exists, all data inside of the file will be overwritten, and it will only contain the elements in the saved map at the time of execution. In other words, '''saving over a file will destroy the data stored within it, and replace it with the specified map (at the time of saving)'''. It is also worth note that saved map data is not directly tied to any particular map - only to its key and slice variable types.

	If map_to_file() is called from within a script, it will automatically save the resulting file in the KoLMafia\Scripts\ directory. However, if map_to_file() is called from within a library function, the resulting file will be saved in the KoLMafia\Data\ directory. For reference, file_to_map() calls load similarly.


	<p>''When saved in a file, map data takes on the form:''<pre>[key1] [key2 (if multi-key)] [...] [slice1] [slice2 (if multi-slice (a record))] [...]</pre></p>


	As map_to_file() is KoLMafia's only local (HD) I/O extension, it is an invaluable tool for the scripter; useful for everything from saving script states for resumes, data for use/analysis/backup, and even script de-bugging. However, for those wishing to use map_to_file() for the purposes of saving script states or data, the building of fail-safes against failed loads (such as regular backups), and regular re-evaluations of stored data for inaccuracies, particularly for the purpose of guarding against failed saves.


	~~<p>''(Usage Example) Generating data from a user, then calling map_to_file() in the script to save it for later:''<pre>#The "What do you like?" script, v9.23b~~

	~~#First, a declaration of the custom class (for use as the map's slices)~~
	~~record personal_preference {~~
	~~string item_name;~~
	~~boolean like_it;~~
	};

	~~#Next, we fill out the .item_name field of the map slices we're using. These will be used later as a plugin for the questions.~~

	~~personal_preference[int] likes_and_dislikes;~~
	~~likes_and_dislikes[1].item_name = "Toffee";~~
	~~likes_and_dislikes[2].item_name = "Sunshine";~~
	~~likes_and_dislikes[3].item_name = "Onions";~~
	~~likes_and_dislikes[4].item_name = "Sleep Deprivation";~~
	~~likes_and_dislikes[5].item_name = "The Kingdom of Loathing";~~

	~~#We set up a loop with a 'counter' variable, and tell it to go from "q = 1" all the way to "q = [Number of keys in the map]"~~
	~~for q from 1 upto count(likes_and_dislikes) {~~

	~~#We create a pop-up confirmation "dialogue box", which (by its KoLMafia definition) will present the user with yes/no options~~
	~~if( user_confirm( "Do you like "+likes_and_dislikes[q].item_name+"?" ) == true ) likes_and_dislikes[q].like_it = true;~~
	}

	~~print( "Survey completed successfully! We appreciate your input!" , "Green" );~~

	~~#Finally, we save the map (questions, answers, and all) to "user_preference.txt" in the KoLMafia\Scripts\ directory,~~
	~~#While enclosing it in an if() statement, so that were the save to fail, a message notifying the user of the failure will be printed~~
	~~if( map_to_file( likes_and_dislikes , "user_preference.txt" ) == false ) print( "Your completed survey failed to save." , "Red" );~~
	~~</pre></p>~~
	~~{{Format}}~~

StDoodle at 21:38, 8 March 2010

2010-03-08T21:38:30Z

← Older revision		Revision as of 21:38, 8 March 2010
Line 47:		Line 47:
	if( map_to_file( likes_and_dislikes , "user_preference.txt" ) == false ) print( "Your completed survey failed to save." , "Red" );		if( map_to_file( likes_and_dislikes , "user_preference.txt" ) == false ) print( "Your completed survey failed to save." , "Red" );
	</pre></p>		</pre></p>
			{{Format}}

StDoodle: moved Map to file() to Map to file

2010-03-02T22:26:00Z

moved Map to file() to Map to file

← Older revision	Revision as of 22:26, 2 March 2010
(No difference)

← Older revision		Revision as of 04:30, 11 March 2010
Line 23:		Line 23:
	parameter1={{Param\|aggregate\|map_to_save}}\|		parameter1={{Param\|aggregate\|map_to_save}}\|
	parameter2={{Param\|string\|file_to_save}}\|		parameter2={{Param\|string\|file_to_save}}\|
	parameter3={{Param\|boolean\|~~condition~~}}\|		parameter3={{Param\|boolean\|compact}}\|
	p1desc={{Pspan\|~~file_to_save~~}} is the ~~filename~~ to save to\|		p1desc={{Pspan\|map_to_save}} is the map to save data from\|
	p2desc={{Pspan\|~~map_to_save~~}} is the ~~map~~ to save ~~data from~~\|		p2desc={{Pspan\|file_to_save}} is the filename to save to\|
	p3desc={{Pspan\|~~condition~~}} is an (optional) ~~condition that must be met for~~ the ~~function to act~~\|		p3desc={{Pspan\|compact}} is an (optional) flag; if omitted or true, record values are written on a single line of the file when possible, rather than one field per line\|
	}}\|		}}\|

	function_description=Saves the data in the {{pspan\|map_to_save}} ~~from~~ to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. If {{pspan\|~~condition~~}} is ~~supplied~~, it must ~~evalute~~ to ~~true in order for the function~~ to ~~proceed~~. This function returns the operation's success ~~(if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true)~~. If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>		function_description=Saves the data in the {{pspan\|map_to_save}} to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. The {{pspan\|compact}} parameter exists only for backwards compatibility; there is no need to use it in new code (but if you do use it, you must pass the same value to [[file_to_map\|file_to_map()]] to successfully read any records within your map). This function returns the operation's success. If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>
	<p>As this & [[file_to_map\|file_to_map()]] are KoLmafia's only I/O functions, they are invaluable for an ASH scripter wishing to save any script settings or information too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|		<p>As this & [[file_to_map\|file_to_map()]] are KoLmafia's only I/O functions, they are invaluable for an ASH scripter wishing to save any script settings or information too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|

← Older revision		Revision as of 01:34, 11 March 2010
Line 29:		Line 29:
	}}\|		}}\|

	function_description=~~Loads~~ data to the {{pspan\|~~map_to_fill~~}} from ~~a saved~~ {{pspan\|~~file_to_load~~}} in your KoLmafia "data" directory. If {{pspan\|condition}} is supplied, it must evalute to true in order for the function to proceed. This function returns the ~~operations~~ success (if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true). If {{pspan\|~~map_to_fill~~}} ~~has not been initialized~~, this function will ~~abort~~ (as ~~oppossed~~ to ~~returning false)~~.\|		function_description=Saves the data in the {{pspan\|map_to_save}} from to the {{pspan\|file_to_save}} in your KoLmafia "data" directory. If {{pspan\|condition}} is supplied, it must evalute to true in order for the function to proceed. This function returns the operation's success (if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true). If {{pspan\|file_to_save}} already exists, this function will override (not append) the file's contents with the new data. It's also worth noting that, once saved, the data in {{pspan\|file_to_save}} is not tied to any particular map; it can be loaded into another map or slice, as long as the datatypes are compatible.</p>
			<p>As this & [[file_to_map\|file_to_map()]] are KoLmafia's only I/O functions, they are invaluable for an ASH scripter wishing to save any script settings or information that are too complex to easily fit in a user preference. However, caution should be used, as a single failed operation of this function could result in the loss of all such data. For anything difficult to re-create, or too important to lose, the script author should be careful to save backups and check for function success during such operations.\|

	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Sample\|		title=Code Sample\|
	description=This sample ~~loads~~ a simple map that includes item names keyed by a number.\|		description=This sample saves a simple map that includes item names keyed by a number.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
Line 55:		Line 56:
	}}\|		}}\|

	see_also={{SeeAlso\|~~map_to_file\|~~}}\|		see_also={{SeeAlso\|file_to_map}}\|
	}}		}}

← Older revision	Revision as of 01:24, 11 March 2010
Line 1:	Line 1:
		{{
		#vardefine:name\|map_to_file}}{{
		#vardefine:return_type\|boolean}}{{

		FunctionPage\|
		name={{#var:name}}\|
		function_category=Miscellaneous\|

		function1={{Function\|
		name={{#var:name}}\|
		aggregate={{#var:aggregate}}\|
		return_type={{#var:return_type}}\|
		return_also={{#var:return_also}}\|
		parameter1={{Param\|aggregate\|map_to_save}}\|
		parameter2={{Param\|string\|file_to_save}}\|
		}}\|

		function2={{Function\|
		name={{#var:name}}\|
		aggregate={{#var:aggregate}}\|
		return_type={{#var:return_type}}\|
		return_also={{#var:return_also}}\|
		parameter1={{Param\|aggregate\|map_to_save}}\|
		parameter2={{Param\|string\|file_to_save}}\|
		parameter3={{Param\|boolean\|condition}}\|
		p1desc={{Pspan\|file_to_save}} is the filename to save to\|
		p2desc={{Pspan\|map_to_save}} is the map to save data from\|
		p3desc={{Pspan\|condition}} is an (optional) condition that must be met for the function to act\|
		}}\|

		function_description=Loads data to the {{pspan\|map_to_fill}} from a saved {{pspan\|file_to_load}} in your KoLmafia "data" directory. If {{pspan\|condition}} is supplied, it must evalute to true in order for the function to proceed. This function returns the operations success (if {{pspan\|condition}} is supplied, and evaluates to false, this function returns true). If {{pspan\|map_to_fill}} has not been initialized, this function will abort (as oppossed to returning false).\|

		code1={{CodeSample\|
		title=Code Sample\|
		description=This sample loads a simple map that includes item names keyed by a number.\|
		code=
		<syntaxhighlight>
		string [int] my_list;
		file_to_map( "SavedList.txt" , my_list);
		for i from 0 to (count(my_list) - 1) {
		print( "At index: " + i + " We find: " + my_list[i] );
		}
		</syntaxhighlight>\|
		moreinfo=
		If the file "SavedList.txt" had the following:
		<pre>
		0 StDoodle
		1 Grotfang
		</pre>
		Then the results would be:
		<pre>
		At index: 0 We find: StDoodle
		At index: 1 We find: Grotfang
		</pre>
		}}\|

		see_also={{SeeAlso\|map_to_file\|}}\|
		}}