/usr/share/doc/sludge/SLUDGEDevKitHelp/anim.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 101 102 103 104 105 106 107 108 109 110 111 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>anim</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>anim</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">anim (<i>spriteBank, frame [, frame [, frame...]]</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Creates an animation using the sprites in the <i>spriteBank</i> file. There must be at least one <i>frame</i> specified.
</P>
<P>
Each <i>frame</i> must be either a number (in which case the sprite will appear for one screen update only) or the return value from the <a href="wait.html">wait</a> function (which can be used to specify that a sprite should appear for longer than one screen update).
</P>
<P>
Valid values for numerical <i>frame</i> parameters (or the first parameter in a call to the <a href="wait.html">wait</a> function) are:
</P>
<P>
<b>Negative number outside range</b>
</P>
<P>
Horizontally flipped sprite number 0 from <i>spriteBank</i>
</P>
<P>
<b>Negative number in range</b>
</P>
<P>
Horizontally flipped sprite -<i>frame</i> from <i>spriteBank</i>
</P>
<P>
<b>Positive number in range</b>
</P>
<P>
Sprite number <i>frame</i> from <i>spriteBank</i>
</P>
<P>
<b>Positive number outside range</b>
</P>
<P>
Nothing
</P>
<P>
(The range of valid numbers is 0 to the number of sprites in <i>spriteBank</i> minus 1.)
</P>
<P>
<b>Sounds and functions</b>
</P>
<P>
Sound files and functions may also be put in the list of frames. When a sound file or function is encountered,
it is played or called, and then the animation moves to the next frame immediately. Do not put more than one
sound or function in a row: Each sound or function must be separated by a frame number (or the wait function).
</P>
<H3>Return value:</H3>
<P>
The return value is the animation which has been created. This can then be used as part of a <a href="costume.html">costume</a> or applied to a character using the <a href="animate.html">animate</a> function.
</P>
<H3>Examples:</H3>
<P>
<pre>animate (ego, anim ('egoPickUp.duc', 0, 1, 2, wait (3, 10), 2, 1));
animate (ego, anim ('egoPickUp.duc', 0, 1, 2, wait (3, 10), 'noise.ogg', 2, 1));</pre>
</P>
<H3>See also:</H3>
<P>
<a href="addCharacter.html">addCharacter</a>
</P>
<P>
<a href="setCostume.html">setCostume</a>
</P>
<P>
<a href="pause.html">pause</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>
|