ScummVM API documentation
game.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 ALCACHOFA_GAME_H
23 #define ALCACHOFA_GAME_H
24 
25 #include "common/textconsole.h"
26 #include "common/file.h"
27 
28 namespace Alcachofa {
29 
30 class ObjectBase;
31 class PointObject;
32 class Character;
33 class Door;
34 class Room;
35 class Process;
36 struct ScriptInstruction;
37 
44 class Game {
45  typedef void (*Message)(const char *s, ...);
46 public:
47  Game();
48  virtual ~Game() {}
49 
50  virtual void onLoadedGameFiles();
51 
52  virtual bool doesRoomHaveBackground(const Room *room);
53  virtual void unknownRoomObject(const Common::String &type);
54  virtual void unknownRoomType(const Common::String &type);
55  virtual void unknownDoorTargetRoom(const Common::String &name);
56  virtual void unknownDoorTargetDoor(const Common::String &room, const Common::String &door);
57 
58  virtual void invalidDialogLine(uint index);
59  virtual void tooManyDialogLines(uint lineCount, uint maxLineCount);
60  virtual void tooManyDrawRequests(int order);
61 
62  virtual bool shouldCharacterTrigger(const Character *character, const char *action);
63  virtual bool shouldTriggerDoor(const Door *door);
64  virtual bool hasMortadeloVoice(const Character *character);
65  virtual void onUserChangedCharacter();
66 
67  virtual void unknownCamSetInactiveAttribute(int attribute);
68  virtual void unknownFadeType(int fadeType);
69  virtual void unknownSerializedObject(const char *object, const char *owner, const char *room);
70  virtual void unknownPickupItem(const char *name);
71  virtual void unknownDropItem(const char *name);
72  virtual void unknownVariable(const char *name);
73  virtual void unknownInstruction(const ScriptInstruction &instruction);
74  virtual void unknownAnimateObject(const char *name);
75  virtual void unknownScriptCharacter(const char *action, const char *name);
76  virtual PointObject *unknownGoPutTarget(const Process &process, const char *action, const char *name);
77  virtual void unknownChangeCharacterRoom(const char *name);
78  virtual void unknownAnimateCharacterObject(const char *name);
79  virtual void unknownSayTextCharacter(const char *name, int32 dialogId);
80  virtual void unknownAnimateTalkingObject(const char *name);
81  virtual void unknownClearInventoryTarget(int characterKind);
82  virtual void unknownCamLerpTarget(const char *action, const char *name);
83  virtual void unknownKernelTask(int task);
84  virtual void unknownScriptProcedure(const Common::String &procedure);
85 
86  virtual void missingAnimation(const Common::String &fileName);
87  virtual void missingSound(const Common::String &fileName);
88  virtual void invalidSNDFormat(uint format, uint channels, uint freq, uint bps);
89  virtual void notEnoughRoomDataRead(const char *path, int64 filePos, int64 objectEnd);
90  virtual void notEnoughObjectDataRead(const char *room, int64 filePos, int64 objectEnd);
91  virtual bool isKnownBadVideo(int32 videoId);
92  virtual void invalidVideo(int32 videoId, const char *context);
93 
94  static Game *createForMovieAdventure();
95 
96  const Message _message;
97 };
98 
99 }
100 
101 #endif // ALCACHOFA_GAME_H
Definition: alcachofa.h:45
Definition: str.h:59
Definition: scheduler.h:164
virtual PointObject * unknownGoPutTarget(const Process &process, const char *action, const char *name)
May return an alternative target to use.
Definition: objects.h:419
Provides functionality specific to a game title. Also includes all exemptions to inconsistencies in t...
Definition: game.h:44
Definition: objects.h:399
Definition: objects.h:65
Definition: rooms.h:31
Definition: script.h:148