ScummVM API documentation
constants.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 PINK_CONSTANTS_H
23#define PINK_CONSTANTS_H
24
25namespace Pink {
26
27enum {
28 kMaxClassLength = 32,
29 kMaxStringLength = 128,
30 kNullObject = 0
31};
32
33enum {
34 kActionHide,
35 kActionLoop,
36 kActionPlay,
37 kActionPlayWithSfx,
38 kActionSfx,
39 kActionSound,
40 kActionStill,
41 kActionTalk,
42 kActionText,
43 kActor,
44 kAudioInfoPDAButton,
45 kConditionGameVariable,
46 kConditionInventoryItemOwner,
47 kConditionModuleVariable,
48 kConditionNotInventoryItemOwner,
49 kConditionNotModuleVariable,
50 kConditionNotPageVariable,
51 kConditionPageVariable,
52 kCursorActor,
53 kGamePage,
54 kHandlerLeftClick,
55 kHandlerStartPage,
56 kHandlerTimer,
57 kHandlerTimerActions,
58 kHandlerTimerSequences,
59 kHandlerUseClick,
60 kInventoryActor,
61 kInventoryItem,
62 kLeadActor,
63 kModuleProxy,
64 kPDAButtonActor,
65 kParlSqPink,
66 kPubPink,
67 kSeqTimer,
68 kSequence,
69 kSequenceAudio,
70 kSequenceItem,
71 kSequenceItemDefaultAction,
72 kSequenceItemLeader,
73 kSequenceItemLeaderAudio,
74 kSideEffectExit,
75 kSideEffectGameVariable,
76 kSideEffectInventoryItemOwner,
77 kSideEffectLocation,
78 kSideEffectModuleVariable,
79 kSideEffectPageVariable,
80 kSideEffectRandomPageVariable,
81 kSupportingActor,
82 kWalkAction,
83 kWalkLocation
84};
85
86enum {
87 kCursorsCount = 13
88};
89
90enum {
91 kLoadingCursor = 0,
92 kDefaultCursor = 1,
93 kClickableFirstFrameCursor = 2,
94 kClickableSecondFrameCursor = 3,
95 kNotClickableCursor = 4,
96 kHoldingItemCursor = 5,
97 kPDADefaultCursor = 6,
98 kPDAClickableFirstFrameCursor = 7,
99 kPDAClickableSecondFrameCursor = 8,
100 kExitLeftCursor = 9,
101 kExitRightCursor = 10,
102 kExitForwardCursor = 11,
103 kExitDownCursor = 12 // only in Hokus Pokus
104};
105
106
107// values are from Hokus Pokus
108enum {
109 kPokusLoadingCursorID = 135,
110 kPokusExitForwardCursorID = 138,
111 kPokusExitDownCursorID = 139,
112 kPokusExitLeftCursorID = 133,
113 kPokusExitRightCursorID = 134,
114 kPokusClickableFirstCursorID = 137,
115 kPokusClickableSecondCursorID = 136,
116 kPokusClickableThirdCursorID = 145,
117 kPokusNotClickableCursorID = 140,
118 kPokusHoldingItemCursorID = 147,
119 kPokusPDADefaultCursorID = 141,
120 kPokusPDAClickableFirstFrameCursorID = 144,
121 kPokusPDAClickableSecondFrameCursorID = 146
122};
123
124// from Peril
125// it contains cursors whose ids differ
126enum {
127 kPerilClickableThirdCursorID = 140,
128 kPerilNotClickableCursorID = 139,
129 kPerilHoldingItemCursorID = 101,
130 kPerilPDAClickableFirstFrameCursorID = 142,
131 kPerilPDAClickableSecondFrameCursorID = 143
132};
133
134enum {
135 kOrbMajorVersion = 2,
136 kOrbMinorVersion = 0,
137 kBroMajorVersion = 1,
138 kBroMinorVersion = 0
139};
140
141enum {
142 kTimersUpdateTime = 100,
143 kCursorsUpdateTime = 200
144};
145
146enum {
147 kSampleRate = 22050
148};
149
150static const char * const kPinkGame = "PinkGame";
151
152static const char * const kPeril = "peril";
153
154static const char * const kCloseAction = "Close";
155static const char * const kIdleAction = "Idle";
156static const char * const kOpenAction = "Open";
157static const char * const kShowAction = "Show";
158static const char * const kHideAction = "Hide";
159static const char * const kInactiveAction = "Inactive";
160
161static const char * const kInventoryWindowActor = "InventoryWindow";
162static const char * const kInventoryItemActor = "InventoryItem";
163static const char * const kInventoryRightArrowActor = "InventoryRightArrow";
164static const char * const kInventoryLeftArrowActor = "InventoryLeftArrow";
165
166static const char * const kAudioInfoActor = "AudioInfo";
167static const char * const kPdaButtonActor = "PDAButton";
168
169static const char * const kCursorNameExit = "Exit";
170static const char * const kCursorNameExitUp = "ExitUp";
171static const char * const kCursorNameExitLeft = "ExitLeft";
172static const char * const kCursorNameExitRight = "ExitRight";
173static const char * const kCursorNameExitForward = "ExitForward";
174static const char * const kCursorNameExitBackWards = "ExitBackwards";
175
176static const char * const kClickable = "Clickable";
177static const char * const kCursor = "Cursor";
178
179static const char * const kFoodPuzzle = "FoodPuzzle";
180static const char * const kJackson = "Jackson";
181static const char * const kBolted = "Bolted";
182static const char * const kDrunkLocation = "DrunkLocation";
183static const char * const kDrunk = "Drunk";
184
185static const char * const kBoy = "Boy";
186static const char * const kSirBaldley = "SirBaldley";
187static const char * const kBoyBlocked = "BoyBlocked";
188
189static const char * const kUndefinedValue = "UNDEFINED";
190static const char * const kTrueValue = "TRUE";
191
192static const char * const kCountryWheel = "CountryWheel";
193static const char * const kDomainWheel = "DomainWheel";
194
195static const char * const kLocator = "Locator";
196
197static const char * const kPreviousPageButton = "PreviousPageButton";
198static const char * const kDomainButton = "DomainButton";
199static const char * const kNavigatorButton = "NavigatorButton";
200
201static const char * const kNavigatePage = "NAVIGATE";
202
203static const char * const kSfx = "SFX";
204
205static const char * const kRightHand = "RightHand";
206static const char * const kLeftHand = "LeftHand";
207
208static const char * const kLeft1Name = "Left1";
209static const char * const kLeft2Name = "Left2";
210static const char * const kLeft3Name = "Left3";
211static const char * const kLeft4Name = "Left4";
212
213} // End of namespace Pink
214
215#endif