Tutorial (#362)

* ObjTree OK, data imported

* EnMs OK, data imported

* And the spec

* OK

* Some minor edits

* A lot of preliminary stuff

* Mostly complete beginning

* First draft of other functions doc

* Whoops, forgot the GlobalContext pad

* Draw functions (minus colour), create Data

* Data

* gitignore, some progress on documenting

* Review comments, continue documenting

* spec

* Finish off documentation

* undefined_syms

* Add a couple of todos

* One more

* At least add tools for object decomp

* Start conversion table stuff

* Document ObjTree

* Document EnMs

* Add more tables to conversions

* Maide's review

* Review

* Review

* Typos and incomplete thoughts

* Update vscode.md

* Correct function/variable names

* Review suggestions

* Format

* Missed one

* Rename functions and format

* Fix ObjTree

* Update actorfixer.py, fix some variable names

* Some review

* Review suggestions

* More review

* Hopefully fix all the thisx references

* Missed one

include/z64item.h

@@ -57,7 +57,7 @@ typedef enum {
     /* 0x07 */ SLOT_BOMBCHU,
     /* 0x08 */ SLOT_STICK,
     /* 0x09 */ SLOT_NUT,
-    /* 0x0A */ SLOT_BEAN,
+    /* 0x0A */ SLOT_MAGIC_BEANS,
     /* 0x0B */ SLOT_TRADE_KEY_MAMA,
     /* 0x0C */ SLOT_POWDER_KEG,
     /* 0x0D */ SLOT_PICTO_BOX,
@@ -85,7 +85,7 @@ typedef enum {
     /* 0x23 */ SLOT_MASK_GORON,
     /* 0x24 */ SLOT_MASK_ROMANI,
     /* 0x25 */ SLOT_MASK_CIRCUS_LEADER,
-    /* 0x26 */ SLOT_MASK_KAFEI,
+    /* 0x26 */ SLOT_MASK_KAFEIS_MASK,
     /* 0x27 */ SLOT_MASK_COUPLE,
     /* 0x28 */ SLOT_MASK_TRUTH,
     /* 0x29 */ SLOT_MASK_ZORA,
@@ -109,7 +109,7 @@ typedef enum {
     /* 0x07 */ ITEM_BOMBCHU,
     /* 0x08 */ ITEM_STICK,
     /* 0x09 */ ITEM_NUT,
-    /* 0x0A */ ITEM_BEAN,
+    /* 0x0A */ ITEM_MAGIC_BEANS,
     /* 0x0B */ ITEM_SLINGSHOT,
     /* 0x0C */ ITEM_POWDER_KEG,
     /* 0x0D */ ITEM_PICTO_BOX,
@@ -146,7 +146,7 @@ typedef enum {
     /* 0x2C */ ITEM_DEED_OCEAN,
     /* 0x2D */ ITEM_ROOM_KEY,
     /* 0x2E */ ITEM_LETTER_MAMA,
-    /* 0x2F */ ITEM_LETTER_KAFEI,
+    /* 0x2F */ ITEM_LETTER_TO_KAFEI,
     /* 0x30 */ ITEM_PENDANT_MEMORIES,
     /* 0x31 */ ITEM_TINGLE_MAP,
     /* 0x32 */ ITEM_MASK_DEKU,
@@ -154,7 +154,7 @@ typedef enum {
     /* 0x34 */ ITEM_MASK_ZORA,
     /* 0x35 */ ITEM_MASK_FIERCE_DEITY,
     /* 0x36 */ ITEM_MASK_TRUTH,
-    /* 0x37 */ ITEM_MASK_KAFEI,
+    /* 0x37 */ ITEM_MASK_KAFEIS_MASK,
     /* 0x38 */ ITEM_MASK_ALL_NIGHT,
     /* 0x39 */ ITEM_MASK_BUNNY,
     /* 0x3A */ ITEM_MASK_KEATON,
@@ -294,6 +294,7 @@ typedef enum {
     /* 0x2A */ GI_NUTS_10 = 0x2A,
     /* 0x32 */ GI_SHIELD_HERO = 0x32,
     /* 0x33 */ GI_SHIELD_MIRROR,
+    /* 0x35 */ GI_MAGIC_BEANS = 0x35,
     /* 0x3C */ GI_KEY_SMALL = 0x3C,
     /* 0x3E */ GI_MAP = 0x3E,
     /* 0x3F */ GI_COMPASS,
@@ -308,7 +309,7 @@ typedef enum {
     /* 0x7A */ GI_MASK_ZORA,
     /* 0x7B */ GI_MASK_FIERCE_DEITY,
     /* 0x7C */ GI_MASK_TRUTH,
-    /* 0x7D */ GI_MASK_KAFEI,
+    /* 0x7D */ GI_MASK_KAFEIS_MASK,
     /* 0x7E */ GI_MASK_ALL_NIGHT,
     /* 0x7F */ GI_MASK_BUNNY,
     /* 0x80 */ GI_MASK_KEATON,

include/z64object.h

@@ -207,7 +207,7 @@ typedef enum {
     /* 0x0C3 */ OBJECT_GI_SHIELD_3,
     /* 0x0C4 */ OBJECT_UNSET_C4,
     /* 0x0C5 */ OBJECT_UNSET_C5,
-    /* 0x0C6 */ OBJECT_GI_BEAN,
+    /* 0x0C6 */ OBJECT_GI_MAGIC_BEANS,
     /* 0x0C7 */ OBJECT_GI_FISH,
     /* 0x0C8 */ OBJECT_UNSET_C8,
     /* 0x0C9 */ OBJECT_UNSET_C9,

include/z64player.h

@@ -36,7 +36,7 @@ typedef enum {
 typedef enum {
     /* 0x00 */ PLAYER_MASK_NONE,
     /* 0x01 */ PLAYER_MASK_TRUTH,
-    /* 0x02 */ PLAYER_MASK_KAFEI,
+    /* 0x02 */ PLAYER_MASK_KAFEIS_MASK,
     /* 0x03 */ PLAYER_MASK_ALL_NIGHT,
     /* 0x04 */ PLAYER_MASK_BUNNY,
     /* 0x05 */ PLAYER_MASK_KEATON,
@@ -106,15 +106,15 @@ typedef enum {
     /* 0x2A */ PLAYER_AP_MOON_TEAR,
     /* 0x2B */ PLAYER_AP_DEED_LAND,
     /* 0x2C */ PLAYER_AP_ROOM_KEY,
-    /* 0x2D */ PLAYER_AP_LETTER_KAFEI,
-    /* 0x2E */ PLAYER_AP_BEAN,
+    /* 0x2D */ PLAYER_AP_LETTER_TO_KAFEI,
+    /* 0x2E */ PLAYER_AP_MAGIC_BEANS,
     /* 0x2F */ PLAYER_AP_DEED_SWAMP,
     /* 0x30 */ PLAYER_AP_DEED_MOUNTAIN,
     /* 0x31 */ PLAYER_AP_DEED_OCEAN,
     /* 0x33 */ PLAYER_AP_LETTER_MAMA = 0x33,
     /* 0x36 */ PLAYER_AP_PENDANT_MEMORIES = 0x36,
     /* 0x3A */ PLAYER_AP_MASK_TRUTH = 0x3A,
-    /* 0x3B */ PLAYER_AP_MASK_KAFEI,
+    /* 0x3B */ PLAYER_AP_MASK_KAFEIS_MASK,
     /* 0x3C */ PLAYER_AP_MASK_ALL_NIGHT,
     /* 0x3D */ PLAYER_AP_MASK_BUNNY,
     /* 0x3E */ PLAYER_AP_MASK_KEATON,