File: loadCustomData_and_saveCustomData.html

package info (click to toggle)
sludge 2.2.2-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,852 kB
  • sloc: cpp: 32,432; sh: 1,237; makefile: 634; xml: 284
file content (66 lines) | stat: -rwxr-xr-x 2,262 bytes parent folder | download | duplicates (7)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>loadCustomData and saveCustomData</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>loadCustomData and saveCustomData</h2>
<HR>

<H3>Syntax:</H3>

<P>
<pre class="syntax">loadCustomData (<i>filenameString</i>);</pre>
</P>

<P>
<pre class="syntax">saveCustomData (<i>thisStack</i>, <i>filenameString</i>);</pre>
</P>

<H3>Purpose:</H3>

<P>
The saveCustomData function creates a file with the name <i>filenameString</i> and stores the contents of the variable <i>thisStack</i> (which must, as you probably guessed, be a stack) in the file. The loadCustomData function loads data back from a file that has been created using saveCustomData.
</P>

<P>
Please note that you can't store custom data in <a href="ini.html">the main .ini file</a>. Use another name for your custom settings .ini file.
</P>

<P>
The method by which loadCustomData and saveCustomData treat the files they act upon and the types of data which can be stored are determined by the current custom encoding setting - see <a href="setCustomEncoding.html">setCustomEncoding</a> for details. If a game attempts to read a file with a different custom encoding setting than the one which was used when the file was created then a fatal error will occur, in order to stop others reading your custom data files unless they know the setting you used.
</P>

<H3>Return value:</H3>

<P>
The loadCustomData function returns a stack containing the data which was just loaded. The saveCustomData function does not return a value.
</P>

<H3>See also:</H3>

<P>
<a href="The_Multi-Purpose_Stack___Array___Queue_Type.html">The Multi-Purpose Stack / Array / Queue Type</a>
</P>

<P>
<a href="loadGame.html">loadGame</a>
</P>

<P>
<a href="newStack.html">newStack</a>
</P>

<P>
<a href="saveGame.html">saveGame</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>