File: getCharacterDirection.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 (46 lines) | stat: -rwxr-xr-x 1,487 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>getCharacterDirection</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>getCharacterDirection</h2>
<HR>

<H3>Syntax:</H3>

<P>
<pre class="syntax">getCharacterDirection (thisCharacter);</pre>
</P>

<H3>Purpose:</H3>

<P>
Get the current direction faced by <i>thisCharacter</i>.
</P>

<H3>Return value:</H3>

<P>
If <i>thisCharacter</i> is represented on-screen as a character, the return value will state which of the directions specified in the character's multi-directional <a href="costume.html">costume</a> the character is facing. For example, if the character has a 4-direction costume, the return value will be 0, 1, 2 or 3 (with 0 being north) or if the character has an 8-direction costume, the return value will be 0, 1, 2, 3, 4, 5, 6 or 7 (with 0 being north). If <i>thisCharacter</i> isn't currently on-screen, the return value will be -1.
</P>

<H3>See also:</H3>

<P>
<a href="Object_Types_as_Characters.html">Object Types as Characters</a>
</P>

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