ScummVM API documentation
various.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 CINE_VARIOUS_H
23#define CINE_VARIOUS_H
24
25
26#include "common/file.h"
27#include "common/keyboard.h"
28
29#include "cine/cine.h"
30
31namespace Cine {
32
33#define kMaxSavegames 100
34#define kMaxOrigUiSavegames 20 // 20 fit on screen using original save/load interface
35
36// Maximum size of the command buffer including the trailing zero
37#define kMaxCommandBufferSize 80
38
39void initLanguage(Common::Language lang);
40
41int16 makeMenuChoice(const CommandeType commandList[], uint16 height, uint16 X, uint16 Y, uint16 width, int minY = 0, bool recheckValue = false, bool allowEmpty = false);
42void makeCommandLine();
43void makeFWCommandLine();
44void makeOSCommandLine();
45void makeActionMenu();
46void waitPlayerInput();
47void setTextWindow(uint16 param1, uint16 param2, uint16 param3, uint16 param4);
48
49extern int16 disableSystemMenu;
50extern bool inMenu;
51extern bool runOnlyUntilFreePartRangeFirst200;
52
53extern CommandeType currentSaveName[kMaxSavegames];
54
56 int16 var4;
57 uint16 objIdx;
58 int16 var8;
59 int16 frame;
60 int16 varC;
61 int16 varE;
62 int16 var10;
63 int16 var12;
64 int16 var14;
65 int16 var16;
66 int16 var18;
67 int16 var1A;
68 int16 var1C;
69 int16 var1E;
70};
71
72extern uint16 var2;
73extern uint16 var3;
74extern uint16 var4;
75extern uint16 lastType20OverlayBgIdx;
76extern uint16 reloadBgPalOnNextFlip;
77extern uint16 forbidBgPalReload;
78extern uint16 gfxFadeOutCompleted;
79extern uint16 gfxFadeInRequested;
80extern uint32 safeControlsLastAccessedMs;
81extern int16 lastSafeControlObjIdx;
82extern int16 commandVar1;
83extern int16 commandVar2;
84extern int16 commandVar3[4];
85
86extern char currentDatName[30];
87extern uint16 musicIsPlaying;
88
89extern uint16 errorVar;
90extern byte menuVar;
91
92extern uint16 allowPlayerInput;
93
94extern uint16 checkForPendingDataLoadSwitch;
95
96extern uint16 isDrawCommandEnabled;
97extern uint16 waitForPlayerClick;
98extern uint16 menuCommandLen;
99extern bool _paletteNeedUpdate;
100extern uint16 _messageLen;
101
102extern int16 playerCommand;
103
104extern char currentPrcName[20];
105extern char currentRelName[20];
106extern char currentObjectName[20];
107extern char currentMsgName[20];
108extern char newPrcName[20];
109extern char newRelName[20];
110extern char newObjectName[20];
111extern char newMsgName[20];
112
113extern char currentCtName[15];
114extern char currentPartName[15];
115
116void stopSample();
117void stopMusicAfterFadeOut();
118void playerCommandMouseLeftRightUp(uint16 mouseX, uint16 mouseY);
119uint16 executePlayerInput();
120
121void drawOverlays();
122
123extern uint16 mouseUpdateStatus;
124extern uint16 dummyU16;
125
126void getMouseData(uint16 param, uint16 *pButton, uint16 *pX, uint16 *pY);
127
128uint16 processKeyboard(uint16 param);
129
130void mainLoopSub6();
131
132void checkForPendingDataLoad();
133
134void hideMouse();
135
136void removeExtension(char *dest, const char *source, size_t sz);
137
139 int16 idx;
140 int16 param;
141};
142
143#define NUM_MAX_ZONE 16
144
145void addMessage(byte param1, int16 param2, int16 param3, int16 param4, int16 param5);
146
147void removeMessages();
148
149void removeSeq(uint16 param1, uint16 param2, uint16 param3);
150bool isSeqRunning(uint16 param1, uint16 param2, uint16 param3);
151void addSeqListElement(uint16 objIdx, int16 param1, int16 param2, int16 frame, int16 param4, int16 param5, int16 param6, int16 param7, int16 param8);
152void modifySeqListElement(uint16 objIdx, int16 var4Test, int16 param1, int16 param2, int16 param3, int16 param4);
153void processSeqList();
154
155void resetGfxEntityEntry(uint16 objIdx);
156
157bool makeTextEntryMenu(const char *caption, char *string, int strLen, int y);
158void moveUsingKeyboard(int x, int y);
159int16 getObjectUnderCursor(uint16 x, uint16 y);
160
161} // End of namespace Cine
162
163#endif
Language
Definition: language.h:45
Definition: anim.h:29
int16 lastSafeControlObjIdx
Object index of the last safe control accessed.
uint32 safeControlsLastAccessedMs
Time in milliseconds when safe controls were last accessed.
Definition: various.h:138
Definition: various.h:55
uint16 objIdx
Is this really unsigned?
Definition: various.h:57