/usr/share/doc/sludge/SLUDGEDevKitHelp/saveGame.html is in sludge-doc 2.2.1-2build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>saveGame</TITLE>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<BODY>
<HR>
<div align="center"><img id="headerGraphic" src="images/sludge300.png" alt="SLUDGE"/></div>
<h2>saveGame</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">saveGame (<i>text</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Creates a file with the name <i>text</i> which contains the current state of the
SLUDGE engine. The <i>text</I> value must be a string <b>not</b> a
<a href="File_Handling.html">file handle</a> for this command to work as expected!
The <a href="loadGame.html">loadGame</a> command can then be used to load in one
of these files to return the engine to exactly the same state.
</P>
<p>Any run-time files which your SLUDGE game uses (i.e. any custom data or saved
game files) will be created in (and loaded from) the application data folder of
the game. (Documents and Settings/username/Application Data/Game Name
on Windows, $HOME/.sludge-engine/Game Name on Linux and
~/Application Support/Game Name on Mac). See also
<a href="Project_Manager__Project_Settings_Dialog.html"></a>.</p>
<P>
Your saved game files, as well as containing all the information needed to restore
a player's progress at any time, can also (optionally) contain a thumbnail image.
The size of the image generated and saved can be set using <a href="setThumbnailSize.html">setThumbnailSize</a>.
</P>
<P>
Currently, games cannot be saved while anything is frozen (using the <a href="freeze.html">freeze</a> command).
</P>
<P>
Note that when the loadGame command is called successfully and the engine returns to its state when the file was created, execution will restart after the call to saveGame, <b>not</b> after the call to loadGame. This is because everything - including the function which called the saveGame command - is saved to the file and therefore restored when loadGame is called. You can tell whether you've just loaded or saved a game by looking at the return value.
</P>
<P>
This function supports filename bodging - for details see the <a href="bodgeFilenames.html">bodgeFilenames</a> command.
</P>
<H3>Return value:</H3>
<P>
Returns TRUE if the state of the engine was just saved. Returns FALSE if the game has just restarted at this point after a call to loadGame.
</P>
<H3>See also:</H3>
<P>
<a href="The_Worlds_Easiest_Load_Save_Mechanism.html">The World's Easiest Load/Save Mechanism</a>
</P>
<P>
<a href="deleteFile.html">deleteFile</a>
</P>
<P>
<a href="fileExists.html">fileExists</a>
</P>
<P>
<a href="getMatchingFiles.html">getMatchingFiles</a>
</P>
<P>
<a href="loadCustomData_and_saveCustomData.html">loadCustomData and saveCustomData</a>
</P>
<P>
<a href="renameFile.html">renameFile</a>
</P>
<P>
<a href="showThumbnail.html">showThumbnail</a>
</P>
<P class="copyright-notice">SLUDGE and this SLUDGE documentation are <A HREF="Copyright.html">copyright</A> Hungry Software and contributors 2000-2012
</P>
<HR>
</BODY>
</html>
|