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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
from utils import barray_to_u16_hex, barray_to_u32_hex, barray_to_s16
import struct
ROM_OFFSET = 0x08000000
SCRIPTS_START = 0x08008B5C
SCRIPTS_END = 0x08016984
# A list of all the commands, their correspondingScriptCommand_ functions and what kind of parameters they take
commands = [
{'fun': 'ScriptCommandNop', 'params': ''},
{'fun': 'ScriptCommand_BeginBlock', 'params': ''},
{'fun': 'ScriptCommand_EndBlock', 'params': ''},
{'fun': 'ScriptCommand_Jump', 'params': 'j'},
{'fun': 'ScriptCommand_JumpIf', 'params': 'j'},
{'fun': 'ScriptCommand_JumpIfNot', 'params': 'j'},
{'fun': 'ScriptCommand_JumpTable', 'params': ['jj', 'jjj', 'jjjj', 'jjjjjjj', 'jjjjjjjjj']},
{'fun': 'ScriptCommand_JumpAbsolute', 'params': 'x'},
{'fun': 'ScriptCommand_JumpAbsoluteIf', 'params': 'x'},
{'fun': 'ScriptCommand_JumpAbsoluteIfNot', 'params': 'x'},
{'fun': 'ScriptCommand_JumpAbsoluteTable', 'params': 'xx'},
{'fun': 'ScriptCommand_Call', 'params': 'p'},
{'fun': 'ScriptCommand_CallWithArg', 'params': ['px', 'p']},
{'fun': 'ScriptCommand_LoadRoomEntityList', 'params': 'd'},
{'fun': 'ScriptCommand_TestBit', 'params': 'w'},
{'fun': 'ScriptCommand_CheckInventory1', 'params': 's'},
{'fun': 'ScriptCommand_CheckInventory2', 'params': 's'},
{'fun': 'ScriptCommand_HasRoomItemForSale', 'params': ''},
{'fun': 'ScriptCommand_CheckLocalFlag', 'params': 's'},
{'fun': 'ScriptCommand_CheckLocalFlagByOffset', 'params': 'ss'},
{'fun': 'ScriptCommand_CheckGlobalFlag', 'params': 's'},
{'fun': 'ScriptCommand_CheckRoomFlag', 'params': 's'},
{'fun': 'ScriptCommand_CheckPlayerInRegion', 'params': 'sss'},
{'fun': 'ScriptCommand_CheckPlayerInRegion2', 'params': 's'},
{'fun': 'ScriptCommand_CheckEntityInteractType', 'params': ''},
{'fun': 'ScriptCommand_0807E30C', 'params': ''},
{'fun': 'ScriptCommand_HasRupees', 'params': 's'},
{'fun': 'ScriptCommand_0807E3BC', 'params': 's'},
{'fun': 'ScriptCommand_0807E3E8', 'params': ''},
{'fun': 'ScriptCommand_CheckKinstoneFused', 'params': 's'},
{'fun': 'ScriptCommand_BuyItem', 'params': 'ss'},
{'fun': 'ScriptCommand_0807E48C', 'params': 's'},
{'fun': 'ScriptCommand_0807E4CC', 'params': 'w'},
{'fun': 'ScriptCommand_0807E4EC', 'params': 'w'},
{'fun': 'ScriptCommand_0807E514', 'params': 'w'},
{'fun': 'ScriptCommand_CheckPlayerFlags', 'params': 'w'},
{'fun': 'ScriptCommand_0807E564', 'params': ''},
{'fun': 'ScriptCommand_EntityHasHeight', 'params': ''},
{'fun': 'ScriptCommand_ComparePlayerAction', 'params': 's'},
{'fun': 'ScriptCommand_ComparePlayerAnimationState', 'params': 's'},
{'fun': 'ScriptCommand_0807E5F8', 'params': 'w'},
{'fun': 'ScriptCommand_0807E610', 'params': 'w'},
{'fun': 'ScriptCommand_SetLocalFlag', 'params': 's'},
{'fun': 'ScriptCommand_SetLocalFlagByOffset', 'params': 'ss'},
{'fun': 'ScriptCommand_ClearLocalFlag', 'params': 's'},
{'fun': 'ScriptCommand_SetGlobalFlag', 'params': 's'},
{'fun': 'ScriptCommand_ClearGlobalFlag', 'params': 's'},
{'fun': 'ScriptCommand_SetRoomFlag', 'params': 's'},
{'fun': 'ScriptCommand_ClearRoomFlag', 'params': 's'},
{'fun': 'ScriptCommand_Wait', 'params': 's'},
{'fun': 'ScriptCommand_WaitForSomething', 'params': 'w'},
{'fun': 'ScriptCommand_WaitForSomething2', 'params': 'w'},
{'fun': 'ScriptCommand_WaitPlayerAction8', 'params': ''},
{'fun': 'ScriptCommand_WaitForPlayerAction0x17', 'params': ''},
{'fun': 'ScriptCommand_WaitFor_1', 'params': ''},
{'fun': 'ScriptCommand_WaitFor_2', 'params': ''},
{'fun': 'ScriptCommand_0807E778', 'params': 's'},
{'fun': 'ScriptCommand_0807E788', 'params': 'w'},
{'fun': 'ScriptCommand_0807E79C', 'params': ''},
{'fun': 'ScriptCommandNop2', 'params': 's'},
{'fun': 'ScriptCommand_DoFade4', 'params': ''},
{'fun': 'ScriptCommand_DoFade5', 'params': ''},
{'fun': 'ScriptCommand_DoFade6', 'params': ''},
{'fun': 'ScriptCommand_DoFade7', 'params': ''},
{'fun': 'ScriptCommand_0807E800', 'params': 'w'},
{'fun': 'ScriptCommand_0807E80C', 'params': 'w'},
{'fun': 'ScriptCommand_0807E858', 'params': ['s', '']},
{'fun': 'ScriptCommand_0807E864', 'params': ''},
{'fun': 'ScriptCommand_0807E878', 'params': ''},
{'fun': 'ScriptCommand_0807E888', 'params': ''},
{'fun': 'ScriptCommand_SetPlayerAction', 'params': 'w'},
{'fun': 'ScriptCommand_StartPlayerScript', 'params': 'x'},
{'fun': 'ScriptCommand_0807E8D4', 'params': 's'},
{'fun': 'ScriptCommand_0807E8E4_0', 'params': ''}, # duplicate
{'fun': 'ScriptCommand_0807E8E4_1', 'params': ''}, # duplicate
{'fun': 'ScriptCommand_0807E8E4_2', 'params': ''}, # duplicate
{'fun': 'ScriptCommand_0807E8E4_3', 'params': ''}, # duplicate
{'fun': 'ScriptCommand_0807E908', 'params': 's'},
{'fun': 'ScriptCommandSetIntVariable', 'params': 'w'},
{'fun': 'ScriptCommand_0807E924', 'params': ''},
{'fun': 'ScriptCommand_0807E930', 'params': 's'},
{'fun': 'ScriptCommand_0807E944', 'params': ''},
{'fun': 'ScriptCommand_0807E974', 'params': 's'},
{'fun': 'ScriptCommand_0807E9D4', 'params': ''},
{'fun': 'ScriptCommand_0807E9DC', 'params': ''},
{'fun': 'ScriptCommand_0807E9E4', 'params': 's'},
{'fun': 'ScriptCommand_0807E9F0', 'params': ''},
{'fun': 'ScriptCommand_0807EA4C', 'params': ''},
{'fun': 'ScriptCommand_0807EA88', 'params': 's'},
{'fun': 'ScriptCommand_0807EA94', 'params': ''},
{'fun': 'ScriptCommand_TextboxNoOverlapFollow', 'params': 's'},
{'fun': 'ScriptCommand_TextboxNoOverlap', 'params': 's'},
{'fun': 'ScriptCommand_TextboxNoOverlapFollowPos', 'params': ['ss', 's']},
{'fun': 'ScriptCommandTextboxNoOverlapFollowTable', 'params': ['ss', 'sss', 'ssss']},
{'fun': 'ScriptCommand_TextboxNoOverlapVar', 'params': ''},
{'fun': 'ScriptCommand_0807EB28', 'params': 's'},
{'fun': 'ScriptCommand_0807EB38', 'params': ''},
{'fun': 'ScriptCommand_0807EB44', 'params': 's'},
{'fun': 'ScriptCommand_0807EB4C', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EB74', 'params': ''},
{'fun': 'ScriptCommand_0807EB8C', 'params': ''},
{'fun': 'ScriptCommand_SetEntityDirection', 'params': 's'},
{'fun': 'ScriptCommand_SetEntityDirectionWithAnimationState', 'params': 's'},
{'fun': 'ScriptCommand_SetEntityNonPlanarMovement', 'params': 's'},
{'fun': 'ScriptCommand_SetEntity0x20', 'params': 'w'},
{'fun': 'ScriptCommand_SetEntityPositionRelative', 'params': 'ss'},
{'fun': 'ScriptCommand_SetEntityPosition', 'params': 'ss'},
{'fun': 'ScriptCommand_MoveEntityToPlayer', 'params': ''},
{'fun': 'ScriptCommandNop3', 'params': ''},
{'fun': 'ScriptCommand_0807EC1C', 'params': 's'},
{'fun': 'ScriptCommand_0807EC64', 'params': 's'},
{'fun': 'ScriptCommand_0807EC94', 'params': 's'},
{'fun': 'ScriptCommand_0807ECC4', 'params': 's'},
{'fun': 'ScriptCommand_0807ECF4', 'params': 's'},
{'fun': 'ScriptCommand_0807ED24', 'params': 'sss'},
{'fun': 'ScriptCommand_0807EDD4', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EE04', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EE30', 'params': ''},
{'fun': 'ScriptCommand_0807EEB4', 'params': ''},
{'fun': 'ScriptCommand_0807EEF4', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EF3C', 'params': 'ss'},
{'fun': 'ScriptCommand_0807EF80', 'params': 's'},
{'fun': 'ScriptCommand_0807EF90', 'params': 's'},
{'fun': 'ScriptCommand_SoundReq', 'params': 's'},
{'fun': 'ScriptCommand_SoundReq2', 'params': 's'},
{'fun': 'ScriptCommand_SoundReq3', 'params': 'w'},
{'fun': 'ScriptCommand_SoundReq0x80100000', 'params': ''},
{'fun': 'ScriptCommand_ModRupees', 'params': 's'},
{'fun': 'ScriptCommand_ModHealth', 'params': 's'},
{'fun': 'ScriptCommand_IncreaseMaxHealth', 'params': 's'},
{'fun': 'ScriptCommand_0807F034', 'params': 's'},
{'fun': 'ScriptCommand_0807F050', 'params': 's'},
{'fun': 'ScriptCommand_GetInventoryValue', 'params': 's'},
{'fun': 'ScriptCommand_0807F078', 'params': 'ss'},
{'fun': 'ScriptCommand_0807F088', 'params': 's'},
{'fun': 'ScriptCommand_CameraTargetEntity', 'params': ''},
{'fun': 'ScriptCommand_CameraTargetPlayer', 'params': ''},
{'fun': 'ScriptCommand_0807F0B4', 'params': 's'},
{'fun': 'ScriptCommand_0807F0C8', 'params': 'ss'}
]
# Functions that have already been renamed
POINTER_MAP = {
'sub_08095458': 'nullsub_527',
'sub_0805EBCC': 'DeleteAllEnemies',
'sub_0806C23C': 'Simon_CreateChest',
'sub_0801637C': 'script_0801637C+1',
'sub_08016383': 'script_08016384',
'sub_0806C598': 'sub_0806C598',
'sub_080A2138': 'Windcrest_Unlock',
'sub_080A29BC': 'CreateDust'
}
def get_pointer(barray):
# tries to directly reference the function this is pointing to
integers = struct.unpack('I', barray)
pointer = 'sub_' + (struct.pack('>I', integers[0]-1).hex()).upper()
if pointer in POINTER_MAP:
return POINTER_MAP[pointer]
return pointer
# Data pointers that actually point to a script location
DATA_MAP = {
'gUnk_08016384': 'script_08016384'
}
def get_data_pointer(barray):
integers = struct.unpack('I', barray)
pointer = 'gUnk_' + (struct.pack('>I', integers[0]).hex()).upper()
if pointer in DATA_MAP:
return DATA_MAP[pointer]
return pointer
def get_script_pointer(barray):
integers = struct.unpack('I', barray)
val = integers[0]
if val >= SCRIPTS_START and val <= SCRIPTS_END:
return 'script_' + (struct.pack('>I', val).hex()).upper()
else:
return '0x'+struct.pack('>I', val).hex()
def get_script_label(u32):
return hex(u32).upper().replace('0X', 'script_0')
# Collects a set of all the labels that were jumped to
used_labels = set()
def use_script_label(u32):
global used_labels
used_labels.add(u32)
label = get_script_label(u32)
return label
# definitions for parameter types
parameters = {
'': {
'length': 0,
'param': '',
'expr': '',
'read': lambda ctx: ''
},
's': {
'length': 1,
'param': 's',
'expr': ' .short \s',
'read': lambda ctx: barray_to_u16_hex(ctx.data[ctx.ptr + 2:ctx.ptr + 4])[0]
},
'ss': {
'length': 2,
'param': 'a,b',
'expr': ' .short \\a\n .short \\b',
'read': lambda ctx: ', '.join(barray_to_u16_hex(ctx.data[ctx.ptr + 2:ctx.ptr + 6]))
},
'sss': {
'length': 3,
'param': 'a,b,c',
'expr': ' .short \\a\n .short \\b\n .short \\c',
'read': lambda ctx: ', '.join(barray_to_u16_hex(ctx.data[ctx.ptr + 2:ctx.ptr + 8]))
},
'ssss': {
'length': 4,
'param': 'a,b,c,d',
'expr': ' .short \\a\n .short \\b\n .short \\c\n .short \\d',
'read': lambda ctx: ', '.join(barray_to_u16_hex(ctx.data[ctx.ptr + 2:ctx.ptr + 10]))
},
'w': {
'length': 2,
'param': 'w',
'expr': ' .word \w',
'read': lambda ctx: barray_to_u32_hex(ctx.data[ctx.ptr + 2:ctx.ptr + 6])[0]
},
'ww': {
'length': 4,
'param': 'a,b',
'expr': ' .word \\a\n .word \\b',
'read': lambda ctx: ', '.join(barray_to_u32_hex(ctx.data[ctx.ptr + 2:ctx.ptr + 10]))
},
'j': { # Relative jump target
'length': 1,
'param': 's',
'expr': '1: .short \s - 1b',
'read': lambda ctx: use_script_label(ctx.script_addr + ctx.ptr + 2 + barray_to_s16(ctx.data[ctx.ptr + 2:ctx.ptr + 4]))
},
'jj': {
'length': 2,
'param': 'a,b',
'expr': '1: .short \\a - 1b\n .short \\b - 1b - 2',
'read': lambda ctx: ', '.join([use_script_label(ctx.script_addr + ctx.ptr + 2 + barray_to_s16(ctx.data[ctx.ptr + x * 2 + 2:ctx.ptr + x * 2 + 4]) + x * 2) for x in range(0, 2)])
},
'jjj': {
'length': 3,
'param': 'a,b,c',
'expr': '1: .short \\a - 1b\n .short \\b - 1b - 2\n .short \\c - 1b - 4',
'read': lambda ctx: ', '.join([use_script_label(ctx.script_addr + ctx.ptr + 2 + barray_to_s16(ctx.data[ctx.ptr + x * 2 + 2:ctx.ptr + x * 2 + 4]) + x*2) for x in range(0, 3)])
},
'jjjj': {
'length': 4,
'param': 'a,b,c,d',
'expr': '1: .short \\a - 1b\n .short \\b - 1b - 2\n .short \\c - 1b - 4\n .short \\d - 1b - 6',
'read': lambda ctx: ', '.join([use_script_label(ctx.script_addr + ctx.ptr + 2 + barray_to_s16(ctx.data[ctx.ptr + x * 2 + 2:ctx.ptr + x * 2 + 4]) + x*2) for x in range(0, 4)])
},
'jjjjjjj': {
'length': 7,
'param': 'a,b,c,d,e,f,g',
'expr': '1: .short \\a - 1b\n .short \\b - 1b - 2\n .short \\c - 1b - 4\n .short \\d - 1b - 6\n .short \\e - 1b - 8\n .short \\f - 1b - 10\n .short \\g - 1b - 12',
'read': lambda ctx: ', '.join([use_script_label(ctx.script_addr + ctx.ptr + 2 + barray_to_s16(ctx.data[ctx.ptr + x * 2 + 2:ctx.ptr + x * 2 + 4]) + x*2) for x in range(0, 7)])
},
'jjjjjjjjj': {
'length': 9,
'param': 'a,b,c,d,e,f,g,h,i',
'expr': '1: .short \\a - 1b\n .short \\b - 1b - 2\n .short \\c - 1b - 4\n .short \\d - 1b - 6\n .short \\e - 1b - 8\n .short \\f - 1b - 10\n .short \\g - 1b - 12\n .short \\h - 1b - 14\n .short \\i - 1b - 16',
'read': lambda ctx: ', '.join([use_script_label(ctx.script_addr + ctx.ptr + 2 + barray_to_s16(ctx.data[ctx.ptr + x * 2 + 2:ctx.ptr + x * 2 + 4]) + x*2) for x in range(0, 9)])
},
'p': {
'length': 2,
'param': 'w',
'expr': ' .word \w',
'read': lambda ctx: get_pointer(ctx.data[ctx.ptr + 2:ctx.ptr + 6])
},
'px': {
'length': 4,
'param': 'a,b',
'expr': ' .word \\a\n .word \\b',
'read': lambda ctx: get_pointer(ctx.data[ctx.ptr + 2:ctx.ptr + 6]) + ', ' + get_script_pointer(ctx.data[ctx.ptr + 6:ctx.ptr + 10])
},
'd': { # Data pointer
'length': 2,
'param': 'w',
'expr': ' .word \w',
'read': lambda ctx: get_data_pointer(ctx.data[ctx.ptr + 2:ctx.ptr + 6])
},
'x': { # Script pointer
'length': 2,
'param': 'w',
'expr': ' .word \w',
'read': lambda ctx: get_script_pointer(ctx.data[ctx.ptr + 2:ctx.ptr + 6])
},
'xx': {
'length': 4,
'param': 'a, b',
'expr': ' .word \\a\n .word \\b',
'read': lambda ctx: get_script_pointer(ctx.data[ctx.ptr + 2:ctx.ptr + 6]) + ', ' + get_script_pointer(ctx.data[ctx.ptr + 6:ctx.ptr + 10])
},
# Commands with variable parameter count are now handled by explicitely defining all used parameter configurations
# 'v': {
# 'length': -1,
# 'param': '',
# 'expr': '',
# 'read': lambda ctx: ''
# },
# 'pv': {
# 'length': -2,
# 'param': 'w',
# 'expr': ' .word \w',
# 'read': lambda ctx: ''
# },
}
|
