/usr/share/doc/sludge/SLUDGEDevKitHelp/bodgeFilenames.html is in sludge-doc 2.2.1-1build2.
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 96 97 98 99 100 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>bodgeFilenames</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>bodgeFilenames</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">bodgeFilenames (<I>enable</I>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Turns on and off the fantastic SLUDGE filename bodging feature. The feature affects the following functions:
</P>
<P>
<a href="loadCustomData_and_saveCustomData.html">loadCustomData and saveCustomData</a>
</P>
<P>
<a href="launch_and_launchWith.html">launch</a>
</P>
<P>
<a href="loadGame.html">loadGame</a>
</P>
<P>
<a href="saveGame.html">saveGame</a>
</P>
<P>
<a href="showThumbnail.html">showThumbnail</a>
</P>
<P>
<a href="deleteFile.html">deleteFile</a>
</P>
<P>
<a href="renameFile.html">renameFile</a>
</P>
<P>
<a href="getMatchingFiles.html">getMatchingFiles</a>
</P>
<P>
<a href="fileExists.html">fileExists</a>
</P>
<P>
The <I>enable</I> value turns filename bodging on and off. With filename bodging disabled - as it is desabled by default - the above functions work as expected, and the parameters they take (and return, in some cases) have to be nice, normal filenames. That means the characters / and \ mean a file is in another folder, the character : means a file is on another drive and certain symbols like ? and * are just plain disallowed.
</P>
<P>
With filename bodging enabled, however, these special characters are all allowed in filenames. This makes it possible for people playing your game to save their games with names like 'Where am I?' and '5: In the jungle' and 'Oh ****' and even names containing multiple odd characters like '8: "776010"? Is this good/bad?'.
</P>
<P>
The way the system works is to change each illegal or special character into a code before operating on the file (or in the case of <a href="getMatchingFiles.html">getMatchingFiles</a> change each code back into the character it represents, so that in a list of saved games each file is listed with its original name).
</P>
<P>
You may have to enable filename bodging in certain parts of your game (for example, letting your player load and save) and disable it in others (for example if you're going to <a href="launch_and_launchWith.html">launch</a> a URL, or a help file in a different directory).
</P>
<H3>Return value:</H3>
<P>
The return value is the previous status of the filename bodging option - i.e. if filename bodging was previously enabled the return value is TRUE, otherwise it's FALSE. Hence, the following code will turn off filename bodging, launch a file and then put filename bodging back to whatever state it was in before:
</P>
<P>
<pre>var old_on_or_off = bodgeFilenames (FALSE);
launch ("manual\\welcome.html");
bodgeFilenames (old_on_or_off);</pre>
</P>
<H3>See also:</H3>
<P>
<a href="File_Handling.html">File Handling</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>
|