ScummVM API documentation
scene5040.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_SCENE5040_H
23#define HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_SCENE5040_H
24
25#include "hollywood/monsters/scenes/playable/playable_scene.h"
26
27namespace Hollywood {
28
29class HollywoodEngine;
30
31class Scene5040 : public PlayableScene {
32public:
34
35private:
36 void initializeCustomPreviewState() override;
37 void prepareCustomComposite(bool drawActors, byte activeFacing, int activeWorldX,
38 int activeWorldY, byte actorDrawOrderMode) override;
39 void drawCustomActorForegroundComposite(int activeWorldX, int activeWorldY,
40 byte actorDrawOrderMode) override;
41 void runCustomEntrySequence() override;
42 void advanceCustomGameplayLoop(uint32 delta) override;
43 void advancePrimarySpeechAnimation(uint32 delta) override;
44 bool dispatchCustomSceneAction(uint16 handlerId) override;
45 bool customizeRouteFinal(byte currentRegion, byte targetRegion, const ActorPathBuildState &state,
46 int targetX, int targetY, int &requestedFacing, bool &restoredStepDeltas) override;
47 bool applyCustomSceneStateToHotspotsAndPatches(byte selector) override;
48 void runExitSideEffectsAfterLoop() override;
49 AmbientAudioProfile ambientAudioProfile() const override;
50 byte primarySpeechAnimationBaseFrame(byte animationGroup) const override;
51 byte primarySpeechAnimationFrameCount(byte animationGroup) const override;
52 void setPrimarySpeechAnimationFrame(byte animationGroup, byte frameIndex) override;
53 void primarySpeechAnimationStarted(byte animationGroup, byte baseFrame) override;
54 void primarySpeechAnimationRestored(byte animationGroup, byte baseFrame) override;
55
56 void resetAnimationLayers();
57 void advanceKarlLayer(uint32 delta);
58 void advanceKarlMiningSpeech(uint32 delta);
59 bool playKarlFrames(byte firstFrame, byte lastFrame, uint32 frameMillis);
60 bool playKarlTransition(byte firstFrame, byte lastFrame, byte finalFrame, uint32 frameMillis);
61 void settleKarlForConversation();
62 void runMineCartEntryClip();
63 void runExitToMineSwitches();
64 void runExitToMineHole();
65 void runKarlConversation();
66 void runMineBoxLook();
67 void runPatchedSockPickup();
68 void runMineKeyPickup();
69 void runSpecialMineExitWithMagneticPillbox();
70 void runDowsingRodSwap();
71 void runRestoredDowsingRodOffer();
72 void initializeKarlDialogueRecords(Common::Array<DialogueChoiceRecord> &records) const;
73 void setKarlDialogueRecord(Common::Array<DialogueChoiceRecord> &records, uint index,
74 byte nextNodeIndex, byte transitionMode, byte playerTextRowId,
75 byte responseFrameIndex, byte disableAfterUse) const;
76 bool applyKarlDialogueTransition(const DialogueChoiceRecord &record, byte &depthIndex, byte &nodeIndex) const;
77 void beginKarlSpeechLine(byte frameIndex);
78 void beginKarlRestoredDowsingRodReply();
79 void beginKarlMiningSpeechLine(byte frameIndex);
80 void copyStageSmallRow(byte destinationRow, byte sourceRow);
81 void remapSceneColors(byte sourceColor, byte itemId);
82
83 TimedAnimationChannel _karlIdleChannel;
84 byte _karlIdleFrame;
85 byte _karlIdleMode;
86 byte _karlStrikeRepeatCount;
87 bool _suspendKarlIdle;
88 bool _mineCartRumbleActive;
89 byte _lastKarlMiningSpeechFrame;
90 byte _previousKarlMiningSpeechFrame;
91};
92
93} // End of namespace Hollywood
94
95#endif // HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_SCENE5040_H
Definition: array.h:52
Definition: hollywood.h:47
Definition: playable_scene.h:84
Definition: scene5040.h:31
Definition: actor_types.h:59
Definition: ambient_audio.h:44
Definition: dialogue_menu.h:33
Definition: animation_channels.h:34