WIP on script documentation, some cleanup (#194)

* gfx

* script

* Torch

* headers

* format

1 files changed, 145 insertions, 0 deletions

diff --git a/include/sf64level.h b/include/sf64level.h
index e6ebe7d2..d744cd7c 100644
--- a/include/sf64level.h
+++ b/include/sf64level.h
@@ -115,4 +115,149 @@ typedef enum VsStage {
     /* 2 */ VS_STAGE_SECTOR_Z,
 } VsStage;
 
+#define EVENT_CMD(opcode, arg1, arg2) ((((opcode) & 0x7F) << 9) | ((arg1) & 0x1FF)), (arg2)
+#define EVENT_PLAY_MSG(rcid, msg) EVENT_CMD(EVOP_PLAY_MSG, rcid, msg)
+#define EVENT_STOP_SCRIPT() EVENT_CMD(EVOP_STOP_SCRIPT, 0, 0)
+#define EVENT_MAKE_TEXLINE(color) EVENT_CMD(EVOP_MAKE_TEXLINE, 0, color)
+#define EVENT_STOP_TEXLINE() EVENT_CMD(EVOP_STOP_TEXLINE, 0, 0)
+#define EVENT_INIT_ACTOR(health, info) EVENT_CMD(EVOP_INIT_ACTOR, health, info)
+#define EVENT_SET_SPEED(speed, time, flag1, flag2) EVENT_CMD(EVOP_SET_SPEED, (((flag1) & 1) << 8) | (((flag2) & 1) << 7) | ((speed) & 0x7F), time)
+#define EVENT_SET_ACCEL(speedTarget, time, flag1, flag2) EVENT_CMD(EVOP_SET_ACCEL, (((flag1) & 1) << 8) | (((flag2) & 1) << 7) | ((speedTarget) & 0x7F), time)
+#define EVENT_SET_ROTATE() EVENT_CMD(EVOP_SET_ROTATE, 0, 0)
+#define EVENT_STOP_ROTATE() EVENT_CMD(EVOP_STOP_ROTATE, 0, 0)
+#define EVENT_BRANCH(cond, cmd) EVENT_CMD(EVOP_BRANCH, cmd, cond)
+#define EVENT_LOOP(cmd, count) EVENT_CMD(EVOP_LOOP, cmd, count)
+
+typedef enum EventOpcode {
+    /*   0 */ EVOP_SET_SPEED,
+    /*   1 */ EVOP_SET_ACCEL,
+    /*   2 */ EVOP_2,
+    /*   3 */ EVOP_3,
+    /*   4 */ EVOP_4,
+    /*   8 */ EVOP_8 = 8,
+    /*   9 */ EVOP_9,
+    /*  10 */ EVOP_10,
+    /*  11 */ EVOP_11,
+    /*  12 */ EVOP_12,
+    /*  16 */ EVOP_16 = 16,
+    /*  17 */ EVOP_17,
+    /*  18 */ EVOP_18,
+    /*  19 */ EVOP_19,
+    /*  20 */ EVOP_20,
+    /*  21 */ EVOP_21,
+    /*  24 */ EVOP_SET_ROTATE = 24,
+    /*  25 */ EVOP_STOP_ROTATE,
+    /*  40 */ EVOP_40 = 40,
+    /*  41 */ EVOP_41,
+    /*  42 */ EVOP_42,
+    /*  43 */ EVOP_43,
+    /*  44 */ EVOP_44,
+    /*  45 */ EVOP_45,
+    /*  46 */ EVOP_46,
+    /*  47 */ EVOP_47,
+    /*  48 */ EVOP_48,
+    /*  56 */ EVOP_56 = 56,
+    /*  57 */ EVOP_57,
+    /*  58 */ EVOP_58,
+    /*  59 */ EVOP_59,
+    /*  96 */ EVOP_BRANCH = 96,
+    /* 104 */ EVOP_INIT_ACTOR = 104,
+    /* 105 */ EVOP_105,
+    /* 112 */ EVOP_112 = 112,
+    /* 113 */ EVOP_113,
+    /* 116 */ EVOP_116 = 116,
+    /* 118 */ EVOP_118 = 118,
+    /* 119 */ EVOP_119,
+    /* 120 */ EVOP_PLAY_MSG, // play message. arg1 is portrait, arg2 is message ID
+    /* 121 */ EVOP_121,
+    /* 122 */ EVOP_122,
+    /* 124 */ EVOP_MAKE_TEXLINE = 124,
+    /* 125 */ EVOP_STOP_TEXLINE,
+    /* 126 */ EVOP_LOOP,
+    /* 127 */ EVOP_STOP_SCRIPT, // stop script
+} EventOpcode;
+
+typedef enum EventCondition {
+    /*  0 */ EVC_0,
+    /*  1 */ EVC_1,
+    /*  2 */ EVC_2,
+    /*  3 */ EVC_3,
+    /*  4 */ EVC_4,
+    /*  5 */ EVC_5,
+    /*  6 */ EVC_6,
+    /*  7 */ EVC_7,
+    /*  8 */ EVC_8,
+    /*  9 */ EVC_9,
+    /* 10 */ EVC_10,
+    /* 11 */ EVC_11,
+    /* 12 */ EVC_12,
+    /* 13 */ EVC_13,
+    /* 14 */ EVC_14,
+    /* 15 */ EVC_15,
+    /* 16 */ EVC_16,
+    /* 17 */ EVC_17,
+    /* 18 */ EVC_18,
+    /* 19 */ EVC_19,
+    /* 20 */ EVC_20,
+    /* 21 */ EVC_21,
+    /* 22 */ EVC_22,
+    /* 23 */ EVC_23,
+    /* 24 */ EVC_24,
+    /* 25 */ EVC_25,
+    /* 26 */ EVC_26,
+    /* 27 */ EVC_27,
+    /* 28 */ EVC_28,
+    /* 29 */ EVC_29,
+    /* 30 */ EVC_30,
+    /* 31 */ EVC_31,
+    /* 32 */ EVC_32,
+    /* 33 */ EVC_33,
+    /* 34 */ EVC_34,
+    /* 35 */ EVC_35,
+    /* 36 */ EVC_36,
+    /* 37 */ EVC_37,
+    /* 38 */ EVC_38,
+    /* 39 */ EVC_39,
+    /* 40 */ EVC_40,
+    /* 41 */ EVC_41,
+    /* 42 */ EVC_42,
+    /* 43 */ EVC_43,
+    /* 44 */ EVC_44,
+    /* 45 */ EVC_45,
+    /* 46 */ EVC_46,
+    /* 47 */ EVC_47,
+    /* 48 */ EVC_48,
+    /* 49 */ EVC_49,
+    /* 50 */ EVC_50,
+    /* 51 */ EVC_51,
+    /* 52 */ EVC_52,
+    /* 53 */ EVC_53,
+    /* 54 */ EVC_54,
+    /* 55 */ EVC_55,
+    /* 56 */ EVC_56,
+    /* 57 */ EVC_57,
+    /* 58 */ EVC_58,
+    /* 59 */ EVC_59,
+    /* 60 */ EVC_60,
+    /* 61 */ EVC_61,
+    /* 62 */ EVC_62,
+    /* 63 */ EVC_63,
+    /* 64 */ EVC_64,
+    /* 65 */ EVC_65,
+    /* 66 */ EVC_66,
+    /* 67 */ EVC_67,
+    /* 68 */ EVC_68,
+    /* 69 */ EVC_69,
+    /* 100 */ EVC_100=100,
+} EventCondition;
+
+typedef enum TexLineColor {
+    /* 0 */ TXLC_WHITE,
+    /* 1 */ TXLC_LIGHT_BLUE,
+    /* 2 */ TXLC_BLUE,
+    /* 3 */ TXLC_GREEN,
+    /* 4 */ TXLC_RED,
+    /* 5 */ TXLC_YELLOW,
+} TexLineColor;
+
 #endif