/usr/share/doc/sludge/SLUDGEDevKitHelp/setCharacterDrawMode.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 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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>setCharacterDrawMode</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>setCharacterDrawMode</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">setCharacterDrawMode (<i>thisCharacter, mode</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Changes the way in which <i>thisCharacter</i> is displayed. Possible values for <i>mode</i> are:
</P>
<P>
<b>NORMAL </b>The character is drawn at full brightness with full visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 0, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>TRANSPARENT1 </b>The character is drawn at full brightness with 75% visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 0, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 64);</b>
</P>
<P>
<b>TRANSPARENT2 </b>The character is drawn at full brightness with 50% visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 0, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 128);</b>
</P>
<P>
<b>TRANSPARENT </b>Identical to TRANSPARENT2.
</P>
<P>
<b>TRANSPARENT3 </b>The character is drawn at full brightness with 25% visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 0, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 192);</b>
</P>
<P>
<b>INVISIBLE </b>The character is not shown (note that the mouse <i>will </i>still react to it).
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 0, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 254);</b>
</P>
<P>
<b>SHADOW1 </b>The character is drawn as a silhouette with 75% visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 255, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 64);</b>
</P>
<P>
<b>SHADOW2 </b>The character is drawn at as a silhouette with 50% visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 255, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 128);</b>
</P>
<P>
<b>SHADOW </b>Identical to SHADOW2.
</P>
<P>
<b>SHADOW3 </b>The character is drawn at as a silhouette with 25% visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 255, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 192);</b>
</P>
<P>
<b>DARK1 </b>The character is drawn at 75% brightness with full visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 64, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>DARK2 </b>The character is drawn at 50% brightness with full visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 128, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>DARK </b>Identical to DARK2.
</P>
<P>
<b>DARK3 </b>The character is drawn at 25% brightness with full visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 192, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>DARK4 </b>The character is drawn as a silhouette with full visibility.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 255, 0, 0, 0);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>BLACK </b>Identical to DARK4.
</P>
<P>
<b>FOGGY1 </b>The character is drawn at 75% of its original colour, 25% medium grey.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 64, 128, 128, 128);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>FOGGY2 </b>The character is drawn at 50% of its original colour, 50% medium grey.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 128, 128, 128, 128);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>FOGGY </b>Identical to FOGGY2.
</P>
<P>
<b>FOGGY3 </b>The character is drawn at 25% of its original colour, 75% medium grey.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 192, 128, 128, 128);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>FOGGY4 </b>The character is drawn as a solid block of medium grey.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 255, 128, 128, 128);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>GREY </b>Identical to FOGGY4.
</P>
<P>
<b>GRAY </b>Identical to FOGGY4.
</P>
<P>
<b>GLOW1 </b>The character is drawn at 75% of its original colour, 25% bright white.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 64, 255, 255, 255);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>GLOW2 </b>The character is drawn at 50% of its original colour, 50% bright white.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 128, 255, 255, 255);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>GLOW </b>Identical to GLOW2.
</P>
<P>
<b>GLOW3 </b>The character is drawn at 25% of its original colour, 75% bright white.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 192, 255, 255, 255);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>GLOW4 </b>The character is drawn as a solid block of bright white.
This is equivalent to calling: <a href="setCharacterColourise.html">setCharacterColourise</a> (char, 255, 255, 255, 255);</b> and
<a href="setCharacterTransparency.html">setCharacterTransparency</a> (char, 0);</b>
</P>
<P>
<b>WHITE </b>Identical to GLOW4.
</P>
<P>
If <i>thisCharacter</i> is an object type which is not currently represented on the screen as a character, the code has no effect. If <i>thisCharacter</i> has been hidden using the <a href="hideCharacter.html">hideCharacter</a> command, the character's draw mode is changed but the character is not made visible.
</P>
<H3>Return value:</H3>
<P>
TRUE if <i>thisCharacter</i> is an object type which is currently represented on the screen as a character, otherwise FALSE (i.e. TRUE if the call to the function was a success).
</P>
<H3>See also:</H3>
<P>
<a href="Object_Types_as_Characters.html">Object Types as Characters</a>
</P>
<P>
<a href="setCharacterColourise.html">setCharacterColourise</a>
</P>
<P>
<a href="setCharacterTransparency.html">setCharacterTransparency</a>
</P>
<P>
<a href="addCharacter.html">addCharacter</a>
</P>
<P>
<a href="setCharacterExtra.html">setCharacterExtra</a>
</P>
<P>
<a href="setLightMap.html">setLightMap</a>
</P>
<P>
<a href="showCharacter.html">showCharacter</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>
|