ScummVM API documentation
scene6090.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_SCENE6090_H
23#define HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_SCENE6090_H
24
25#include "hollywood/monsters/scenes/playable/playable_scene.h"
26
27namespace Hollywood {
28
29class HollywoodEngine;
30
31// Runs the wax-pool confrontation, timed rope rescue, and transition to the ending.
32class Scene6090 : public PlayableScene {
33public:
35
36private:
37 enum CompositeMode {
38 kIntroComposite,
39 kRescueComposite,
40 kSpecialComposite,
41 kEscapeComposite
42 };
43
44 void initializeCustomPreviewState() override;
45 void drawCustomComposite(bool drawActiveActor, byte activeFacing, byte activeCel,
46 int activeWorldX, int activeWorldY, bool drawSecondaryActor, byte secondaryFacing,
47 byte secondaryFrame, int secondaryWorldX, int secondaryWorldY,
48 byte actorDrawOrderMode) override;
49 bool shouldApplyGameplayPanelObjectPalette() const override;
50 void runCustomEntrySequence() override;
51 void prepareCustomGameplayLoop() override;
52 void advanceCustomGameplayLoop(uint32 delta) override;
53 bool dispatchCustomSceneAction(uint16 handlerId) override;
54 bool shouldPlayGameplayClickPath() const override;
55 byte primarySpeechAnimationBaseFrame(byte animationGroup) const override;
56 uint32 primarySpeechAnimationFrameMillis(byte animationGroup) const override;
57 void setPrimarySpeechAnimationFrame(byte animationGroup, byte frameIndex) override;
58 void primarySpeechAnimationRestored(byte animationGroup, byte baseFrame) override;
59 void runExitSideEffectsAfterLoop() override;
60 AmbientAudioProfile ambientAudioProfile() const override;
61
62 void clearRonInventory();
63 void restoreTiedSequencePalette();
64 void resetSceneLayers();
65 void drawActorFrames(bool drawActiveActor, byte activeFacing, byte activeCel,
66 int activeWorldX, int activeWorldY, bool drawSecondaryActor, byte secondaryFacing,
67 byte secondaryFrame, int secondaryWorldX, int secondaryWorldY);
68 bool playLayerTransition(uint layerId, byte firstFrame, byte lastFrame,
69 uint32 frameMillis);
70 bool runCurtainRevealFromBlack();
71 void runOpeningConversation();
72
73 void advanceTiedRonIdle(uint32 delta);
74 void advanceSueIdle(uint32 delta);
75 void advanceMechanism(uint32 delta);
76 void advanceHannoverPose();
77 void runDelayedInterruption();
78 void runInterruptionClips();
79
80 void applyPatchChunk(uint chunkIndex);
81 void setRescueFrame(byte frame);
82 void runRopeRescueSequence();
83 void advanceEscapeAnimation(uint32 delta);
84 void advanceEscapePalette(uint32 delta);
85 void dimEscapePaletteStep();
86
87 uint _leftAmbientTrack;
88 uint _rightAmbientTrack;
89 TimedAnimationChannel _tiedRonChannel;
90 TimedAnimationChannel _sueIdleChannel;
91 TimedAnimationChannel _mechanismChannel;
92 TimedAnimationChannel _escapeChannel;
93 TimedAnimationChannel _paletteFadeChannel;
94 SoundBank0Player _secondaryEffectSound;
95 Common::Array<byte> _escapePaletteSource;
96
97 CompositeMode _compositeMode;
98 byte _tiedRonIdleFrame;
99 byte _sueIdleMode;
100 byte _sueIdleRepeatCount;
101 byte _mechanismState;
102 byte _speakerMode;
103 byte _hannoverPoseMode;
104 byte _interruptionCycleCount;
105 byte _paletteFadeThreshold;
106 bool _delayedEventDone;
107 bool _postRescue;
108 bool _automaticEventRunning;
109 bool _manualSequenceActive;
110 bool _freedSueActive;
111 bool _escapeAnimationActive;
112 bool _escapePaletteActive;
113 bool _paletteLockedDark;
114 bool _muffledSpeechStarted;
115};
116
117} // End of namespace Hollywood
118
119#endif // HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_SCENE6090_H
Definition: hollywood.h:47
Definition: playable_scene.h:84
Definition: scene6090.h:32
Definition: music.h:82
Definition: ambient_audio.h:44
Definition: animation_channels.h:34