ScummVM API documentation
page.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 PINK_PAGE_H
23 #define PINK_PAGE_H
24 
25 #include "pink/resource_mgr.h"
26 #include "pink/objects/module.h"
27 
28 namespace Pink {
29 
30 class Archive;
31 class Actor;
32 class LeadActor;
33 class WalkMgr;
34 class Sequencer;
35 
36 class Page : public NamedObject {
37 public:
38  ~Page() override;
39  void toConsole() const override;
40 
41  void load(Archive &archive) override;
42  void init();
43  void initPalette();
44 
45  Actor *findActor(const Common::String &name);
46  LeadActor *getLeadActor() { return _leadActor; }
47 
48  Common::SeekableReadStream *getResourceStream(const Common::String &fileName) { return _resMgr.getResourceStream(fileName); }
49 
50  virtual void clear();
51  void pause(bool paused);
52 
53  PinkEngine *getGame() { return _resMgr.getGame(); }
54 
55  virtual Sequencer *getSequencer() { return nullptr; }
56  virtual WalkMgr *getWalkMgr() { return nullptr; }
57  virtual Module *getModule() { return nullptr; }
58  virtual const Module *getModule() const { return nullptr; }
59 
60  virtual bool checkValueOfVariable(const Common::String &variable, const Common::String &value) const { return 0; }
61  virtual void setVariable(Common::String &variable, Common::String &value) {}
62 
63 protected:
64 
65  Array<Actor *> _actors;
66  ResourceMgr _resMgr;
67  LeadActor *_leadActor;
68 };
69 
70 } // End of namespace Pink
71 
72 #endif
Definition: archive.h:39
Definition: str.h:59
Definition: sequencer.h:36
Definition: pink.h:95
Definition: object.h:40
Definition: stream.h:745
Definition: module.h:43
Definition: archive.h:35
Definition: lead_actor.h:41
Definition: resource_mgr.h:39
Definition: actor.h:39
Definition: page.h:36
Definition: utils.h:30
Definition: walk_mgr.h:42