ScummVM API documentation
animsoundtrigger.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_ANIM_SOUND_TRIGGER_H
23 #define STARK_RESOURCES_ANIM_SOUND_TRIGGER_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 AnimSkeleton;
38 
44 class AnimSoundTrigger : public Object {
45 public:
46  static const Type::ResourceType TYPE = Type::kAnimSoundTrigger;
47 
48  enum SubType {
49  kAnimTriggerSound = 1
50  };
51 
52  AnimSoundTrigger(Object *parent, byte subType, uint16 index, const Common::String &name);
53  virtual ~AnimSoundTrigger();
54 
55  // Resource API
56  void readData(Formats::XRCReadStream *stream) override;
57  void printData() override;
58  void onAllLoaded() override;
59  void onGameLoop() override;
60 
61 private:
62  uint32 _soundStockType;
63  uint32 _soundTriggerTime;
64 
65  AnimSkeleton *_anim;
66  bool _alreadyPlayed;
67  uint _timeRemainingBeforeLoop;
68 };
69 
70 } // End of namespace Resources
71 } // End of namespace Stark
72 
73 #endif // STARK_RESOURCES_ANIM_SOUND_TRIGGER_H
Definition: str.h:59
Definition: console.h:27
Definition: object.h:143
Definition: animsoundtrigger.h:44
Definition: xrc.h:45
Definition: anim.h:283