/usr/share/doc/sludge/SLUDGEDevKitHelp/Built-in

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>Built-in Constants</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>Built-in Constants</h2>
<HR>


<P>
If you know anything at all about the inner workings of a computer, you probably know this: numbers are everything. Or more to the point, everything is a number...
</P>

<P>
In SLUDGE, certain numbers have special meanings. However, the SLUDGE compiler - in a mad effort to be nice to you - lets you type in names instead of these special numbers so that your code makes more sense when you read it. Here, for your viewing pleasure, is a list of (hopefully) all the built-in constants you can use in you SLUDGE code together with what each one actually means.
</P>

<P>
Remember, you can <a href="Using_Constants_in_SLUDGE.html">define your own constants</a> too...
</P>

<H3>General constants:</H3>

<P>
These guys can be found all over the place.
</P>

<P>
<b>NULL</b> = 0
</P>

<P>
<b>FALSE</b> = 0
</P>

<P>
<b>TRUE</b> = 1
</P>

<P>
<b>NORMAL</b> = 0
</P>


<H3>Positioning constants:</H3>

<P>
Used in a few places... for example <a href="addOverlay.html">addOverlay</a>.
</P>

<P>
<b>CENTER</b> = 65535
</P>

<P>
<b>CENTRE</b> = 65535
</P>

<P>
The following values should only be used by <a href="alignStatus.html">alignStatus</a>.
</P>

<P>
<b>LEFT</b> = 999
</P>

<P>
<b>RIGHT</b> = 1001
</P>

<P>
The following constant has a special meaning if used as a parameter for <a href="parallaxAdd.html">parallaxAdd</a>.
</P>

<P>
<b>AUTOFIT</b> = 65535
</P>

<P>
<H3>Directions:</H3>

</P>

<P>
Directions in SLUDGE are measured in degrees. The following values therefore make for more readable code, for example when you're calling <a href="addCharacter.html">addCharacter</a> or <a href="turnCharacter_and_spinCharacter.html">turnCharacter</a>.
</P>

<P>
<b>NORTH</b> = 0
</P>

<P>
<b>NORTHEAST</b> = 45
</P>

<P>
<b>EAST</b> = 90
</P>

<P>
<b>SOUTHEAST</b> = 135
</P>

<P>
<b>SOUTH</b> = 180
</P>

<P>
<b>SOUTHWEST</b> = 225
</P>

<P>
<b>WEST</b> = 270
</P>

<P>
<b>NORTHWEST</b> = 315
</P>


<H3>Character draw modes:</H3>

<P>
Used by <a href="setCharacterDrawMode.html">setCharacterDrawMode</a>, curiously.
</P>

<P>
<B>TRANSPARENT3</B> = 1
</P>

<P>
<B>TRANSPARENT2</B> = 2
</P>

<P>
<B>TRANSPARENT</B> = 2
</P>

<P>
<B>TRANSPARENT1</B> = 3
</P>

<P>
<B>DARK1</B> = 4
</P>

<P>
<B>DARK2</B> = 5
</P>

<P>
<B>DARK</B> = 5
</P>

<P>
<B>DARK3</B> = 6
</P>

<P>
<B>DARK4</B> = 7
</P>

<P>
<B>BLACK</B> = 7
</P>

<P>
<B>SHADOW1</B> = 8
</P>

<P>
<B>SHADOW2</B> = 9
</P>

<P>
<B>SHADOW</B> = 9
</P>

<P>
<B>SHADOW3</B> = 10
</P>

<P>
<B>FOGGY1</B> = 11
</P>

<P>
<B>FOGGY2</B> = 12
</P>

<P>
<B>FOGGY</B> = 12
</P>

<P>
<B>FOGGY3</B> = 13
</P>

<P>
<B>FOGGY4</B> = 14
</P>

<P>
<B>GREY</B> = 14
</P>

<P>
<B>GRAY</B> = 14
</P>

<P>
<B>GLOW1</B> = 15
</P>

<P>
<B>GLOW2</B> = 16
</P>

<P>
<B>GLOW</B> = 16
</P>

<P>
<B>GLOW3</B> = 17
</P>

<P>
<B>GLOW4</B> = 18
</P>

<P>
<B>WHITE</B> = 18
</P>

<P>
<B>INVISIBLE</B> = 19
</P>


<H3>Extra character settings:</H3>

<P>
Each character can have any combination of these settings... just add them together and throw them through the <a href="setCharacterExtra.html">setCharacterExtra</a> function.
</P>

<P>
<B>FRONT</B> = 1
</P>

<P>
<B>FIXEDSIZE</B> = 2
</P>

<P>
<B>NOZBUFFER</B> = 4
</P>

<P>
<B>FIXTOSCREEN</B> = 8
</P>

<P>
<B>NOLIGHTMAP</B> = 16
</P>

<P>
<B>NOREMOVE</B> = 32
</P>

<P>
<B>RECTANGULAR</B> = 64
</P>

<P>
The following constant can be used to turn on the first 5 of the above settings in one fell swoop...
</P>

<P>
<B>ICON</B> = 31 (i.e. FRONT + FIXEDSIZE + NOZBUFFER + FIXTOSCREEN + NOLIGHTMAP)
</P>


<H3>Transition modes:</H3>

<P>
You'd never guess you used these in <a href="transitionMode_and_transitionLevel.html">transitionMode</a>, would you?
</P>

<P>
<B>FADE</B> = 0
</P>

<P>
<B>DISOLVE</B> = 1
</P>

<P>
<B>DISOLVE1</B> = 1
</P>

<P>
<B>DISOLVE2</B> = 2
</P>

<P>
<B>TVSTATIC</B> = 3
</P>

<P>
<B>BLINDS</B> = 4
</P>

<P>
<B>CROSSFADE</B> = 5
</P>

<P>
<B>SNAPSHOTFADE</B> = 5
</P>

<P>
<B>SNAPSHOTBOX</B> = 6
</P>


<H3>Speech modes:</H3>

<P>
Use these and <a href="setSpeechMode.html">setSpeechMode</a> to turn your game into a full talkie version...
</P>

<P>
<B>TEXTONLY</B> = 0
</P>

<P>
<B>SOUNDANDTEXT</B> = 1
</P>

<P>
<B>SOUNDONLY</B> = 2
</P>

<H3>Light map modes:</H3>

<P>
When you use <a href="setLightMap.html">setLightMap</a> you can also change how lightmaps are to be applied. Use the following values.
</P>

<P>
<B>HOTSPOT</B> = 0
</P>

<P>
<B>PERPIXEL</B> = 1
</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>
sludge-doc 2.2.1-2build2 / usr / share / doc / sludge / SLUDGEDevKitHelp / Built-in_Constants.html
