ScummVM API documentation
scroll.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_SCROLL_H
23 #define STARK_RESOURCES_SCROLL_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 
40 class Scroll : public Object {
41 public:
42  static const Type::ResourceType TYPE = Type::kScroll;
43 
44  Scroll(Object *parent, byte subType, uint16 index, const Common::String &name);
45  virtual ~Scroll();
46 
47  // Resource API
48  void readData(Formats::XRCReadStream *stream) override;
49  void onGameLoop() override;
50  void saveLoadCurrent(ResourceSerializer *serializer) override;
51 
53  void start();
54 
56  void stop();
57 
59  bool isActive();
60 
62  void applyToLocationImmediate();
63 
64 protected:
65  void printData() override;
66 
67  uint32 _coordinate;
68  uint32 _field_30;
69  uint32 _field_34;
70  uint32 _bookmarkIndex;
71 
72  bool _active;
73 };
74 
75 } // End of namespace Resources
76 } // End of namespace Stark
77 
78 #endif // STARK_RESOURCES_SCROLL_H
Definition: str.h:59
Definition: console.h:27
Definition: object.h:143
Definition: xrc.h:45
Definition: scroll.h:40
Definition: stateprovider.h:51