[This is preliminary documentation and is subject to change.]
Attempts to save the map, under the specified file name using the specified format.
Namespace: fCraft.MapConversionAssembly: fCraft (in fCraft.dll) Version: 0.6.3.1 (0.6.3.1)
Syntax
Parameters
- mapToSave
- Map
Map file to be saved.
- fileName
- String
The name of the file to save to.
- format
- MapFormat
The format to use when saving the map.
Return Value
Whether or not the map save completed successfully.
Exceptions
| Exception | Condition |
|---|---|
| System..::..ArgumentNullException | If mapToSave or fileName are null. |
| System..::..ArgumentException | If format is set to MapFormat.Unknown. |
| fCraft.MapConversion..::..MapFormatException | If no converter could be found for the given format. |
| System..::..NotImplementedException | If saving to this format is not implemented or supported. |