Difference between revisions of "Map to file"
imported>StDoodle |
imported>StDoodle m |
||
| Line 29: | Line 29: | ||
}}| | }}| | ||
| − | function_description= | + | 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 | + | 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| | + | see_also={{SeeAlso|file_to_map}}| |
}} | }} | ||
Revision as of 01:34, 11 March 2010
Function Syntax
boolean map_to_file(aggregate map_to_save ,string file_to_save )
boolean map_to_file(aggregate map_to_save ,string file_to_save ,boolean condition )
- file_to_save is the filename to save to
- map_to_save is the map to save data from
- condition is an (optional) condition that must be met for the function to act
Saves the data in the map_to_save from to the file_to_save in your KoLmafia "data" directory. If condition is supplied, it must evalute to true in order for the function to proceed. This function returns the operation's success (if condition is supplied, and evaluates to false, this function returns true). If 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 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.
As this & 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.
Code Sample
This sample saves a simple map that includes item names keyed by a number.
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] );
}If the file "SavedList.txt" had the following:
0 StDoodle 1 Grotfang
Then the results would be:
At index: 0 We find: StDoodle At index: 1 We find: Grotfang
See Also