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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head>
<!--
---- (c) Copyright 2002-2007 by Lutz Sammer, Russell Smith
---- This program is free software; you can redistribute it and/or modify
---- it under the terms of the GNU General Public License as published by
---- the Free Software Foundation; only version 2 of the License.
----
---- This program is distributed in the hope that it will be useful,
---- but WITHOUT ANY WARRANTY; without even the implied warranty of
---- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
---- GNU General Public License for more details.
----
---- You should have received a copy of the GNU General Public License
---- along with this program; if not, write to the Free Software
---- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
---- 02111-1307, USA.
-->
<title>Bos Wars Scripting API: Icon</title>
<meta http-equiv="Content-Type" content="text/html; CHARSET=iso-8859-1">
<link rel="stylesheet" type="text/css" href="scripts.css">
</head>
<body>
<h1>Bos Wars Scripting API: Sound</h1>
<hr>
<a href="../index.html">Bos Wars</a>
<a href="../faq.html">FAQ</a>
<a href="savegame.html">PREV</a>
<a href="triggers.html">NEXT</a>
<a href="index.html">LUA Index</a>
<hr>
<a href="#DefineGameSounds">DefineGameSounds</a>
<a href="#GetEffectsVolume">GetEffectsVolume</a>
<a href="#GetMusicVolume">GetMusicVolume</a>
<a href="#IsEffectsEnabled">IsEffectsEnabled</a>
<a href="#IsMusicEnabled">IsMusicEnabled</a>
<a href="#MakeSound">MakeSound</a>
<a href="#MakeSoundGroup">MakeSoundGroup</a>
<a href="#MapSound">MapSound</a>
<a href="#PlayFile">PlayFile</a>
<a href="#PlayMusic">PlayMusic</a>
<a href="#PlaySound">PlaySound</a>
<a href="#PlaySoundFile">PlaySoundFile</a>
<a href="#SetChannelStereo">SetChannelStereo</a>
<a href="#SetChannelVolume">SetChannelVolume</a>
<a href="#SetEffectsEnabled">SetEffectsEnabled</a>
<a href="#SetEffectsVolume">SetEffectsVolume</a>
<a href="#SetGlobalSoundRange">SetGlobalSoundRange</a>
<a href="#SetMusicEnabled">SetMusicEnabled</a>
<a href="#SetMusicVolume">SetMusicVolume</a>
<a href="#SetSoundRange">SetSoundRange</a>
<a href="#SoundForName">SoundForName</a>
<a href="#StopAllChannels">StopAllChannels</a>
<a href="#StopChannel">StopChannel</a>
<a href="#StopMusic">StopMusic</a>
<hr>
<h2>Intro - Introduction to sound functions and variables</h2>
<p>Everything around sound.</p>
<h2>Functions</h2>
<a name="DefineGameSounds"></a>
<h3>DefineGameSounds("name", arg, [[name2, arg] ...])</h3>
<p>Specify some global sounds.</p>
<dl>
<dt>"name", arg</dt>
<dd>One of the following:
<ul>
<li>"click", SoundId</li>
<li>"placement-error", SoundId</li>
<li>"placement-success", SoundId</li>
<li>"rescue", SoundId</li>
</ul>
Where Soundid is the sound to use</dd>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Define sounds used by game
--
DefineGameSounds(
"placement-error", MakeSound("placement error", "ui/placement_error.wav"),
"placement-success", MakeSound("placement success", "ui/placement_success.wav"),
"click", sound_click, -- sound_click already define as SoundId
-- FIXME: Not ready
-- "transport-docking",
-- "building-construction",
"rescue", MakeSound("human rescue", "human/rescue.wav"),
</pre>
<a name="MakeSound"></a>
<h3>MakeSound("name", "file" or {"file1", "file2", ...})</h3>
<p>Asks the sound system to register a sound under a given name, with an
associated list of files (the list can be replaced by only one file).</p>
<dl>
<dt>name</dt>
<dd>Name of the sound.</dd>
<dt>file</dt>
<dd>Name of the file or a list of files.</dd>
<dt><I>RETURNS</I></dt>
<dd>A SoundId object that represents the registered sound.</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Makes the sounds "lightning" and "basic human voices acknowledge".
MakeSound("lightning", "spells/lightning.wav")
MakeSound("basic human voices acknowledge",
{"human/basic_voices/acknowledgement/1.wav",
"human/basic_voices/acknowledgement/2.wav",
"human/basic_voices/acknowledgement/3.wav",
"human/basic_voices/acknowledgement/4.wav"})
</pre>
<a name="MakeSoundGroup"></a>
<h3>MakeSoundGroup("name", "groupname1" or SoundId, "groupname2" or SoundId)</h3>
<p>Asks the sound system to build a special sound group.</p>
<dl>
<dt>name</dt>
<dd>Name of the sound.</dd>
<dt>group1</dt>
<dd>SoundId or string</dd>
<dt>group2</dt>
<dd>SoundId or string</dd>
<dt><I>RETURNS</I></dt>
<dd>A SoundId object that represents the sound group.</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Define selection sound groups.
MakeSoundGroup("footman-selected",
"basic human voices selected", "basic human voices annoyed")
</pre>
<a name="MapSound"></a>
<h3>MapSound("name", "sound")</h3>
<p>Asks the sound system to remap a sound id to a given name.</p>
<dl>
<dt>name</dt>
<dd>Name of the sound.</dd>
<dt>sound</dt>
<dd>Sound to map to: either a sound name (a string) or a SoundId.</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Maps the name "footman-acknowledge" to "basic human voices acknowledge".
MapSound("footman-acknowledge", "basic human voices acknowledge")
</pre>
<a name="PlaySoundFile"></a>
<h3>PlaySoundFile("name" [, callback])</h3>
<p>Plays a sound file.</p>
<dl>
<dt>name</dt>
<dd>Name of the file to play.</dd>
<dt>callback</dt>
<dd>An optional Lua function that the engine will call when the sound
finishes playing.</dd>
<dt><I>RETURNS</I></dt>
<dd>The channel number allocated for the sound, or -1 if no channels
are available. The Lua script can pass this number to various
"Channel" functions to control the sound as it plays.</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Play the file "spells/lightning.wav", with no callback.
PlaySoundFile("spells/lightning.wav")
</pre>
<a name="PlayFile"></a>
<h3>PlayFile("name" [, callback])</h3>
<p>Like <a href="#PlaySoundFile">PlaySoundFile</a>,
except the callback must be a LuaActionListener object.
Lua scripts should use PlaySoundFile instead.</p>
<a name="PlayMusic"></a>
<h3>PlayMusic("filename")</h3>
<p>Plays music from the specified file.</p>
<dl>
<dt>name</dt>
<dd>Name of the music file.</dd>
<dt><I>RETURNS</I></dt>
<dd>0 if it started playing music from the file.
-1 if music is disabled or an error occurred.</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Plays the music file "music/default.ogg".
PlayMusic("music/default.ogg")
</pre>
<a name="PlaySound"></a>
<h3>PlaySound("name")</h3>
<p>Asks the sound system to play the specified sound.</p>
<dl>
<dt>"name"</dt>
<dd>Name of the sound to play.</dd>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Play the sound "basic human voices ready".
PlaySound("basic human voices ready")
</pre>
<a name="SetGlobalSoundRange"></a>
<h3>SetGlobalSoundRange(distance)</h3>
<p>Sets the cut off distance.</p>
<dl>
<dt>distance</dt>
<dd>Max tile distance to hear sounds.</dd>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Set the sound range to 40.
SetGlobalSoundRange(40)
</pre>
<a name="SetMusicVolume"></a>
<h3>SetMusicVolume(volume)</h3>
<p>Sets the music volume.
<a href="#GetMusicVolume">GetMusicVolume</a> reads this setting back.</p>
<dl>
<dt>volume</dt>
<dd>Number between 0 and MaxVolume.</dd>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Set the music volume to 128.
SetMusicVolume(128)
</pre>
<a name="GetMusicVolume"></a>
<h3>GetMusicVolume()</h3>
<p>Gets the music volume.
<a href="#SetMusicVolume">SetMusicVolume</a> changes this setting.</p>
<dl>
<dt><I>RETURNS</I></dt>
<dd>Number between 0 and MaxVolume.</dd>
</dl>
<a name="SetSoundRange"></a>
<h3>SetSoundRange("name", distance)</h3>
<p>Sets the range of a given sound.</p>
<dl>
<dt>name</dt>
<dd>Name or SoundId of the sound.</dd>
<dt>distance</dt>
<dd>Max tile distance to hear the sound.</dd>
<dt><I>RETURNS</I></dt>
<dd>The name or SoundId given as the first parameter.</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Set the range of the sound "basic human voices ready" to 20.
SetSoundRange("basic human voices ready", 20)
</pre>
<a name="SetEffectsVolume"></a>
<h3>SetEffectsVolume(volume)</h3>
<p>Sets the volume of sound effects.
<a href="#GetEffectsVolume">GetEffectsVolume</a> reads this setting back.</p>
<dl>
<dt>volume</dt>
<dd>Number between 0 and MaxVolume.</dd>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Set the sound volume to 128.
SetEffectsVolume(128)
</pre>
<a name="GetEffectsVolume"></a>
<h3>GetEffectsVolume()</h3>
<p>Gets the volume of sound effects.
<a href="#SetEffectsVolume">SetEffectsVolume</a> changes this setting.</p>
<dl>
<dt><I>RETURNS</I></dt>
<dd>Number between 0 and MaxVolume.</dd>
</dl>
<a name="SoundForName"></a>
<h3>SoundForName("name")</h3>
<p>Asks the sound system to associate a sound id to a sound name.</p>
<dl>
<dt>name</dt>
<dd>Name of the sound.</dd>
<dt><I>RETURNS</I></dt>
<dd>SoundId</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
SoundForName("peasant attack")
</pre>
<a name="SetEffectsEnabled"></a>
<h3>SetEffectsEnabled(enabled)</h3>
<p>Turns sound effects on or off.
<a href="#IsEffectsEnabled">IsEffectsEnabled</a> reads this setting back.</p>
<dl>
<dt>enabled</dt>
<dd>true or false.</dd>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Turns on sound effects.
SetEffectsEnabled(true)
</pre>
<a name="IsEffectsEnabled"></a>
<h3>IsEffectsEnabled()</h3>
<p>Checks whether sound effects are enabled.
<a href="#SetEffectsEnabled">SetEffectsEnabled</a> changes this setting.</p>
<dl>
<dt><I>RETURNS</I></dt>
<dd>true or false</dd>
</dl>
<a name="SetMusicEnabled"></a>
<h3>SetMusicEnabled(enabled)</h3>
<p>Turns music on or off.
When music has been disabled with SetMusicEnabled(false),
<a href="#PlayMusic">PlayMusic</a> does nothing.
<a href="#IsMusicEnabled">IsMusicEnabled</a> reads this setting back.</p>
<dl>
<dt>enabled</dt>
<dd>true or false.</dd>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Turns on music.
SetMusicEnabled(true)
</pre>
<a name="IsMusicEnabled"></a>
<h3>IsMusicEnabled()</h3>
<p>Checks whether music is enabled.
<a href="#SetMusicEnabled">SetMusicEnabled</a> changes this setting.</p>
<dl>
<dt><I>RETURNS</I></dt>
<dd>true or false</dd>
</dl>
<a name="StopMusic"></a>
<h3>StopMusic()</h3>
<p>Stops playing music.
Unlike <a href="#SetMusicEnabled">SetMusicEnabled</a>(false), this
does not prevent <a href="#PlayMusic">PlayMusic</a> from starting
music again.</p>
<dl>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<h4>Example</h4>
<pre class="lua">
-- Stop playing music.
StopMusic()
</pre>
<a name="SetChannelVolume"></a>
<h3>SetChannelVolume(channel, volume)</h3>
<p>Sets the sound volume of the channel.</p>
<dl>
<dt>channel</dt>
<dd>Channel number returned by <a href="#PlaySoundFile">PlaySoundFile</a>.</dd>
<dt>volume</dt>
<dd>The new sound volume of the channel.
Should be between 0 and MaxVolume.
If this parameter is negative, then SetChannelVolume
does not change the volume.
If this parameter is too large, then SetChannelVolume
uses MaxVolume instead.
<dt><I>RETURNS</I></dt>
<dd>The resulting sound volume of the channel,
or -1 if the channel number is out of range.</dd>
</dl>
<a name="SetChannelStereo"></a>
<h3>SetChannelStereo(channel, stereo)</h3>
<p>Sets the panning of the channel between the left and right outputs.</p>
<dl>
<dt>channel</dt>
<dd>Channel number returned by <a href="#PlaySoundFile">PlaySoundFile</a>.</dd>
<dt>stereo</dt>
<dd>The new panning position of the channel.
-128 means left, 0 means center, and 127 means right.
<dt><I>RETURNS</I></dt>
<dd>The resulting panning position of the channel,
or -1 if the channel number is out of range.</dd>
</dl>
<a name="StopChannel"></a>
<h3>StopChannel(channel)</h3>
<p>Stops the sound playing in the specified channel.</p>
<dl>
<dt>channel</dt>
<dd>Channel number returned by <a href="#PlaySoundFile">PlaySoundFile</a>.</dd>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<a name="StopAllChannels"></a>
<h3>StopAllChannels()</h3>
<p>Stops all sound effects currently playing.
Calls their callback functions, if any.
Does not stop music.</p>
<dl>
<dt><I>RETURNS</I></dt>
<dd>Nothing</dd>
</dl>
<hr>
All trademarks and copyrights on this page are owned by their respective owners.
<address>(c) 2002-2007 by <a href="http://boswars.org">
The Bos Wars Project</a></address></body></html>
|
