/usr/share/doc/sludge/SLUDGEDevKitHelp/addScreenRegion.html is in sludge-doc 2.1.2-3build1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>addScreenRegion</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>addScreenRegion</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">addScreenRegion (<i>thisObject, left, top, right, bottom, sX, sY, direction</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Adds a rectangular region on the screen which represents <i>thisObject</i>. The region is the rectangle from (<i>left</i>, <i>top</i>) to (<i>right</i>, <i>bottom</i>) inclusive.
</P>
<P>
If a character is told to move to <i>thisObject</i> using either of the <a href="forceCharacter.html">forceCharacter</a> or <a href="moveCharacter.html">moveCharacter</a> commands, the position at which the character should try and stand is (<i>sX</i>, <i>sY</i>). If <i>direction</i> is -1, the character will be left facing in whatever direction it was last walking. Otherwise, the character will be turned to face <i>direction</i> (which can either be an angle, in degrees, or one of the enumerations NORTH, NORTHEAST, EAST, SOUTHEAST, SOUTH, SOUTHWEST, WEST or NORTHWEST).
</P>
<P>
If characters should not move when told to walk to a certain object, set both <i>sX</i> and <i>sY</i> to 0. The value of <i>direction</i> is not used in this instance, although it must still be provided.
</P>
<H3>Return value:</H3>
<P>
No return value.
</P>
<H3>Example:</H3>
<P>
<pre>objectType poster ("poster") {
}
objectType horizon ("horizon") {
}
sub init () {
addScreenRegion (poster, 100, 100, 150, 200, 125, 250, NORTH);
addScreenRegion (horizon, 300, 150, 600, 170, 0, 0, -1);
forceCharacter (ego, poster);
# ego will now be standing at (125, 250) facing north
forceCharacter (ego, horizon);
# That command won't move the ego anywhere
}</pre>
</P>
<H3>See also:</H3>
<P>
<a href="Object_Types_and_Events.html">Object Types and Events</a>
</P>
<P>
<a href="getOverObject.html">getOverObject</a>
</P>
<P>
<a href="isScreenRegion.html">isScreenRegion</a>
</P>
<P>
<a href="onFocusChange.html">onFocusChange</a>
</P>
<P>
<a href="removeAllScreenRegions.html">removeAllScreenRegions</a>
</P>
<P class="copyright-notice">SLUDGE and this SLUDGE documentation are <A HREF="Copyright.html">copyright</A> Hungry Software and contributors 2000-2011
</P>
<HR>
</BODY>
</html>
|