GetMapSaveFlag()
Summary
Determines whether a map has changed since it was last saved to a file.
Syntax
flag = GetMapSaveFlag(string map_name)
| Argument | Contents |
|---|---|
| map_name | The name of the map, or null for the current map |
Returns
The string "True" if the map has changed and needs to be saved; the string "False" if it has not changed since it was last loaded from or saved to a file.
Notes
-
The save flag is set automatically whenever the map is changed, but the user is not prompted automatically when the map is closed. Use GetMapSaveFlag() to determine whether or not to prompt the user about saving the map.
Example
if GetMapSaveFlag() = "False" then goto ok_to_quit
// Prompt the user to save the contents before quitting...Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The specified map does not exist |
See Also
| Function | Summary |
|---|---|
| SetMapSaveFlag() | Sets the flag that indicates whether a map has changed since it was last saved to a file |
| GetLayoutSaveFlag() | Determines whether a layout has changed since it was last saved to a file |
| GetEditorSaveFlag() | Determines whether an editor has changed since it was last saved to a file |
| SaveMap() | Saves settings for a map window to a file on disk |
| OpenMap() | Open a map file and display it in a map window |