ScummVM API documentation
ambient_audio.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_AMBIENT_AUDIO_H
23#define HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_AMBIENT_AUDIO_H
24
25#include "common/types.h"
26
27namespace Hollywood {
28
29// Scene ambient sound scheduling mode.
30enum AmbientSoundMode {
31 kAmbientSoundNone,
32 kAmbientSoundLoop,
33 kAmbientSoundRandomRange
34};
35
36// Scene ambient music scheduling mode.
37enum AmbientMusicMode {
38 kAmbientMusicNone,
39 kAmbientMusicLoopRotation,
40 kAmbientMusicRandomRange
41};
42
43// Declarative ambient cue setup used by PlayableScene each timer tick.
46 checkMillis(0),
47 soundMode(kAmbientSoundNone),
48 soundCueId(0),
49 soundFirstCueId(0),
50 soundCueCount(0),
51 soundProbabilityModulus(0),
52 soundVolumePercent(0),
53 soundCueVolumes(nullptr),
54 soundCueVolumeCount(0),
55 musicMode(kAmbientMusicNone),
56 musicStillCueId(0),
57 musicFirstCueId(0),
58 musicCueCount(0),
59 musicProbabilityModulus(0),
60 musicVolumePercent(0) {
61 }
62
63 uint32 checkMillis;
64 AmbientSoundMode soundMode;
65 byte soundCueId;
66 byte soundFirstCueId;
67 byte soundCueCount;
68 byte soundProbabilityModulus;
69 byte soundVolumePercent;
70 const byte *soundCueVolumes;
71 byte soundCueVolumeCount;
72 AmbientMusicMode musicMode;
73 byte musicStillCueId;
74 byte musicFirstCueId;
75 byte musicCueCount;
76 byte musicProbabilityModulus;
77 byte musicVolumePercent;
78};
79
80} // End of namespace Hollywood
81
82#endif
Definition: ambient_audio.h:44