z_parameter: Magic (#934)

* Document magic

* Cleanup

* Few fixes

* PR Suggestions, More Lens Docs

* Few comments

* missed a spot

* Better macros/names

* Deactivate Lens

* more PR suggestions

* fix names

tools/disasm/functions.txt

@@ -811,7 +811,7 @@
     0x800B9084:("func_800B9084",),
     0x800B9098:("func_800B9098",),
     0x800B90AC:("func_800B90AC",),
-    0x800B90F4:("func_800B90F4",),
+    0x800B90F4:("Actor_DeactivateLens",),
     0x800B9120:("func_800B9120",),
     0x800B9170:("Actor_InitContext",),
     0x800B9334:("Actor_SpawnSetupActors",),
@@ -821,8 +821,8 @@
     0x800B9D1C:("func_800B9D1C",),
     0x800B9E3C:("Actor_DrawAllSetup",),
     0x800B9E4C:("Actor_RecordUndrawnActor",),
-    0x800B9E84:("func_800B9E84",),
-    0x800B9EF4:("func_800B9EF4",),
+    0x800B9E84:("Actor_DrawLensOverlay",),
+    0x800B9EF4:("Actor_DrawLensActors",),
     0x800BA2D8:("func_800BA2D8",),
     0x800BA2FC:("func_800BA2FC",),
     0x800BA42C:("Actor_DrawAll",),
@@ -2134,13 +2134,13 @@
     0x801159C0:("Health_GiveHearts",),
     0x801159EC:("Rupees_ChangeBy",),
     0x80115A14:("Inventory_ChangeAmmo",),
-    0x80115D14:("Parameter_AddMagic",),
-    0x80115D5C:("func_80115D5C",),
-    0x80115DB4:("func_80115DB4",),
-    0x80116088:("func_80116088",),
-    0x80116114:("func_80116114",),
-    0x80116348:("func_80116348",),
-    0x80116918:("func_80116918",),
+    0x80115D14:("Magic_Add",),
+    0x80115D5C:("Magic_Reset",),
+    0x80115DB4:("Magic_Consume",),
+    0x80116088:("Magic_UpdateAddRequest",),
+    0x80116114:("Magic_FlashMeterBorder",),
+    0x80116348:("Magic_Update",),
+    0x80116918:("Magic_DrawMeter",),
     0x80116FD8:("func_80116FD8",),
     0x801170B8:("func_801170B8",),
     0x80117100:("func_80117100",),

tools/disasm/variables.txt

@@ -1069,11 +1069,11 @@
     0x801BF890:("sMinigameScoreDigits","UNK_TYPE2","",0x2),
     0x801BF898:("sCUpInvisible","UNK_TYPE2","",0x2),
     0x801BF89C:("sCUpTimer","UNK_TYPE2","",0x2),
-    0x801BF8A0:("sMagicBarOutlinePrimRed","UNK_TYPE2","",0x2),
-    0x801BF8A4:("sMagicBarOutlinePrimGreen","UNK_TYPE2","",0x2),
-    0x801BF8A8:("sMagicBarOutlinePrimBlue","UNK_TYPE2","",0x2),
-    0x801BF8AC:("D_801BF8AC","UNK_TYPE2","",0x2),
-    0x801BF8B0:("D_801BF8B0","UNK_TYPE2","",0x2),
+    0x801BF8A0:("sMagicMeterOutlinePrimRed","UNK_TYPE2","",0x2),
+    0x801BF8A4:("sMagicMeterOutlinePrimGreen","UNK_TYPE2","",0x2),
+    0x801BF8A8:("sMagicMeterOutlinePrimBlue","UNK_TYPE2","",0x2),
+    0x801BF8AC:("sMagicBorderRatio","UNK_TYPE2","",0x2),
+    0x801BF8B0:("sMagicBorderStep","UNK_TYPE2","",0x2),
     0x801BF8DC:("D_801BF8DC","UNK_TYPE2","",0x2),
     0x801BF8E0:("D_801BF8E0","UNK_TYPE2","",0x2),
     0x801BF8E4:("D_801BF8E4","UNK_TYPE2","",0x2),
@@ -3434,7 +3434,7 @@
     0x801DE868:("D_801DE868","f32","",0x4),
     0x801DE86C:("jtbl_801DE86C","UNK_PTR","",0x4),
     0x801DE884:("D_801DE884","f32","",0x4),
-    0x801DE890:("D_801DE890","UNK_TYPE1","",0x1),
+    0x801DE890:("gCircleTex","UNK_TYPE1","",0x1),
     0x801DF090:("D_801DF090","f32","",0x4),
     0x801DF094:("D_801DF094","f32","",0x4),
     0x801DF0A0:("D_801DF0A0","f32","",0x4),

tools/namefixer.py

@@ -283,6 +283,7 @@ wordReplace = {
     "Actor_IsFacingPlayerAndWithinRange": "Actor_IsFacingAndNearPlayer",
     "func_800BC8B8": "Actor_DrawDoorLock",
     "func_800B86C8": "Actor_ChangeFocus",
+    "func_800B90F4": "Actor_DeactivateLens",
     "zelda_malloc": "ZeldaArena_Malloc",
     "zelda_mallocR": "ZeldaArena_MallocR",
     "zelda_realloc": "ZeldaArena_Realloc",
@@ -498,6 +499,9 @@ wordReplace = {
     "func_801159c0": "Health_GiveHearts",
     "func_801159EC": "Rupees_ChangeBy",
     "func_80115A14": "Inventory_ChangeAmmo",
+    "Parameter_AddMagic": "Magic_Add",
+    "func_80115D5C": "Magic_Reset",
+    "func_80115DB4": "Magic_Consume",
     "func_8013EC44": "Rumble_Override",
     "func_8013ECE0": "Rumble_Request",
     "func_8017D2FC": "Math3D_LineSegVsPlane",
@@ -648,8 +652,8 @@ wordReplace = {
     "gSaveContext.naviTimer": "gSaveContext.save.playerData.tatlTimer",
     "gSaveContext.tatlTimer": "gSaveContext.save.playerData.tatlTimer",
     "gSaveContext.rupees": "gSaveContext.save.playerData.rupees",
-    "gSaveContext.magicAcquired": "gSaveContext.save.playerData.magicAcquired",
-    "gSaveContext.doubleMagic": "gSaveContext.save.playerData.doubleMagic",
+    "gSaveContext.magicAcquired": "gSaveContext.save.playerData.isMagicAcquired",
+    "gSaveContext.doubleMagic": "gSaveContext.save.playerData.isDoubleMagicAcquired",
     "gSaveContext.doubleDefense": "gSaveContext.save.playerData.doubleDefense",
     "gSaveContext.playerName": "gSaveContext.save.playerData.playerName",
     "gSaveContext.inventory": "gSaveContext.save.inventory",
@@ -671,6 +675,11 @@ wordReplace = {
     "gSaveContext.unk_1016": "gSaveContext.jinxTimer",
     "gSaveContext.unk_3F58": "gSaveContext.sunsSongState",
     "gSaveContext.unk_48C8": "gSaveContext.dungeonIndex",
+    "gSaveContext.save.playerData.magicAcquired": "gSaveContext.save.playerData.isMagicAcquired",
+    "gSaveContext.save.playerDatadoubleMagic": "gSaveContext.save.playerData.isDoubleMagicAcquired",
+    "gSaveContext.unk_3F28": "gSaveContext.magicState",
+    "gSaveContext.unk_3F30": "gSaveContext.magicFillTarget",
+    "gSaveContext.unk_3F2C": "gSaveContext.magicFlag",
     "gSaveContext.save.entranceIndex": "gSaveContext.save.entrance",
 
     "player->unk_A87": "player->exchangeItemId",
@@ -704,6 +713,9 @@ wordReplace = {
     "play->msgCtx.unk12023": "play->msgCtx.stateTimer",
     "play->msgCtx.unk1202A": "play->msgCtx.ocarinaMode",
     "play->msgCtx.unk1202C": "play->msgCtx.ocarinaAction",
+    "play->msgCtx.unk11F04": "play->msgCtx.currentTextId",
+    "play->actorCtx.unk3": "play->actorCtx.lensActive",
+    "play->actorCtx.unk4": "play->actorCtx.lensMaskSize",
     "play->nextEntranceIndex": "play->nextEntrance",
 
     "play->sceneLoadFlag": "play->transitionTrigger",

tools/sizes/code_functions.csv

@@ -325,7 +325,7 @@ asm/non_matchings/code/z_actor/func_800B9038.s,func_800B9038,0x800B9038,0x13
 asm/non_matchings/code/z_actor/func_800B9084.s,func_800B9084,0x800B9084,0x5
 asm/non_matchings/code/z_actor/func_800B9098.s,func_800B9098,0x800B9098,0x5
 asm/non_matchings/code/z_actor/func_800B90AC.s,func_800B90AC,0x800B90AC,0x12
-asm/non_matchings/code/z_actor/func_800B90F4.s,func_800B90F4,0x800B90F4,0xB
+asm/non_matchings/code/z_actor/Actor_DeactivateLens.s,Actor_DeactivateLens,0x800B90F4,0xB
 asm/non_matchings/code/z_actor/func_800B9120.s,func_800B9120,0x800B9120,0x14
 asm/non_matchings/code/z_actor/Actor_InitContext.s,Actor_InitContext,0x800B9170,0x71
 asm/non_matchings/code/z_actor/Actor_SpawnSetupActors.s,Actor_SpawnSetupActors,0x800B9334,0x56
@@ -335,8 +335,8 @@ asm/non_matchings/code/z_actor/Actor_Draw.s,Actor_Draw,0x800B9A04,0xC6
 asm/non_matchings/code/z_actor/func_800B9D1C.s,func_800B9D1C,0x800B9D1C,0x48
 asm/non_matchings/code/z_actor/Actor_DrawAllSetup.s,Actor_DrawAllSetup,0x800B9E3C,0x4
 asm/non_matchings/code/z_actor/Actor_RecordUndrawnActor.s,Actor_RecordUndrawnActor,0x800B9E4C,0xE
-asm/non_matchings/code/z_actor/func_800B9E84.s,func_800B9E84,0x800B9E84,0x1C
-asm/non_matchings/code/z_actor/func_800B9EF4.s,func_800B9EF4,0x800B9EF4,0xF9
+asm/non_matchings/code/z_actor/Actor_DrawLensOverlay.s,Actor_DrawLensOverlay,0x800B9E84,0x1C
+asm/non_matchings/code/z_actor/Actor_DrawLensActors.s,Actor_DrawLensActors,0x800B9EF4,0xF9
 asm/non_matchings/code/z_actor/func_800BA2D8.s,func_800BA2D8,0x800BA2D8,0x9
 asm/non_matchings/code/z_actor/func_800BA2FC.s,func_800BA2FC,0x800BA2FC,0x4C
 asm/non_matchings/code/z_actor/Actor_DrawAll.s,Actor_DrawAll,0x800BA42C,0xB4
@@ -1648,13 +1648,13 @@ asm/non_matchings/code/z_parameter/Health_ChangeBy.s,Health_ChangeBy,0x80115908,
 asm/non_matchings/code/z_parameter/Health_GiveHearts.s,Health_GiveHearts,0x801159C0,0xB
 asm/non_matchings/code/z_parameter/Rupees_ChangeBy.s,Rupees_ChangeBy,0x801159EC,0xA
 asm/non_matchings/code/z_parameter/Inventory_ChangeAmmo.s,Inventory_ChangeAmmo,0x80115A14,0xC0
-asm/non_matchings/code/z_parameter/Parameter_AddMagic.s,Parameter_AddMagic,0x80115D14,0x12
-asm/non_matchings/code/z_parameter/func_80115D5C.s,func_80115D5C,0x80115D5C,0x16
-asm/non_matchings/code/z_parameter/func_80115DB4.s,func_80115DB4,0x80115DB4,0xB5
-asm/non_matchings/code/z_parameter/func_80116088.s,func_80116088,0x80116088,0x23
-asm/non_matchings/code/z_parameter/func_80116114.s,func_80116114,0x80116114,0x8D
-asm/non_matchings/code/z_parameter/func_80116348.s,func_80116348,0x80116348,0x174
-asm/non_matchings/code/z_parameter/func_80116918.s,func_80116918,0x80116918,0x1B0
+asm/non_matchings/code/z_parameter/Magic_Add.s,Magic_Add,0x80115D14,0x12
+asm/non_matchings/code/z_parameter/Magic_Reset.s,Magic_Reset,0x80115D5C,0x16
+asm/non_matchings/code/z_parameter/Magic_Consume.s,Magic_Consume,0x80115DB4,0xB5
+asm/non_matchings/code/z_parameter/Magic_UpdateAddRequest.s,Magic_UpdateAddRequest,0x80116088,0x23
+asm/non_matchings/code/z_parameter/Magic_FlashMeterBorder.s,Magic_FlashMeterBorder,0x80116114,0x8D
+asm/non_matchings/code/z_parameter/Magic_Update.s,Magic_Update,0x80116348,0x174
+asm/non_matchings/code/z_parameter/Magic_DrawMeter.s,Magic_DrawMeter,0x80116918,0x1B0
 asm/non_matchings/code/z_parameter/func_80116FD8.s,func_80116FD8,0x80116FD8,0x38
 asm/non_matchings/code/z_parameter/func_801170B8.s,func_801170B8,0x801170B8,0x12
 asm/non_matchings/code/z_parameter/func_80117100.s,func_80117100,0x80117100,0x248