ScummVM API documentation
prehistoric.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  * Additional copyright for this file:
8  * Copyright (C) 1995-1997 Presto Studios, Inc.
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <http://www.gnu.org/licenses/>.
22  *
23  */
24 
25 #ifndef PEGASUS_NEIGHBORHOOD_PREHISTORIC_H
26 #define PEGASUS_NEIGHBORHOOD_PREHISTORIC_H
27 
28 #include "pegasus/neighborhood/neighborhood.h"
29 
30 namespace Pegasus {
31 
32 static const TimeScale kPrehistoricMovieScale = 600;
33 static const TimeScale kPrehistoricFramesPerSecond = 15;
34 static const TimeScale kPrehistoricFrameDuration = 40;
35 
36 // Alternate IDs.
37 
38 static const AlternateID kAltPrehistoricNormal = 0;
39 static const AlternateID kAltPrehistoricBridgeSet = 1;
40 
41 // Room IDs.
42 
43 static const RoomID kPrehistoric01 = 0;
44 static const RoomID kPrehistoric02 = 1;
45 static const RoomID kPrehistoric03 = 2;
46 static const RoomID kPrehistoric04 = 3;
47 static const RoomID kPrehistoric05 = 4;
48 static const RoomID kPrehistoric06 = 5;
49 static const RoomID kPrehistoric07 = 6;
50 static const RoomID kPrehistoric08 = 7;
51 static const RoomID kPrehistoric09 = 8;
52 static const RoomID kPrehistoric10 = 9;
53 static const RoomID kPrehistoric11 = 10;
54 static const RoomID kPrehistoric12 = 11;
55 static const RoomID kPrehistoric13 = 12;
56 static const RoomID kPrehistoric14 = 13;
57 static const RoomID kPrehistoric15 = 14;
58 static const RoomID kPrehistoric16 = 15;
59 static const RoomID kPrehistoric17 = 16;
60 static const RoomID kPrehistoric18 = 17;
61 static const RoomID kPrehistoric19 = 18;
62 static const RoomID kPrehistoric20 = 19;
63 static const RoomID kPrehistoric21 = 20;
64 static const RoomID kPrehistoric22 = 21;
65 static const RoomID kPrehistoric22North = 22;
66 static const RoomID kPrehistoric23 = 23;
67 static const RoomID kPrehistoric24 = 24;
68 static const RoomID kPrehistoric25 = 25;
69 static const RoomID kPrehistoricDeath = 26;
70 
71 // Hot Spot Activation IDs.
72 
73 static const HotSpotActivationID kActivationVaultClosed = 1;
74 static const HotSpotActivationID kActivationVaultOpen = 2;
75 
76 // Hot Spot IDs.
77 
78 static const HotSpotID kPre18EastSpotID = 5000;
79 static const HotSpotID kPre22NorthSpotID = 5001;
80 static const HotSpotID kPre22NorthOutSpotID = 5002;
81 static const HotSpotID kPre22NorthBreakerSpotID = 5003;
82 static const HotSpotID kPrehistoricKeyDropSpotID = 5004;
83 static const HotSpotID kPrehistoricHistoricalLogSpotID = 5005;
84 
85 // Extra sequence IDs.
86 
87 static const ExtraID kPreArrivalFromTSA = 0;
88 static const ExtraID kPre18EastBridgeOut = 1;
89 static const ExtraID kPre18EastBridgeOn = 2;
90 static const ExtraID kPre18EastZoom = 3;
91 static const ExtraID kPre18EastZoomOut = 4;
92 static const ExtraID kPre22ThrowBreaker = 5;
93 static const ExtraID kPre25EastUnlockingVaultWithLog = 6;
94 static const ExtraID kPre25EastVaultOpenWithLog = 7;
95 static const ExtraID kPre25EastViewWithLog = 8;
96 static const ExtraID kPre25EastUnlockingVaultNoLog = 9;
97 static const ExtraID kPre25EastVaultOpenNoLog = 10;
98 static const ExtraID kPre25EastViewNoLog = 11;
99 
100 class PegasusEngine;
101 
102 class Prehistoric : public Neighborhood {
103 public:
104  Prehistoric(InputHandler *, PegasusEngine *);
105  ~Prehistoric() override {}
106 
107  uint16 getDateResID() const override;
108  void init() override;
109 
110  void arriveAt(const RoomID, const DirectionConstant) override;
111  void activateHotspots() override;
112  void clickInHotspot(const Input &, const Hotspot *) override;
113  Common::Path getBriefingMovie() override;
114  Common::Path getEnvScanMovie() override;
115  uint getNumHints() override;
116  Common::Path getHintMovie(uint) override;
117 
118  Hotspot *getItemScreenSpot(Item *, DisplayElement *) override;
119  void dropItemIntoRoom(Item *, Hotspot *) override;
120  void pickedUpItem(Item *) override;
121 
122  void start() override;
123 
124  void bumpIntoWall() override;
125 
126  void checkContinuePoint(const RoomID, const DirectionConstant) override;
127 
128  bool canSolve() override;
129  void doSolve() override;
130 
131 protected:
132  enum {
133  kPrehistoricPrivateVaultOpenFlag,
134  kPrehistoricPrivateExtendedBridgeFlag,
135  kNumPrehistoricPrivateFlags
136  };
137 
138  void setUpAIRules() override;
139  int16 getStaticCompassAngle(const RoomID, const DirectionConstant) override;
140  void getExitCompassMove(const ExitTable::Entry &, FaderMoveSpec &) override;
141  void receiveNotification(Notification *, const NotificationFlags) override;
142  void spotCompleted() override;
143  void turnTo(const DirectionConstant) override;
144  void zoomToVault();
145  TimeValue getViewTime(const RoomID, const DirectionConstant) override;
146  void findSpotEntry(const RoomID, const DirectionConstant, SpotFlags, SpotTable::Entry &) override;
147 
148  void loadAmbientLoops() override;
149 
150  FlagsArray<byte, kNumPrehistoricPrivateFlags> _privateFlags;
151 
152  Common::Path getNavMovieName() override;
153  Common::Path getSoundSpotsName() override;
154 };
155 
156 } // End of namespace Pegasus
157 
158 #endif
Pegasus::Neighborhood
Definition: neighborhood.h:111
Pegasus::FaderMoveSpec
Definition: fader.h:35
Common::Path
Definition: path.h:52
Pegasus::Hotspot
Definition: hotspot.h:85
Pegasus::Prehistoric
Definition: prehistoric.h:102
Pegasus::Item
Definition: item.h:294
Pegasus::SpotTable::Entry
Definition: spot.h:66
Pegasus::Input
Definition: input.h:322
Pegasus::ExitTable::Entry
Definition: exit.h:49
Pegasus::Notification
Definition: notification.h:53
Pegasus::DisplayElement
Definition: elements.h:43
Pegasus::PegasusEngine
Definition: pegasus.h:70
Pegasus::InputHandler
Definition: input.h:410
Pegasus
Definition: ai_action.h:33