ScummVM API documentation
speech.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 AGS_ENGINE_AC_SPEECH_H
23#define AGS_ENGINE_AC_SPEECH_H
24
25#include "ags/shared/util/string.h"
26
27namespace AGS3 {
28
29enum SkipSpeechStyle {
30 kSkipSpeechNone = -1,
31 kSkipSpeechKeyMouseTime = 0,
32 kSkipSpeechKeyTime = 1,
33 kSkipSpeechTime = 2,
34 kSkipSpeechKeyMouse = 3,
35 kSkipSpeechMouseTime = 4,
36 kSkipSpeechKey = 5,
37 kSkipSpeechMouse = 6,
38
39 kSkipSpeechFirst = kSkipSpeechNone,
40 kSkipSpeechLast = kSkipSpeechMouse
41};
42
43enum SpeechMode {
44 kSpeech_TextOnly = 0,
45 kSpeech_VoiceText = 1,
46 kSpeech_VoiceOnly = 2,
47
48 kSpeech_First = kSpeech_TextOnly,
49 kSpeech_Last = kSpeech_VoiceOnly
50};
51
52int user_to_internal_skip_speech(SkipSpeechStyle userval);
53SkipSpeechStyle internal_skip_speech_to_user(int internal_val);
54// Locates and initializes a voice pack of the given *name*, tells if successful;
55// pass empty string for default voice pack.
56bool init_voicepak(const AGS::Shared::String &name = "");
57// Gets voice pack's ID name, that is a filename without "sp_" prefix and no extension.
58AGS::Shared::String get_voicepak_name();
59// Gets an asset's parent path for voice-over clips and data files
60AGS::Shared::String get_voice_assetpath();
61
62} // namespace AGS3
63
64#endif