/usr/share/doc/sludge/SLUDGEDevKitHelp/hardScroll.html is in sludge-doc 2.2-1.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>hardScroll</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>hardScroll</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">hardScroll (<i>numberOfRows</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Scrolls the background image up and down.
</P>
<P>
If <i>numberOfRows</i> is positive, the background image scrolls up: the top <i>numberOfRows</i> lines of the image are lost, and <i>numberOfRows </i>blank lines are added to the bottom. If <i>numberOfRows</i> is negative, the background image scrolls down. If <i>numberOfRows</i> is 0 the function has no effect.
</P>
<P>
Should the value of <i>numberOfRows</i> be greater than the height of the background image (or less than 0 minus the height of the background image) the background image will be blanked completely, as if <a href="blankScreen.html">blankScreen</a> had been called.
</P>
<P>
This function is very useful for scrolling credits, but probably very little else - unless, that is, someone proves me wrong. The function is <b>not</b> for scrolling around scenes which are larger than the screen or window - try <a href="setSceneDimensions.html">setSceneDimensions</a> and <a href="aimCamera.html">aimCamera</a> instead.
</P>
<H3>Return value:</H3>
<P>
No return value.
</P>
<H3>See also:</H3>
<P>
<a href="The_Background_Image.html">The Background Image</a>
</P>
<P>
<a href="setBlankColour_(setBlankColor).html">setBlankColour (setBlankColor)</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>
|