/usr/share/doc/sludge/SLUDGEDevKitHelp/costume.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>costume</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>costume</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">costume (<i>still, [still, [still...]], walk, [walk, [walk...]], talk, [talk, [talk...]]</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Creates a costume containing an animation for standing still, talking and walking in one or more direction. Therefore the number of parameters must be a multiple of 3. Each of the parameters must be an animation created by the <a href="anim.html">anim</a> function or NULL (indicating that the animation slot will not be used - for example, a character will never be seen in a certain state while facing a certain direction).
</P>
<P>
The number of directions (let's call it n for the time being) represented by the costume is the total number of parameters divided by 3. The first n animations (or NULLs) specify how a character will look while standing still. The next n specify how the character will look while walking. The final n determine how a character will appear while talking.
</P>
<P>
In each of these three groups, the directions are specified in the same order - clockwise from facing the camera. Therefore, if the costume has 6 parameters, the costume will represent 2 different directions and the parameters will be interpreted as: standing still facing south, standing still facing north, walking south, walking north, talking facing south, talking facing north. If the costume has 12 parameters, the costume will have 4 different directions and the parameters will be interpreted as: standing still facing south, standing still facing west, standing still facing north, standing still facing east, walking south, walking west, walking north, walking east, talking facing south, talking facing west, talking facing north, talking facing east.
</P>
<P>
You can also specify an offset with <a href="setCharacterAngleOffset.html">setCharacterAngleOffset</a> to add to the calculations when selecting direction.
</P>
<H3>Return value:</H3>
<P>
The return value is the costume which has been created.
</P>
<H3>Example:</H3>
<P>
<pre># Create a costume with only one direction
var c = costume (anim ('ego.duc', 0), # STANDING STILL
anim ('ego.duc', 1, 2, 3, 4), # WALKING
anim ('ego.duc', 5, 6, 7, 8)); # TALKING
# Create a costume with 4 directions (which will never talk)
var d = costume (anim ('me.duc', 0), # STANDING STILL
anim ('me.duc', 3), # STANDING STILL
anim ('me.duc', 6), # STANDING STILL
anim ('me.duc', 9), # STANDING STILL
anim ('me.duc', 1, 2), # WALKING
anim ('me.duc', 4, 5), # WALKING
anim ('me.duc', 7, 8), # WALKING
anim ('me.duc', 10, 11), # WALKING
NULL, # TALKING
NULL, # TALKING
NULL, # TALKING
NULL); # TALKING</pre>
</P>
<H3>See also:</H3>
<P>
<a href="addCharacter.html">addCharacter</a>
</P>
<P>
<a href="setCostume.html">setCostume</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>
|