ScummVM API documentation
scene2100.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 HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_SCENE2100_H
23#define HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_SCENE2100_H
24
25#include "hollywood/monsters/scenes/playable/playable_scene.h"
26
27namespace Hollywood {
28
29class HollywoodEngine;
30
31class Scene2100 : public PlayableScene {
32public:
34
35private:
36 enum LayerId {
37 kMummyLayer,
38 kAuxLayer,
39 kFrontLayer
40 };
41
42 void initializeCustomPreviewState() override;
43 void runCustomEntrySequence() override;
44 void runExitSideEffectsAfterLoop() override;
45 void prepareCustomGameplayLoop() override;
46 void advanceCustomGameplayLoop(uint32 delta) override;
47 bool shouldDrawSecondaryActorInPlayableComposite() const override;
48 bool dispatchCustomSceneAction(uint16 handlerId) override;
49 bool adjustCustomWalkTargetToFloorMask(int &targetX, int &targetY) const override;
50 bool applyCustomSceneStateToHotspotsAndPatches(byte selector) override;
51 byte primarySpeechAnimationBaseFrame(byte animationGroup) const override;
52 uint32 primarySpeechAnimationFrameMillis(byte animationGroup) const override;
53 void setPrimarySpeechAnimationFrame(byte animationGroup, byte frameIndex) override;
54 void primarySpeechAnimationRestored(byte animationGroup, byte baseFrame) override;
55 AmbientAudioProfile ambientAudioProfile() const override;
56
57 void resetAnimationLayers();
58 void advanceReturnLayers(uint32 delta);
59 void advanceMummyIdle(uint32 delta);
60 void advanceDoorCeremony(uint32 delta);
61 void advanceSpecialSpeechAnimation(uint32 delta);
62 bool isRaStaffAvailable() const;
63 void runEntryFromScene2010();
64 void runEntryFromScene2110();
65 void runEntryFromLeftPassage();
66 void runPrincessArrivalSequence();
67 void runLateReturnSequence();
68 void runExitToScene2010(int targetX, int targetY);
69 void runEntryPathWithFinalFacing(int startX, int startY, byte startFacing,
70 byte startCel, int targetX, int targetY, byte finalFacing, byte finalCel);
71 bool runMummyDialogue(bool playGreeting);
72 void initializeMummyDialogueRecords(Common::Array<DialogueChoiceRecord> &records) const;
73 void setDialogueRecord(Common::Array<DialogueChoiceRecord> &records, uint index,
74 byte enabled, byte nextNodeIndex, byte transitionMode, byte playerTextRowId,
75 byte responseFrameIndex, byte disableAfterUse) const;
76 void runMummyPrimarySpeechLine(byte frameIndex);
77 void runPrincessArrivalPrimarySpeechLine(byte frameIndex);
78 void runMummyFrameSetTransition(uint layerId, bool opening, byte closingFinalFrame);
79 void beginMummyDialogueSecondarySpeechLine(uint16 rowIndex, byte frameIndex);
80 void runTreasureIntroductionSequence();
81 void runSpecialTransitionSpeech();
82 void runStoneDoorToTreasureRoom();
83 void runRaStaffPickup();
84 void removeColorMapItemFromOriginal(byte itemId);
85 ResourceSpriteLayer &mummyLayer() { return _sceneLayers.layer(kMummyLayer); }
86 ResourceSpriteLayer &frontLayer() { return _sceneLayers.layer(kFrontLayer); }
87
88 TimedAnimationChannel _foregroundChannel;
89 TimedAnimationChannel _auxChannel;
90 bool _foregroundAlternateFrameSet;
91 bool _mummySpeechUsesFrontLayer;
92 bool _suppressMummySpeechAnimation;
93 bool _returnLayerAnimationActive;
94 bool _mummyIdleEnabled;
95 bool _doorCeremonyAnimationActive;
96 bool _doorCeremonyFinishing;
97 byte _doorCeremonyState;
98 bool _specialSpeechAnimationActive;
99 bool _specialSpeechFinishing;
100 byte _specialSpeechVariant;
101};
102
103} // End of namespace Hollywood
104
105#endif // HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_SCENE2100_H
Definition: array.h:52
Definition: hollywood.h:47
Definition: playable_scene.h:84
Definition: scene2100.h:31
Definition: ambient_audio.h:44
Definition: animation_layers.h:33
Definition: animation_channels.h:34