Skip to main content

runec/
opcodes.rs

1//! The opcode of every instruction and engine command, the same at every revision.
2//! A revision's `command.pack` lists the commands it has, each at its opcode here.
3
4macro_rules! opcodes {
5    ($($constant:ident = $opcode:literal => $command:literal $(| $alias:literal)*;)*) => {
6        $(pub const $constant: u16 = $opcode;)*
7
8        /// Every name a `command.pack` may give a command, with its opcode.
9        pub const COMMANDS: &[(&str, u16)] = &[$(($command, $opcode), $(($alias, $opcode),)*)*];
10
11        #[cfg(test)]
12        const CONSTANTS: &[(&str, &str)] = &[$((stringify!($constant), $command),)*];
13    };
14}
15
16opcodes! {
17    // Instructions the compiler emits
18    PUSH_CONSTANT_INT = 0 => "push_constant_int";
19    PUSH_VARP = 1 => "push_varp";
20    POP_VARP = 2 => "pop_varp";
21    PUSH_CONSTANT_STRING = 3 => "push_constant_string";
22    PUSH_VARN = 4 => "push_varn";
23    POP_VARN = 5 => "pop_varn";
24    BRANCH = 6 => "branch";
25    BRANCH_NOT = 7 => "branch_not";
26    BRANCH_EQUALS = 8 => "branch_equals";
27    BRANCH_LESS_THAN = 9 => "branch_less_than";
28    BRANCH_GREATER_THAN = 10 => "branch_greater_than";
29    PUSH_VARS = 11 => "push_vars";
30    POP_VARS = 12 => "pop_vars";
31    RETURN = 21 => "return";
32    GOSUB = 22 => "gosub";
33    JUMP = 23 => "jump";
34    SWITCH = 24 => "switch";
35    PUSH_VARPBIT = 25 => "push_varpbit";
36    POP_VARPBIT = 27 => "pop_varpbit";
37    BRANCH_LESS_THAN_OR_EQUALS = 31 => "branch_less_than_or_equals";
38    BRANCH_GREATER_THAN_OR_EQUALS = 32 => "branch_greater_than_or_equals";
39    PUSH_INT_LOCAL = 33 => "push_int_local";
40    POP_INT_LOCAL = 34 => "pop_int_local";
41    PUSH_STRING_LOCAL = 35 => "push_string_local";
42    POP_STRING_LOCAL = 36 => "pop_string_local";
43    JOIN_STRING = 37 => "join_string";
44    POP_INT_DISCARD = 38 => "pop_int_discard";
45    POP_STRING_DISCARD = 39 => "pop_string_discard";
46    GOSUB_WITH_PARAMS = 40 => "gosub_with_params";
47    JUMP_WITH_PARAMS = 41 => "jump_with_params";
48    PUSH_VARC_INT = 42 => "push_varc_int";
49    POP_VARC_INT = 43 => "pop_varc_int";
50    DEFINE_ARRAY = 44 => "define_array";
51    PUSH_ARRAY_INT = 45 => "push_array_int";
52    POP_ARRAY_INT = 46 => "pop_array_int";
53    PUSH_VARC_STRING = 47 => "push_varc_string";
54    POP_VARC_STRING = 48 => "pop_varc_string";
55    PUSH_CONSTANT_LONG = 54 => "push_constant_long";
56    PUSH_LONG_LOCAL = 55 => "push_long_local";
57    POP_LONG_LOCAL = 56 => "pop_long_local";
58    POP_LONG_DISCARD = 57 => "pop_long_discard";
59    LONG_BRANCH_NOT = 68 => "long_branch_not";
60    LONG_BRANCH_EQUALS = 69 => "long_branch_equals";
61    LONG_BRANCH_LESS_THAN = 70 => "long_branch_less_than";
62    LONG_BRANCH_GREATER_THAN = 71 => "long_branch_greater_than";
63    LONG_BRANCH_LESS_THAN_OR_EQUALS = 72 => "long_branch_less_than_or_equals";
64    LONG_BRANCH_GREATER_THAN_OR_EQUALS = 73 => "long_branch_greater_than_or_equals";
65    PUSH_VARCLAN = 74 => "push_varclan";
66    POP_VARCLAN = 75 => "pop_varclan";
67    PUSH_VAROBJ = 76 => "push_varobj";
68    POP_VAROBJ = 77 => "pop_varobj";
69    PUSH_VARNBIT = 78 => "push_varnbit";
70    POP_VARNBIT = 79 => "pop_varnbit";
71    PUSH_VARCON = 80 => "push_varcon";
72    POP_VARCON = 81 => "pop_varcon";
73    POP_CLANSETTING_INT = 82 => "pop_clansetting_int";
74    POP_CLANSETTING_VARBIT = 83 => "pop_clansetting_varbit";
75    POP_CLANSETTING_LONG = 84 => "pop_clansetting_long";
76    POP_CLANSETTING_STRING = 85 => "pop_clansetting_string";
77    OBJ_BRANCH_EQUALS = 86 => "obj_branch_equals";
78    OBJ_BRANCH_NOT = 87 => "obj_branch_not";
79    PUSH_VARCONBIT = 88 => "push_varconbit";
80    POP_VARCONBIT = 89 => "pop_varconbit";
81    PUSH_VARCLAN_BIT = 90 => "push_varclan_bit";
82    PUSH_VARCLAN_LONG = 91 => "push_varclan_long";
83    PUSH_VARCLAN_STRING = 92 => "push_varclan_string";
84    PUSH_VARPLAYER = 93 => "push_varplayer";
85    PUSH_VARPLAYER_BIT = 94 => "push_varplayer_bit";
86    PUSH_VARNPC = 95 => "push_varnpc";
87    PUSH_VARNPC_BIT = 96 => "push_varnpc_bit";
88    PUSH_CLANSETTING_INT = 112 => "push_clansetting_int";
89    PUSH_CLANSETTING_VARBIT = 113 => "push_clansetting_varbit";
90    PUSH_CLANSETTING_LONG = 114 => "push_clansetting_long";
91    PUSH_CLANSETTING_STRING = 115 => "push_clansetting_string";
92
93    // Server
94    COORDX = 1000 => "coordx";
95    COORDY = 1001 => "coordy";
96    COORDZ = 1002 => "coordz";
97    DISTANCE = 1003 => "distance";
98    INZONE = 1004 => "inzone";
99    LINEOFSIGHT = 1005 => "lineofsight";
100    LINEOFWALK = 1006 => "lineofwalk";
101    MAP_BLOCKED = 1007 => "map_blocked";
102    MAP_CLOCK = 1008 => "map_clock";
103    MAP_FINDSQUARE = 1009 => "map_findsquare";
104    MAP_INDOORS = 1010 => "map_indoors";
105    MAP_LIVE = 1011 => "map_live";
106    MAP_LOCADDUNSAFE = 1012 => "map_locaddunsafe";
107    MAP_MEMBERS = 1013 => "map_members";
108    MAP_MULTIWAY = 1014 => "map_multiway";
109    MAP_PLAYERCOUNT = 1015 => "map_playercount";
110    MOVECOORD = 1016 => "movecoord";
111    PLAYERCOUNT = 1017 => "playercount";
112    PROJANIM_MAP = 1018 => "projanim_map";
113    SEQLENGTH = 1019 => "seqlength";
114    SPOTANIM_MAP = 1020 => "spotanim_map";
115    WORLD_DELAY = 1021 => "world_delay";
116    MIDI_LENGTH = 1022 => "midi_length";
117    MAP_LOC = 1023 => "map_loc";
118    SOUND_AREA = 1024 => "sound_area";
119    INAREA = 1025 => "inarea";
120    PROJANIM_HALFSQ = 1026 => "projanim_halfsq";
121    SOUND_VORBIS_AREA = 1027 => "sound_vorbis_area";
122    TEXT_COORD = 1028 => "text_coord";
123
124    // Player
125    AFK_EVENT = 2000 => "afk_event";
126    ALLOWDESIGN = 2001 => "allowdesign";
127    ANIM = 2002 => "anim";
128    BOTH_HEROPOINTS = 2003 => "both_heropoints";
129    BUILDAPPEARANCE = 2004 => "buildappearance";
130    BUSY = 2005 => "busy";
131    BUSY2 = 2006 => "busy2";
132    CAM_LOOKAT = 2007 => "cam_lookat";
133    CAM_MOVETO = 2008 => "cam_moveto";
134    CAM_RESET = 2009 => "cam_reset";
135    CAM_SHAKE = 2010 => "cam_shake";
136    CLEARQUEUE = 2011 => "clearqueue";
137    CLEARSOFTTIMER = 2012 => "clearsofttimer";
138    CLEARTIMER = 2013 => "cleartimer";
139    COORD = 2014 => "coord";
140    DAMAGE = 2015 => "damage";
141    DISPLAYNAME = 2016 => "displayname";
142    FACESQUARE = 2017 => "facesquare";
143    FINDHERO = 2018 => "findhero";
144    FINDUID = 2019 => "finduid";
145    GENDER = 2020 => "gender";
146    GETQUEUE = 2021 => "getqueue";
147    GETTIMER = 2022 => "gettimer";
148    GETWALKTRIGGER = 2023 => "getwalktrigger";
149    HEADICONS_GET = 2024 => "headicons_get";
150    HEADICONS_SET = 2025 => "headicons_set";
151    HEALENERGY = 2026 => "healenergy";
152    HINT_COORD = 2027 => "hint_coord";
153    HINT_NPC = 2028 => "hint_npc";
154    HINT_PL = 2029 => "hint_pl";
155    HINT_STOP = 2030 => "hint_stop";
156    HUNTALL = 2031 => "huntall";
157    HUNTNEXT = 2032 => "huntnext";
158    IF_CLOSE = 2033 => "if_close";
159    IF_OPENCHAT = 2034 => "if_openchat";
160    IF_OPENMAIN_SIDE = 2035 => "if_openmain_side";
161    IF_OPENMAIN = 2036 => "if_openmain";
162    IF_OPENSIDE = 2037 => "if_openside";
163    IF_SETANIM = 2038 => "if_setanim";
164    IF_SETCOLOUR = 2039 => "if_setcolour";
165    IF_SETHIDE = 2040 => "if_sethide";
166    IF_SETMODEL = 2041 => "if_setmodel";
167    IF_SETNPCHEAD = 2042 => "if_setnpchead";
168    IF_SETOBJECT = 2043 => "if_setobject";
169    IF_SETPLAYERHEAD = 2044 => "if_setplayerhead";
170    IF_SETPOSITION = 2045 => "if_setposition";
171    IF_SETRECOL = 2046 => "if_setrecol";
172    IF_SETRESUMEBUTTONS = 2047 => "if_setresumebuttons";
173    IF_SETTAB = 2048 => "if_settab";
174    IF_SETTABACTIVE = 2049 => "if_settabactive";
175    IF_SETTEXT = 2050 => "if_settext";
176    LAST_COM = 2051 => "last_com";
177    LAST_INT = 2052 => "last_int";
178    LAST_ITEM = 2053 => "last_item";
179    LAST_LOGIN_INFO = 2054 => "last_login_info";
180    LAST_SLOT = 2055 => "last_slot";
181    LAST_TARGETSLOT = 2056 => "last_targetslot";
182    LAST_USEITEM = 2057 => "last_useitem";
183    LAST_USESLOT = 2058 => "last_useslot";
184    LONGQUEUE = 2059 => "longqueue";
185    LONGQUEUEVARARG = 2060 => "longqueuevararg" | "longqueue*";
186    LOWMEM = 2061 => "lowmem";
187    MES = 2062 => "mes";
188    MIDI_JINGLE = 2063 => "midi_jingle";
189    MIDI_SONG = 2064 => "midi_song";
190    NAME = 2065 => "name";
191    P_ANIMPROTECT = 2066 => "p_animprotect";
192    P_APRANGE = 2067 => "p_aprange";
193    P_ARRIVEDELAY = 2068 => "p_arrivedelay";
194    P_CLEARPENDINGACTION = 2069 => "p_clearpendingaction";
195    P_COUNTDIALOG = 2070 => "p_countdialog";
196    P_DELAY = 2071 => "p_delay";
197    P_EXACTMOVE = 2072 => "p_exactmove";
198    P_FINDUID = 2073 => "p_finduid";
199    P_LOCMERGE = 2074 => "p_locmerge";
200    P_LOGOUT = 2075 => "p_logout";
201    P_OPHELD = 2076 => "p_opheld";
202    P_OPLOC = 2077 => "p_oploc";
203    P_OPNPC = 2078 => "p_opnpc";
204    P_OPNPCT = 2079 => "p_opnpct";
205    P_OPOBJ = 2080 => "p_opobj";
206    P_OPPLAYER = 2081 => "p_opplayer";
207    P_OPPLAYERT = 2082 => "p_opplayert";
208    P_PAUSEBUTTON = 2083 => "p_pausebutton";
209    P_PREVENTLOGOUT = 2084 => "p_preventlogout";
210    P_RUN = 2085 => "p_run";
211    P_STOPACTION = 2086 => "p_stopaction";
212    P_TELEJUMP = 2087 => "p_telejump";
213    P_TELEPORT = 2088 => "p_teleport";
214    P_WALK = 2089 => "p_walk";
215    PLAYERMEMBER = 2090 => "playermember";
216    PROJANIM_PL = 2091 => "projanim_pl";
217    QUEUE = 2092 => "queue";
218    QUEUEVARARG = 2093 => "queuevararg" | "queue*";
219    READYANIM = 2094 => "readyanim";
220    RUNANIM = 2095 => "runanim";
221    RUNENERGY = 2096 => "runenergy";
222    SAY = 2097 => "say";
223    SESSION_LOG = 2098 => "session_log";
224    SETGENDER = 2099 => "setgender";
225    SETIDKIT = 2100 => "setidkit";
226    SETSKINCOLOUR = 2101 => "setskincolour";
227    SETTIMER = 2102 => "settimer";
228    SOFTTIMER = 2103 => "softtimer";
229    SOUND_SYNTH = 2104 => "sound_synth";
230    SPOTANIM_PL = 2105 => "spotanim_pl";
231    STAFFMODLEVEL = 2106 => "staffmodlevel";
232    STAT_ADD = 2107 => "stat_add";
233    STAT_ADVANCE = 2108 => "stat_advance";
234    STAT_BASE = 2109 => "stat_base";
235    STAT_BOOST = 2110 => "stat_boost";
236    STAT_DRAIN = 2111 => "stat_drain";
237    STAT_HEAL = 2112 => "stat_heal";
238    STAT_RANDOM = 2113 => "stat_random";
239    STAT_SUB = 2114 => "stat_sub";
240    STAT_TOTAL = 2115 => "stat_total";
241    STAT = 2116 => "stat";
242    STRONGQUEUE = 2117 => "strongqueue";
243    STRONGQUEUEVARARG = 2118 => "strongqueuevararg" | "strongqueue*";
244    TURNANIM = 2119 => "turnanim";
245    TUT_CLOSE = 2120 => "tut_close";
246    TUT_FLASH = 2121 => "tut_flash";
247    TUT_OPEN = 2122 => "tut_open";
248    UID = 2123 => "uid";
249    WALKANIM_B = 2124 => "walkanim_b";
250    WALKANIM_L = 2125 => "walkanim_l";
251    WALKANIM_R = 2126 => "walkanim_r";
252    WALKANIM = 2127 => "walkanim";
253    WALKTRIGGER = 2128 => "walktrigger";
254    WEAKQUEUE = 2129 => "weakqueue";
255    WEAKQUEUEVARARG = 2130 => "weakqueuevararg" | "weakqueue*";
256    WEALTH_EVENT = 2131 => "wealth_event";
257    WEIGHT = 2132 => "weight";
258    SETIDKCOLOUR = 2133 => "setidkcolour";
259    BUFFER_FULL = 2134 => "buffer_full";
260    LOWMEMORY = 2135 => "lowmemory";
261    HINT_PLAYER = 2136 => "hint_player";
262    BAS_RUNNING = 2137 => "bas_running";
263    BAS_READYANIM = 2138 => "bas_readyanim";
264    BAS_WALK_F = 2139 => "bas_walk_f";
265    BAS_WALK_B = 2140 => "bas_walk_b";
266    BAS_WALK_L = 2141 => "bas_walk_l";
267    BAS_WALK_R = 2142 => "bas_walk_r";
268    BAS_TURNONSPOT = 2143 => "bas_turnonspot";
269    IF_SETSCROLLPOS = 2144 => "if_setscrollpos";
270    IF_OPENOVERLAY = 2145 => "if_openoverlay";
271    PLAYER_FINDALLZONE = 2146 => "player_findallzone";
272    PLAYER_FINDNEXT = 2147 => "player_findnext";
273    SET_PLAYER_OP = 2148 => "set_player_op";
274    IF_ADDRESUMEBUTTON = 2149 => "if_addresumebutton";
275    MINIMAP_TOGGLE = 2150 => "minimap_toggle";
276    SET_SKILL_LEVEL = 2151 => "set_skill_level";
277    P_TRANSMOGRIFY = 2152 => "p_transmogrify";
278    P_TEMPRUN = 2153 => "p_temprun";
279    P_PROJANIM_HALFSQ = 2154 => "p_projanim_halfsq";
280    P_LOADDELAY = 2155 => "p_loaddelay";
281    APPLYDESIGN = 2156 => "applydesign";
282    GETWINDOWMODE = 2157 => "getwindowmode";
283    HINT_COORD_SLOT = 2158 => "hint_coord_slot";
284    HINT_NPC_SLOT = 2159 => "hint_npc_slot";
285    HINT_STOP_SLOT = 2160 => "hint_stop_slot";
286    IF_CLOSESUB = 2161 => "if_closesub";
287    IF_MOVESUB = 2162 => "if_movesub";
288    IF_OPENMAINOVERLAY = 2163 => "if_openmainoverlay";
289    IF_OPENSUB = 2164 => "if_opensub";
290    IF_OPENTOP = 2165 => "if_opentop";
291    IF_OPENTOP_MODE = 2166 => "if_opentop_mode";
292    IF_SETEVENTS = 2167 => "if_setevents";
293    IF_SETGRAPHIC = 2168 => "if_setgraphic";
294    LAST_COORD = 2169 => "last_coord";
295    LAST_STRING = 2170 => "last_string";
296    LAST_TARGETCOM = 2171 => "last_targetcom";
297    MES_TYPED = 2172 => "mes_typed";
298    MUSIC_PLAYJINGLE = 2173 => "music_playjingle";
299    MUSIC_PLAYSONG = 2174 => "music_playsong";
300    P_CLANFORUMQFCDIALOG = 2175 => "p_clanforumqfcdialog";
301    P_GET_SUGGESTION = 2176 => "p_get_suggestion";
302    P_HSLDIALOG = 2177 => "p_hsldialog";
303    P_NAMEDIALOG = 2178 => "p_namedialog";
304    P_NEXT_SUGGESTIONS = 2179 => "p_next_suggestions";
305    P_OBJDIALOG = 2180 => "p_objdialog";
306    P_PREV_SUGGESTIONS = 2181 => "p_prev_suggestions";
307    P_REQUEST_MORE_SUGGESTIONS = 2182 => "p_request_more_suggestions";
308    P_REST = 2183 => "p_rest";
309    P_SETDISPLAYNAME = 2184 => "p_setdisplayname";
310    P_STRINGDIALOG = 2185 => "p_stringdialog";
311    RUNCLIENTSCRIPT = 2186 => "runclientscript";
312    RUNCLIENTSCRIPTVARARG = 2187 => "runclientscriptvararg";
313    SOUND_SPEECH_STOP = 2188 => "sound_speech_stop";
314    SOUND_SPEECH_VOLUME = 2189 => "sound_speech_volume";
315
316    // Npc
317    NPC_ADD = 2500 => "npc_add";
318    NPC_ANIM = 2501 => "npc_anim";
319    NPC_ARRIVEDELAY = 2502 => "npc_arrivedelay";
320    NPC_ATTACKRANGE = 2503 => "npc_attackrange";
321    NPC_BASESTAT = 2504 => "npc_basestat";
322    NPC_CATEGORY = 2505 => "npc_category";
323    NPC_CHANGETYPE_KEEPALL = 2506 => "npc_changetype_keepall";
324    NPC_CHANGETYPE = 2507 => "npc_changetype";
325    NPC_COORD = 2508 => "npc_coord";
326    NPC_DAMAGE = 2509 => "npc_damage";
327    NPC_DEL = 2510 => "npc_del";
328    NPC_DELAY = 2511 => "npc_delay";
329    NPC_FACESQUARE = 2512 => "npc_facesquare";
330    NPC_FIND = 2513 => "npc_find";
331    NPC_FINDALL = 2514 => "npc_findall";
332    NPC_FINDALLANY = 2515 => "npc_findallany";
333    NPC_FINDALLZONE = 2516 => "npc_findallzone";
334    NPC_FINDCAT = 2517 => "npc_findcat";
335    NPC_FINDEXACT = 2518 => "npc_findexact";
336    NPC_FINDHERO = 2519 => "npc_findhero";
337    NPC_FINDNEXT = 2520 => "npc_findnext";
338    NPC_FINDUID = 2521 => "npc_finduid";
339    NPC_GETMODE = 2522 => "npc_getmode";
340    NPC_HASOP = 2523 => "npc_hasop";
341    NPC_HEROPOINTS = 2524 => "npc_heropoints";
342    NPC_HUNT = 2525 => "npc_hunt";
343    NPC_HUNTALL = 2526 => "npc_huntall";
344    NPC_INRANGE = 2527 => "npc_inrange";
345    NPC_NAME = 2528 => "npc_name";
346    NPC_PARAM = 2529 => "npc_param";
347    NPC_QUEUE = 2530 => "npc_queue";
348    NPC_RANGE = 2531 => "npc_range";
349    NPC_SAY = 2532 => "npc_say";
350    NPC_SETHUNT = 2533 => "npc_sethunt";
351    NPC_SETHUNTMODE = 2534 => "npc_sethuntmode";
352    NPC_SETMODE = 2535 => "npc_setmode";
353    NPC_SETTIMER = 2536 => "npc_settimer";
354    NPC_STAT = 2537 => "npc_stat";
355    NPC_STATADD = 2538 => "npc_statadd";
356    NPC_STATHEAL = 2539 => "npc_statheal";
357    NPC_STATSUB = 2540 => "npc_statsub";
358    NPC_TELE = 2541 => "npc_tele";
359    NPC_TYPE = 2542 => "npc_type";
360    NPC_UID = 2543 => "npc_uid";
361    NPC_WALK = 2544 => "npc_walk";
362    NPC_WALKTRIGGER = 2545 => "npc_walktrigger";
363    PROJANIM_NPC = 2546 => "projanim_npc";
364    SPOTANIM_NPC = 2547 => "spotanim_npc";
365    NPC_DESTINATION = 2548 => "npc_destination";
366    NPC_HUNTNEXT = 2549 => "npc_huntnext";
367    NPC_PROJANIM_HALFSQ = 2550 => "npc_projanim_halfsq";
368    NPC_QUEUEVARARG = 2551 => "npc_queuevararg";
369    NPC_RUN = 2552 => "npc_run";
370
371    // Loc
372    LOC_ADD = 3000 => "loc_add";
373    LOC_ANGLE = 3001 => "loc_angle";
374    LOC_ANIM = 3002 => "loc_anim";
375    LOC_CATEGORY = 3003 => "loc_category";
376    LOC_CHANGE = 3004 => "loc_change";
377    LOC_COORD = 3005 => "loc_coord";
378    LOC_DEL = 3006 => "loc_del";
379    LOC_FIND = 3007 => "loc_find";
380    LOC_FINDALLZONE = 3008 => "loc_findallzone";
381    LOC_FINDNEXT = 3009 => "loc_findnext";
382    LOC_NAME = 3010 => "loc_name";
383    LOC_PARAM = 3011 => "loc_param";
384    LOC_SHAPE = 3012 => "loc_shape";
385    LOC_TYPE = 3013 => "loc_type";
386    LOC_PREFETCH = 3014 => "loc_prefetch";
387    LOC_PREFETCHALL = 3015 => "loc_prefetchall";
388    LOC_MERGE = 3016 => "loc_merge";
389
390    // Obj
391    OBJ_ADD = 3500 => "obj_add";
392    OBJ_ADDALL = 3501 => "obj_addall";
393    OBJ_COORD = 3502 => "obj_coord";
394    OBJ_COUNT = 3503 => "obj_count";
395    OBJ_DEL = 3504 => "obj_del";
396    OBJ_FIND = 3505 => "obj_find";
397    OBJ_FINDALLZONE = 3506 => "obj_findallzone";
398    OBJ_FINDNEXT = 3507 => "obj_findnext";
399    OBJ_NAME = 3508 => "obj_name";
400    OBJ_PARAM = 3509 => "obj_param";
401    OBJ_TAKEITEM = 3510 => "obj_takeitem";
402    OBJ_TYPE = 3511 => "obj_type";
403    OBJ_GETVAR = 3512 => "obj_getvar";
404    OBJ_SETVAR = 3513 => "obj_setvar";
405
406    // Npc config
407    NC_CATEGORY = 4000 => "nc_category";
408    NC_DEBUGNAME = 4001 => "nc_debugname";
409    NC_DESC = 4002 => "nc_desc";
410    NC_NAME = 4003 => "nc_name";
411    NC_OP = 4004 => "nc_op";
412    NC_PARAM = 4005 => "nc_param";
413    NC_SIZE = 4006 => "nc_size";
414    NC_VISLEVEL = 4007 => "nc_vislevel";
415
416    // Loc config
417    LC_CATEGORY = 4100 => "lc_category";
418    LC_DEBUGNAME = 4101 => "lc_debugname";
419    LC_DESC = 4102 => "lc_desc";
420    LC_LENGTH = 4103 => "lc_length";
421    LC_NAME = 4104 => "lc_name";
422    LC_OP = 4105 => "lc_op";
423    LC_PARAM = 4106 => "lc_param";
424    LC_WIDTH = 4107 => "lc_width";
425
426    // Obj config
427    OC_CATEGORY = 4200 => "oc_category";
428    OC_CERT = 4201 => "oc_cert";
429    OC_COST = 4202 => "oc_cost";
430    OC_DEBUGNAME = 4203 => "oc_debugname";
431    OC_DESC = 4204 => "oc_desc";
432    OC_IOP = 4205 => "oc_iop";
433    OC_MEMBERS = 4206 => "oc_members";
434    OC_NAME = 4207 => "oc_name";
435    OC_OP = 4208 => "oc_op";
436    OC_PARAM = 4209 => "oc_param";
437    OC_STACKABLE = 4210 => "oc_stackable";
438    OC_TRADEABLE = 4211 => "oc_tradeable";
439    OC_UNCERT = 4212 => "oc_uncert";
440    OC_WEARPOS = 4213 => "oc_wearpos";
441    OC_WEARPOS2 = 4214 => "oc_wearpos2";
442    OC_WEARPOS3 = 4215 => "oc_wearpos3";
443    OC_WEIGHT = 4216 => "oc_weight";
444
445    // Inventory
446    BOTH_DROPSLOT = 4300 => "both_dropslot";
447    BOTH_MOVEINV = 4301 => "both_moveinv";
448    INV_ADD = 4302 => "inv_add";
449    INV_ALLSTOCK = 4303 => "inv_allstock";
450    INV_CHANGESLOT = 4304 => "inv_changeslot";
451    INV_CLEAR = 4305 => "inv_clear";
452    INV_DEBUGNAME = 4306 => "inv_debugname";
453    INV_DEL = 4307 => "inv_del";
454    INV_DELSLOT = 4308 => "inv_delslot";
455    INV_DROPALL = 4309 => "inv_dropall";
456    INV_DROPITEM_DELAYED = 4310 => "inv_dropitem_delayed";
457    INV_DROPITEM = 4311 => "inv_dropitem";
458    INV_DROPSLOT = 4312 => "inv_dropslot";
459    INV_FREESPACE = 4313 => "inv_freespace";
460    INV_GETNUM = 4314 => "inv_getnum";
461    INV_GETOBJ = 4315 => "inv_getobj";
462    INV_ITEMSPACE = 4316 => "inv_itemspace";
463    INV_ITEMSPACE2 = 4317 => "inv_itemspace2";
464    INV_MOVEFROMSLOT = 4318 => "inv_movefromslot";
465    INV_MOVEITEM_CERT = 4319 => "inv_moveitem_cert";
466    INV_MOVEITEM_UNCERT = 4320 => "inv_moveitem_uncert";
467    INV_MOVEITEM = 4321 => "inv_moveitem";
468    INV_MOVETOSLOT = 4322 => "inv_movetoslot";
469    INV_SETSLOT = 4323 => "inv_setslot";
470    INV_SIZE = 4324 => "inv_size";
471    INV_STOCKBASE = 4325 => "inv_stockbase";
472    INV_STOPTRANSMIT = 4326 => "inv_stoptransmit";
473    INV_TOTAL = 4327 => "inv_total";
474    INV_TOTALCAT = 4328 => "inv_totalcat";
475    INV_TOTALPARAM_STACK = 4329 => "inv_totalparam_stack";
476    INV_TOTALPARAM = 4330 => "inv_totalparam";
477    INV_TRANSMIT = 4331 => "inv_transmit";
478    INVOTHER_TRANSMIT = 4332 => "invother_transmit";
479    INV_GETVAR = 4333 => "inv_getvar";
480    INV_SETVAR = 4334 => "inv_setvar";
481    INV_REORGANIZE = 4335 => "inv_reorganize";
482
483    // Enum
484    ENUM = 4400 => "enum";
485    ENUM_GETOUTPUTCOUNT = 4401 => "enum_getoutputcount";
486
487    // String
488    APPEND_NUM = 4500 => "append_num";
489    APPEND = 4501 => "append";
490    APPEND_SIGNNUM = 4502 => "append_signnum";
491    LOWERCASE = 4503 => "lowercase";
492    TEXT_GENDER = 4504 => "text_gender";
493    TOSTRING = 4505 => "tostring";
494    COMPARE = 4506 => "compare";
495    TEXT_SWITCH = 4507 => "text_switch";
496    APPEND_CHAR = 4508 => "append_char";
497    STRING_LENGTH = 4509 => "string_length";
498    SUBSTRING = 4510 => "substring";
499    STRING_INDEXOF_CHAR = 4511 => "string_indexof_char";
500    STRING_INDEXOF_STRING = 4512 => "string_indexof_string";
501    SPLIT_GET = 4513 => "split_get";
502    SPLIT_GETANIM = 4514 => "split_getanim";
503    SPLIT_INIT = 4515 => "split_init";
504    SPLIT_LINECOUNT = 4516 => "split_linecount";
505    SPLIT_PAGECOUNT = 4517 => "split_pagecount";
506
507    // Number
508    ADD = 4600 => "add";
509    SUB = 4601 => "sub";
510    MULTIPLY = 4602 => "multiply";
511    DIVIDE = 4603 => "divide";
512    RANDOM = 4604 => "random";
513    RANDOMINC = 4605 => "randominc";
514    INTERPOLATE = 4606 => "interpolate";
515    ADDPERCENT = 4607 => "addpercent";
516    SETBIT = 4608 => "setbit";
517    CLEARBIT = 4609 => "clearbit";
518    TESTBIT = 4610 => "testbit";
519    MODULO = 4611 => "modulo";
520    POW = 4612 => "pow";
521    INVPOW = 4613 => "invpow";
522    AND = 4614 => "and";
523    OR = 4615 => "or";
524    MIN = 4616 => "min";
525    MAX = 4617 => "max";
526    SCALE = 4618 => "scale";
527    BITCOUNT = 4619 => "bitcount";
528    TOGGLEBIT = 4620 => "togglebit";
529    SETBIT_RANGE = 4621 => "setbit_range";
530    CLEARBIT_RANGE = 4622 => "clearbit_range";
531    GETBIT_RANGE = 4623 => "getbit_range";
532    SETBIT_RANGE_TOINT = 4624 => "setbit_range_toint";
533    SIN_DEG = 4625 => "sin_deg";
534    COS_DEG = 4626 => "cos_deg";
535    ATAN2_DEG = 4627 => "atan2_deg";
536    ABS = 4628 => "abs";
537    DATE_MINUTES = 4629 => "date_minutes";
538    DATE_RUNEDAY = 4630 => "date_runeday";
539
540    // Struct
541    STRUCT_PARAM = 4700 => "struct_param";
542
543    // Region
544    REGION_FINDBYCOORD = 5200 => "region_findbycoord";
545    REGION_GETCOORD = 5201 => "region_getcoord";
546    REGION_CREATE = 5202 => "region_create";
547    REGION_SET = 5203 => "region_set";
548    REGION_UID = 5204 => "region_uid";
549    REGION_FINDBYUID = 5205 => "region_findbyuid";
550    REGION_SETEXITCOORD = 5206 => "region_setexitcoord";
551
552    // Controller
553    CONTROLLER_COORD = 5300 => "controller_coord";
554    CONTROLLER_DEL = 5301 => "controller_del";
555    CONTROLLER_QUEUE = 5302 => "controller_queue";
556    CONTROLLER_FINDEXACT = 5303 => "controller_findexact";
557    CONTROLLER_ADD = 5304 => "controller_add";
558    CONTROLLER_SETTIMER = 5305 => "controller_settimer";
559    CONTROLLER_QUEUEVARARG = 5306 => "controller_queuevararg";
560
561    // Db
562    DB_FIND_WITH_COUNT = 7500 => "db_find_with_count";
563    DB_FINDNEXT = 7501 => "db_findnext";
564    DB_GETFIELD = 7502 => "db_getfield";
565    DB_GETFIELDCOUNT = 7503 => "db_getfieldcount";
566    DB_LISTALL_WITH_COUNT = 7504 => "db_listall_with_count";
567    DB_GETROWTABLE = 7505 => "db_getrowtable";
568    DB_FINDBYINDEX = 7506 => "db_findbyindex";
569    DB_FIND_REFINE_WITH_COUNT = 7507 => "db_find_refine_with_count";
570    DB_FIND = 7508 => "db_find";
571    DB_FIND_REFINE = 7509 => "db_find_refine";
572    DB_LISTALL = 7510 => "db_listall";
573
574    // Debug
575    CONSOLE = 10000 => "console";
576    ERROR = 10001 => "error";
577    GETTIMESPENT = 10002 => "gettimespent";
578    TIMESPENT = 10003 => "timespent";
579    NPCCOUNT = 10004 => "npccount";
580    ZONECOUNT = 10005 => "zonecount";
581    LOCCOUNT = 10006 => "loccount";
582    MAP_LASTCLOCK = 10007 => "map_lastclock";
583    MAP_LASTWORLD = 10008 => "map_lastworld";
584    MAP_LASTCLIENTIN = 10009 => "map_lastclientin";
585    MAP_LASTNPC = 10010 => "map_lastnpc";
586    MAP_LASTPLAYER = 10011 => "map_lastplayer";
587    MAP_LASTLOGIN = 10012 => "map_lastlogin";
588    MAP_LASTLOGOUT = 10013 => "map_lastlogout";
589    MAP_LASTZONE = 10014 => "map_lastzone";
590    MAP_LASTCLIENTOUT = 10015 => "map_lastclientout";
591    MAP_LASTCLEANUP = 10016 => "map_lastcleanup";
592    MAP_LASTBANDWIDTHIN = 10017 => "map_lastbandwidthin";
593    MAP_LASTBANDWIDTHOUT = 10018 => "map_lastbandwidthout";
594    MAP_PRODUCTION = 10019 => "map_production";
595    OBJCOUNT = 10020 => "objcount";
596
597    // Test framework
598    ASSERT_EQ = 50000 => "assert_eq";
599    ASSERT_NOT_EQ = 50001 => "assert_not_eq";
600    ASSERT_STR_EQ = 50002 => "assert_str_eq";
601    ASSERT_TRUE = 50003 => "assert_true";
602    ASSERT_FALSE = 50004 => "assert_false";
603    ASSERT_GT = 50005 => "assert_gt";
604    ASSERT_LT = 50006 => "assert_lt";
605    ASSERT_GTE = 50007 => "assert_gte";
606    ASSERT_LTE = 50008 => "assert_lte";
607    ASSERT_NULL = 50009 => "assert_null";
608    ASSERT_NOT_NULL = 50010 => "assert_not_null";
609    TEST_FAIL = 50011 => "test_fail";
610    ASSERT_CALLED = 50012 => "assert_called";
611    ASSERT_CALLED_WITH = 50013 => "assert_called_with";
612    EXPECT_FAIL = 50014 => "expect_fail";
613    TEST_TICK = 50050 => "test_tick";
614    TEST_TRIGGER = 50051 => "test_trigger";
615    TEST_FIRE_INPUT = 50052 => "test_fire_input";
616    VERIFY_CALLS = 50053 => "verify_calls";
617    WAIT_FOR = 50054 => "wait_for";
618    TEST_OP = 50055 => "test_op";
619    SETUP_PLAYER = 50100 => "setup_player";
620}
621
622/// The opcode a `command.pack` must give `command`.
623pub fn opcode(command: &str) -> Option<u16> {
624    COMMANDS
625        .iter()
626        .find(|(name, _)| *name == command)
627        .map(|&(_, opcode)| opcode)
628}
629
630/// Whether `opcode`'s operand takes 4 bytes rather than 1.
631pub fn is_large_operand(opcode: u16) -> bool {
632    opcode <= 100
633        && !matches!(
634            opcode,
635            RETURN | GOSUB | JUMP | POP_INT_DISCARD | POP_STRING_DISCARD
636        )
637}
638
639#[cfg(test)]
640mod tests {
641    use super::*;
642    use std::collections::HashSet;
643
644    #[test]
645    fn each_constant_is_its_command_in_upper_case() {
646        for (constant, command) in CONSTANTS {
647            assert_eq!(*constant, command.to_uppercase());
648        }
649    }
650
651    #[test]
652    fn each_name_and_each_constant_has_one_opcode() {
653        let mut names = HashSet::new();
654        for (name, _) in COMMANDS {
655            assert!(names.insert(name), "{name}");
656        }
657        let mut opcodes = HashSet::new();
658        for (_, command) in CONSTANTS {
659            assert!(opcodes.insert(opcode(command)), "{command}");
660        }
661    }
662
663    #[test]
664    fn a_starred_name_shares_its_vararg_opcode() {
665        assert_eq!(opcode("queue*"), Some(QUEUEVARARG));
666        assert_eq!(opcode("queuevararg"), Some(QUEUEVARARG));
667        assert_eq!(opcode("queue"), Some(QUEUE));
668        assert_eq!(opcode("no_such_command"), None);
669    }
670
671    #[test]
672    fn only_short_instructions_take_a_one_byte_operand() {
673        assert!(is_large_operand(PUSH_CONSTANT_INT));
674        assert!(is_large_operand(BRANCH));
675        assert!(!is_large_operand(RETURN));
676        assert!(!is_large_operand(POP_STRING_DISCARD));
677        assert!(!is_large_operand(PUSH_CLANSETTING_INT));
678        assert!(!is_large_operand(MES));
679    }
680}