/usr/share/doc/sludge/SLUDGEDevKitHelp/freeze.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>freeze</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>freeze</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">freeze ();</pre>
</P>
<H3>Purpose:</H3>
<P>
Freezes execution of the current scene so that tasks (such as loading, saving, inventories or messages) can be performed in the foreground. A new background image is created which is identical to the original background image, but with characters pasted onto it. Characters, screen regions and floors are remembered but not added to the new background image. Any functions (other than the function which ran the freeze command) are paused - unless they have been declared unfreezable.
</P>
<H3>Return value:</H3>
<P>
No return value.
</P>
<H3>Example:</H3>
<P>
<pre>sub init () {
onLeftMouse (pauseSub);
loop {
# Assuming a window size of 640 by 480, and a
# 'splat.tga' image no bigger than 40 by 40
addOverlay ('splat.tga', random (600), random (440));
pause (5);
}
}
sub pauseSub () {
freeze ();
darkBackground ();
pasteString (CENTRE, 240, "Paused!");
onLeftMouse (resumeSub);
}
sub resumeSub () {
unfreeze ();
onLeftMouse (pauseSub);
}</pre>
</P>
<H3>See also:</H3>
<P>
<a href="Unfreezable_Functions.html">Unfreezable Functions</a>
</P>
<P>
<a href="howFrozen.html">howFrozen</a>
</P>
<P>
<a href="unfreeze.html">unfreeze</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>
|