ScummVM API documentation
lingo-the.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 DIRECTOR_LINGO_LINGO_THE_H
23  #define DIRECTOR_LINGO_LINGO_THE_H
24 
25 namespace Director {
26 
27 enum TheEntityType {
28  kTheNOEntity = 0,
29  kTheObject = 1,
30  kTheActiveWindow,
31  kTheActorList,
32  kTheAlertHook,
33  kTheApplicationPath,
34  kTheBeepOn,
35  kTheButtonStyle,
36  kTheCast,
37  kTheCastLib,
38  kTheCastLibs,
39  kTheCastMembers,
40  kTheCenterStage,
41  kTheChars,
42  kTheCheckBoxAccess,
43  kTheCheckBoxType,
44  kTheChunk,
45  kTheClickLoc,
46  kTheClickOn,
47  kTheColorDepth,
48  kTheColorQD,
49  kTheCommandDown,
50  kTheControlDown,
51  kTheCpuHogTicks,
52  kTheCurrentSpriteNum,
53  kTheDate,
54  kTheDeskTopRectList,
55  kTheDigitalVideoTimeScale,
56  kTheDoubleClick,
57  kTheEmulateMultiButtonMouse,
58  kTheExitLock,
59  kTheField,
60  kTheFixStageSize,
61  kTheFloatPrecision,
62  kTheFrame,
63  kTheFrameLabel,
64  kTheFramePalette,
65  kTheFrameScript,
66  kTheFrameSound1,
67  kTheFrameSound2,
68  kTheFrameTempo,
69  kTheFrameTransition,
70  kTheFreeBlock,
71  kTheFreeBytes,
72  kTheFrontWindow,
73  kTheFullColorPermit,
74  kTheIdleHandlerPeriod,
75  kTheIdleLoadMode,
76  kTheIdleLoadPeriod,
77  kTheIdleLoadTag,
78  kTheIdleReadChunkSize,
79  kTheImageDirect,
80  kTheItemDelimiter,
81  kTheItems,
82  kTheKey,
83  kTheKeyCode,
84  kTheKeyDownScript,
85  kTheKeyPressed,
86  kTheKeyUpScript,
87  kTheLabelList,
88  kTheLastClick,
89  kTheLastEvent,
90  kTheLastFrame,
91  kTheLastKey,
92  kTheLastRoll,
93  kTheLines,
94  kTheMachineType,
95  kTheMaxInteger,
96  kTheMemorySize,
97  kTheMenu,
98  kTheMenuItem,
99  kTheMenuItems,
100  kTheMenus,
101  kTheMouseCast,
102  kTheMouseChar,
103  kTheMouseDown,
104  kTheMouseDownScript,
105  kTheMouseH,
106  kTheMouseItem,
107  kTheMouseLine,
108  kTheMouseMember,
109  kTheMouseUp,
110  kTheMouseUpScript,
111  kTheMouseV,
112  kTheMouseWord,
113  kTheMovie,
114  kTheMovieFileFreeSize,
115  kTheMovieFileSize,
116  kTheMovieName,
117  kTheMoviePath,
118  kTheMultiSound,
119  kTheNetThrottleTicks,
120  kTheOptionDown,
121  kTheOrganizationName,
122  kTheParamCount,
123  kThePathName,
124  kThePauseState,
125  kThePerFrameHook,
126  kThePi,
127  kThePlatform,
128  kThePreloadEventAbort,
129  kThePreLoadRAM,
130  kTheProductName,
131  kTheProductVersion,
132  kTheQuickTimePresent,
133  kTheRandomSeed,
134  kTheResult,
135  kTheRightMouseDown,
136  kTheRightMouseUp,
137  kTheRollOver,
138  kTheRomanLingo,
139  kTheRunMode,
140  kTheSafePlayer,
141  kTheScore,
142  kTheScummvmVersion, // set the Director version via lingo in tests
143  kTheSearchCurrentFolder,
144  kTheSearchPath,
145  kTheSearchPaths,
146  kTheSelection,
147  kTheSelEnd,
148  kTheSelStart,
149  kTheSerialNumber,
150  kTheShiftDown,
151  kTheSoundEntity,
152  kTheSoundEnabled,
153  kTheSoundKeepDevice,
154  kTheSoundLevel,
155  kTheSprite,
156  kTheSqrt,
157  kTheStage,
158  kTheStageBottom,
159  kTheStageColor,
160  kTheStageLeft,
161  kTheStageRight,
162  kTheStageTop,
163  kTheStillDown,
164  kTheSwitchColorDepth,
165  kTheTicks,
166  kTheTime,
167  kTheTimeoutKeyDown,
168  kTheTimeoutLapsed,
169  kTheTimeoutLength,
170  kTheTimeoutMouse,
171  kTheTimeoutPlay,
172  kTheTimeoutScript,
173  kTheTimer,
174  kTheTrace,
175  kTheTraceLoad,
176  kTheTraceLogFile,
177  kTheUpdateMovieEnabled,
178  kTheUserName,
179  kTheVideoForWindowsPresent,
180  kTheWindow,
181  kTheWindowList,
182  kTheWords,
183  kTheXtras,
184  kTheMaxTheEntityType // This must be always last
185 };
186 
187 enum TheFieldType {
188  kTheNOField = 0,
189  kTheAbbr = 1,
190  kTheAntiAlias,
191  kTheAutoTab,
192  kTheBackColor,
193  kTheBlend,
194  kTheBorder,
195  kTheBottom,
196  kTheBoxDropShadow,
197  kTheBoxType,
198  kTheButtonType,
199  kTheCastLibNum,
200  kTheCastNum,
201  kTheCastType,
202  kTheCenter,
203  kTheChangeArea,
204  kTheChannelCount,
205  kTheCheckMark,
206  kTheChunkSize,
207  kTheConstraint,
208  kTheController,
209  kTheCrop,
210  kTheCuePointNames,
211  kTheCuePointTimes,
212  kTheCurrentTime,
213  kTheCursor,
214  kTheDepth,
215  kTheDigitalVideoType,
216  kTheDirectToStage,
217  kTheDrawRect,
218  kTheDropShadow,
219  kTheDuration,
220  kTheEditable,
221  kTheEditableText,
222  kTheEnabled,
223  kTheFileName,
224  kTheFilled,
225  kTheFlipH,
226  kTheFlipV,
227  kTheForeColor,
228  kTheFrameRate,
229  kTheHeight,
230  kTheHilite,
231  kTheImmediate,
232  kTheInk,
233  kTheInterface,
234  kTheLast,
235  kTheLeft,
236  kTheLineCount,
237  kTheLineSize,
238  kTheLoaded,
239  kTheLoc,
240  kTheLocH,
241  kTheLocV,
242  kTheLong,
243  kTheLoop,
244  kTheMargin,
245  kTheMedia,
246  kTheMediaBusy,
247  kTheMediaReady,
248  kTheMember,
249  kTheMemberNum,
250  kTheModal,
251  kTheModified,
252  kTheMostRecentCuePoint,
253  kTheMoveableSprite,
254  kTheMovieRate,
255  kTheMovieTime,
256  kTheName,
257  kTheNumber,
258  kThePageHeight,
259  kThePalette,
260  kThePaletteMapping,
261  kThePaletteRef,
262  kThePattern,
263  kThePausedAtStart,
264  kThePicture,
265  kThePreLoad,
266  kThePreLoadMode,
267  kThePuppet,
268  kThePurgePriority,
269  kTheRect,
270  kTheRegPoint,
271  kTheRight,
272  kTheSampleRate,
273  kTheSampleSize,
274  kTheScoreColor,
275  kTheScoreSelection,
276  kTheScript,
277  kTheScriptInstanceList,
278  kTheScriptNum,
279  kTheScriptText,
280  kTheScriptType,
281  kTheScriptsEnabled,
282  kTheSelectionField,
283  kTheSetTrackEnabled,
284  kTheShapeType,
285  kTheShort,
286  kTheSize,
287  kTheSound,
288  kTheSourceRect,
289  kTheSpriteNum,
290  kTheStartTime,
291  kTheStopTime,
292  kTheStrech,
293  kTheStretch,
294  kTheText,
295  kTheTextAlign,
296  kTheTextFont,
297  kTheTextHeight,
298  kTheTextSize,
299  kTheTextStyle,
300  kTheTimeScale,
301  kTheTitle,
302  kTheTitleVisible,
303  kTheTop,
304  kTheTrackEnabled,
305  kTheTrackNextKeyTime,
306  kTheTrackNextSampleTime,
307  kTheTrackPreviousKeyTime,
308  kTheTrackPreviousSampleTime,
309  kTheTrackText,
310  kTheTrails,
311  kTheTransitionType,
312  kTheTweened,
313  kTheType,
314  kTheUpdateLock,
315  kTheVideo,
316  kTheVisibility,
317  kTheVisible,
318  kTheVolume,
319  kTheWidth,
320  kTheWindowType,
321  kTheWordWrap,
322  kTheScrollTop,
323  kTheMaxTheFieldType // This must be always last
324 };
325 
326 struct TheEntity {
327  TheEntityType entity;
328  const char *name;
329  bool hasId;
330  int version;
331  bool isFunction;
332 };
333 
335  TheEntityType entity;
336  const char *name;
337  TheFieldType field;
338  int version;
339 };
340 
341 } // End of namespace Director
342 
343 #endif
Definition: lingo-the.h:334
Definition: archive.h:36
Definition: lingo-the.h:326