File: transitionMode_and_transitionLevel.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 (113 lines) | stat: -rwxr-xr-x 2,737 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
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>transitionMode and transitionLevel</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>transitionMode and transitionLevel</h2>
<HR>


<H3>Syntax:</H3>

<P>
<pre class="syntax">transitionMode (<i>mode</i>);</pre>
</P>

<P>
<pre class="syntax">transitionLevel (<i>level</i>);</pre>
</P>

<H3>Purpose:</H3>

<P>
The transitionMode function chooses which transition type is used by the game. Valid values for <i>mode</i> are:
</P>

<P>
<b>FADE   </b>Every pixel's brightness is faded to / from black.
</P>

<P>
<b>DISOLVE   </b>A fixed selection of pixels is coloured over in black.
</P>

<P>
<b>DISOLVE1   </b>The same as DISOLVE.
</P>

<P>
<b>DISOLVE2   </b>A random selection of pixels is coloured over in black.
</P>

<P>
<b>TVSTATIC   </b>A random selection of pixels is coloured over in random greys.
</P>

<P>
<b>BLINDS   </b>The screen is divided into horizontal slices which open like blinds.
</P>

<P>
<b>SNAPSHOTFADE   </b>The screen is faded to / from the current snapshot. *
</P>

<P>
<b>CROSSFADE   </b>The same as SNAPSHOTFADE.
</P>

<P>
<b>SNAPSHOTBOX   </b>The screen appears in an expanding rectangle over the current snapshot. *
</P>

<P>
The transitionLevel function specifies how visible the current screen is, from 0 to 256 inclusive. A <i>level</i> value of 0 means the scene is not visible at all (normally pitch black). A <i>level</i> value of 256 means the scene is completely visible and not affected by the current transition mode at all.
</P>

<P>
Note that the mouse cursor is <i>not</i> affected by transitions. All other elements - including speech, characters and status text - are affected.
</P>

<P>
 * = See <a href="snapshotGrab.html">snapshotGrab</a> for more information. This transition mode has no effect if there is currently no snapshot in memory.
</P>

<H3>Example:</H3>

<P>
<pre># Choose which mode we want to use
transitionMode (DISOLVE2);

# Fade up
for (var a = 0; a &lt; 255; a += 10) {
   transitionLevel (a);
   pause (1);
}
transitionLevel (256);

# Wait a while
pause (100);

# Fade down
for (var a = 255; a &gt; 0; a -= 10) {
   transitionLevel (a);
   pause (1);
}
transitionLevel (0);</pre>
</P>

<H3>Return value:</H3>

<P>
No return value.
</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>