1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef RIVEN_STACK_H
#define RIVEN_STACK_H
#include "common/hash-str.h"
#include "common/ptr.h"
#include "common/str-array.h"
namespace Mohawk {
class MohawkEngine_Riven;
// NAME Resource ID's
enum RivenNameResource {
kCardNames = 1,
kHotspotNames = 2,
kExternalCommandNames = 3,
kVariableNames = 4,
kStackNames = 5
};
/**
* Name lists provide bidirectional association between an object's name and its id
*/
class RivenNameList {
public:
RivenNameList();
RivenNameList(MohawkEngine_Riven *vm, uint16 id);
~RivenNameList();
/** Get the name of an object using its id */
Common::String getName(uint16 nameID) const;
/**
* Get the id of an object using its name
*
* This query is case insensitive.
*/
int16 getNameId(const Common::String &name) const;
private:
void loadResource(MohawkEngine_Riven *vm, uint16 id);
Common::StringArray _names;
Common::Array<uint16> _index;
};
/**
* A game level
*
* The names Card and Stack are legacy from the HyperCard engine used in
* the original mac version of Myst.
*
* Stacks contain behaviors and data that are specific to a game level.
*/
class RivenStack {
public:
RivenStack(MohawkEngine_Riven *vm, uint16 id);
virtual ~RivenStack();
/** Get the id of the stack */
uint16 getId() const;
/** Get the name of a resource using its id */
Common::String getName(RivenNameResource nameResource, uint16 nameId) const;
/**
* Get the id of a resource using its name
*
* The search is case insensitive.
*/
int16 getIdFromName(RivenNameResource nameResource, const Common::String &name) const;
/** Get the id of a card in the card from its global identifier */
uint16 getCardStackId(uint32 globalId) const;
/** Get the global id of the currently active card */
uint32 getCurrentCardGlobalId() const;
/** Get the global id of a card in the stack */
uint32 getCardGlobalId(uint16 cardId) const;
/** Run an external command with the specified parameters */
void runCommand(uint16 argc, uint16 *argv);
/** Write all of the stack's data including its cards to standard output */
void dump() const;
// Common external commands
void xflies(uint16 argc, uint16 *argv); // Start the "flies" effect
// TODO: Misc stuff move elsewhere
uint16 getComboDigit(uint32 correctCombo, uint32 digit);
void runDemoBoundaryDialog();
void runEndGame(uint16 video, uint32 delay);
void runCredits(uint16 video, uint32 delay);
protected:
typedef Common::Functor2<uint16, uint16 *, void> ExternalCommand;
MohawkEngine_Riven *_vm;
/** Register an external command for use by the scripts */
void registerCommand(const Common::String &name, ExternalCommand *command);
private:
typedef Common::HashMap<Common::String, Common::SharedPtr<ExternalCommand>, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> CommandsMap;
#define REGISTER_COMMAND(cls, method) \
registerCommand( \
#method, new Common::Functor2Mem<uint16, uint16 *, void, cls>(this, &cls::method) \
)
void loadResourceNames();
void loadCardIdMap();
void setCurrentStackVariable();
uint16 _id;
// Stack resource names
RivenNameList _varNames;
RivenNameList _externalCommandNames;
RivenNameList _hotspotNames;
RivenNameList _cardNames;
RivenNameList _stackNames;
Common::Array<uint32> _cardIdMap;
CommandsMap _commands;
};
namespace RivenStacks {
/** Get a stack name from an id */
const char *getName(uint16 stackId);
/** Get a stack id from a name */
uint16 getId(const char *stackName);
}
} // End of namespace Mohawk
#endif
|
