ScummVM API documentation
struc.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 SKY_STRUC_H
23 #define SKY_STRUC_H
24 
25 namespace Sky {
26 
27 struct DisplayedText {
28  byte *textData;
29  uint32 textWidth;
30  uint16 compactNum;
31 };
32 
33 #include "common/pack-start.h" // START STRUCT PACKING
34 
36  uint16 flag; // bit 0: set for color data, clear for not
37  // bit 1: set for compressed, clear for uncompressed
38  // bit 2: set for 32 colors, clear for 16 colors
39  uint16 s_x;
40  uint16 s_y;
41  uint16 s_width;
42  uint16 s_height;
43  uint16 s_sp_size;
44  uint16 s_tot_size;
45  uint16 s_n_sprites;
46  int16 s_offset_x;
47  int16 s_offset_y;
48  uint16 s_compressed_size;
49 } PACKED_STRUCT;
50 
51 struct TurnTable {
52  uint16 turnTableUp[5];
53  uint16 turnTableDown[5];
54  uint16 turnTableLeft[5];
55  uint16 turnTableRight[5];
56  uint16 turnTableTalk[5];
57 } PACKED_STRUCT;
58 
59 struct MegaSet {
60  uint16 gridWidth; // 0
61  uint16 colOffset; // 1
62  uint16 colWidth; // 2
63  uint16 lastChr; // 3
64 
65  uint16 animUpId; // 4
66  uint16 animDownId; // 5
67  uint16 animLeftId; // 6
68  uint16 animRightId; // 7
69 
70  uint16 standUpId; // 8
71  uint16 standDownId; // 9
72  uint16 standLeftId; // 10
73  uint16 standRightId; // 11
74  uint16 standTalkId; // 12
75  uint16 turnTableId; // 13
76 } PACKED_STRUCT;
77 
78 struct Compact {
79  uint16 logic; // 0: Entry in logic table to run (byte as <256entries in logic table
80  uint16 status; // 1
81  uint16 sync; // 2: flag sent to compacts by other things
82 
83  uint16 screen; // 3: current screen
84  uint16 place; // 4: so's this one
85  uint16 getToTableId; // 5: Address of how to get to things table
86 
87  uint16 xcood; // 6
88  uint16 ycood; // 7
89 
90  uint16 frame; // 8
91 
92  uint16 cursorText; // 9
93  uint16 mouseOn; // 10
94  uint16 mouseOff; // 11
95  uint16 mouseClick; // 12
96 
97  int16 mouseRelX; // 13
98  int16 mouseRelY; // 14
99  uint16 mouseSizeX; // 15
100  uint16 mouseSizeY; // 16
101 
102  uint16 actionScript; // 17
103 
104  uint16 upFlag; // 18: usually holds the Action Mode
105  uint16 downFlag; // 19: used for passing back
106  uint16 getToFlag; // 20: used by action script for get to attempts, also frame store (hence word)
107  uint16 flag; // 21: a use any time flag
108 
109  uint16 mood; // 22: high level - stood or not
110 
111  uint16 grafixProgId; // 23
112  uint16 grafixProgPos;// 24
113 
114  uint16 offset; // 25
115 
116  uint16 mode; // 26: which mcode block
117 
118  uint16 baseSub; // 27: 1st mcode block relative to start of compact
119  uint16 baseSub_off; // 28
120  uint16 actionSub; // 29
121  uint16 actionSub_off;// 30
122  uint16 getToSub; // 31
123  uint16 getToSub_off; // 32
124  uint16 extraSub; // 33
125  uint16 extraSub_off; // 34
126 
127  uint16 dir; // 35
128 
129  uint16 stopScript; // 36
130  uint16 miniBump; // 37
131  uint16 leaving; // 38
132  uint16 atWatch; // 39: pointer to script variable
133  uint16 atWas; // 40: pointer to script variable
134  uint16 alt; // 41: alternate script
135  uint16 request; // 42
136 
137  uint16 spWidth_xx; // 43
138  uint16 spColor; // 44
139  uint16 spTextId; // 45
140  uint16 spTime; // 46
141 
142  uint16 arAnimIndex; // 47
143  uint16 turnProgId; // 48
144  uint16 turnProgPos; // 49
145 
146  uint16 waitingFor; // 50
147 
148  uint16 arTargetX; // 51
149  uint16 arTargetY; // 52
150 
151  uint16 animScratchId;// 53: data area for AR
152 
153  uint16 megaSet; // 54
154 
155  MegaSet megaSet0; // 55
156  MegaSet megaSet1; //
157  MegaSet megaSet2; //
158  MegaSet megaSet3; //
159 } PACKED_STRUCT;
160 
161 #include "common/pack-end.h" // END STRUCT PACKING
162 
163 } // End of namespace Sky
164 
165 #endif
Definition: struc.h:78
Definition: struc.h:27
Definition: struc.h:35
Definition: struc.h:59
Definition: struc.h:51
Definition: autoroute.h:28