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 STARK_RESOURCES_SPEECH_H
23 #define STARK_RESOURCES_SPEECH_H
24 
25 #include "common/str.h"
26 
27 #include "engines/stark/resources/object.h"
28 
29 namespace Stark {
30 
31 namespace Formats {
32 class XRCReadStream;
33 }
34 
35 namespace Resources {
36 
37 class ItemVisual;
38 class LipSync;
39 class Sound;
40 
48 class Speech : public Object {
49 public:
50  static const Type::ResourceType TYPE = Type::kSpeech;
51 
52  Speech(Object *parent, byte subType, uint16 index, const Common::String &name);
53  virtual ~Speech();
54 
55  // Resource API
56  void readData(Formats::XRCReadStream *stream) override;
57  void onGameLoop() override;
58  void onExitLocation() override;
59  void onPreDestroy() override;
60  void saveLoadCurrent(ResourceSerializer *serializer) override;
61 
63  Common::String getPhrase() const;
64 
66  void playSound();
67 
69  bool isPlaying();
70 
72  void stop();
73 
75  bool characterIsApril() const;
76 
78  void setPlayTalkAnim(bool playTalkAnim);
79 
81  int32 getCharacterId();
82 
83 protected:
84  void printData() override;
85 
86  void setCharacterTalkAnim();
87  void removeCharacterTalkAnim() const;
88  ItemVisual *getCharacterItem() const;
89  void stopOtherSpeechesFromSameCharacter();
90 
91  int32 getPauseAfterSpeechDuration() const;
92 
93  Common::String _phrase;
94  int32 _character;
95  bool _playTalkAnim;
96  bool _removeTalkAnimWhenComplete;
97 
98  Sound *_soundResource;
99  LipSync *_lipSync;
100  int32 _waitTimeRemaining;
101 };
102 
103 } // End of namespace Resources
104 } // End of namespace Stark
105 
106 #endif // STARK_RESOURCES_SPEECH_H
Definition: str.h:59
Definition: sound.h:47
Definition: item.h:139
Definition: lipsync.h:46
Definition: console.h:27
Definition: object.h:143
Definition: speech.h:48
Definition: xrc.h:45
Definition: stateprovider.h:51