z_parameter: Main (#1157)

* main docs

* formatting and bss issues

* PR Suggestions

* missed enums

* better macros/enums

* restrictions improvement, still wip

* fix name, more common restriction patterns

* more restrictions cleanup

* rm comment

tools/disasm/functions.txt

@@ -2106,8 +2106,8 @@
     0x8010F1A8:("Interface_UpdateHudAlphas",),
     0x80110038:("func_80110038",),
     0x80111CB4:("func_80111CB4",),
-    0x801129E4:("func_801129E4",),
-    0x80112AF4:("func_80112AF4",),
+    0x801129E4:("Interface_SetSceneRestrictions",),
+    0x80112AF4:("Interface_Noop",),
     0x80112AFC:("Interface_InitMinigame",),
     0x80112B40:("Interface_LoadItemIconImpl",),
     0x80112BE4:("Interface_LoadItemIcon",),
@@ -2162,8 +2162,8 @@
     0x8011E3B4:("Interface_UpdateBottleTimers",),
     0x8011E730:("Interface_DrawMinigameIcons",),
     0x8011F0E0:("Interface_Draw",),
-    0x80120F90:("func_80120F90",),
-    0x80121064:("func_80121064",),
+    0x80120F90:("Interface_LoadStory",),
+    0x80121064:("Interface_AllocStory",),
     0x801210E0:("Interface_Update",),
     0x80121F94:("Interface_Destroy",),
     0x80121FC4:("Interface_Init",),
@@ -2232,7 +2232,7 @@
     0x80124258:("Player_GetExplosiveHeld",),
     0x80124278:("Player_ActionToSword",),
     0x801242B4:("func_801242B4",),
-    0x801242DC:("Player_GetEnvTimerType",),
+    0x801242DC:("Player_GetEnvironmentalHazard",),
     0x80124420:("func_80124420",),
     0x80124618:("func_80124618",),
     0x801246F4:("Player_DrawImpl",),
@@ -2987,8 +2987,8 @@
     0x80166060:("func_80166060",),
     0x801660B8:("func_801660B8",),
     0x8016613C:("Play_Destroy",),
-    0x801663C4:("func_801663C4",),
-    0x80166644:("func_80166644",),
+    0x801663C4:("Play_CompressI8ToI5",),
+    0x80166644:("Play_DecompressI5ToI8",),
     0x801668B4:("func_801668B4",),
     0x80166968:("func_80166968",),
     0x80166B30:("func_80166B30",),

tools/disasm/variables.txt

@@ -1075,8 +1075,8 @@
     0x801BF5C0:("D_801BF5C0","UNK_PTR","",0x4),
     0x801BF68C:("D_801BF68C","UNK_TYPE1","",0x1),
     0x801BF6C0:("sRestrictionFlags","RestrictionFlags","[113]",0x1c4),
-    0x801BF884:("D_801BF884","UNK_TYPE2","",0x2),
-    0x801BF888:("D_801BF888","UNK_TYPE2","",0x2),
+    0x801BF884:("sPictoState","UNK_TYPE2","",0x2),
+    0x801BF888:("sPictoPhotoBeingTaken","UNK_TYPE2","",0x2),
     0x801BF88C:("sHBAScoreTier","UNK_TYPE2","",0x2),
     0x801BF890:("sMinigameScoreDigits","UNK_TYPE2","",0x2),
     0x801BF898:("sCUpInvisible","UNK_TYPE2","",0x2),
@@ -1086,7 +1086,7 @@
     0x801BF8A8:("sMagicMeterOutlinePrimBlue","UNK_TYPE2","",0x2),
     0x801BF8AC:("sMagicBorderRatio","UNK_TYPE2","",0x2),
     0x801BF8B0:("sMagicBorderStep","UNK_TYPE2","",0x2),
-    0x801BF8DC:("sEnvTimerType","UNK_TYPE2","",0x2),
+    0x801BF8DC:("sEnvHazard","UNK_TYPE2","",0x2),
     0x801BF8E0:("sEnvTimerActive","UNK_TYPE2","",0x2),
     0x801BF8E4:("sPostmanBunnyHoodState","UNK_TYPE2","",0x2),
     0x801BF8E8:("sTimerPausedOsTime","UNK_TYPE4","",0x4),
@@ -1100,7 +1100,7 @@
     0x801BF978:("D_801BF978","UNK_TYPE4","",0x4),
     0x801BF97C:("D_801BF97C","UNK_TYPE4","",0x4),
     0x801BF980:("D_801BF980","UNK_TYPE4","",0x4),
-    0x801BF988:("D_801BF988","Gfx","[5]",0x28),
+    0x801BF988:("sScreenFillSetupDL","Gfx","[5]",0x28),
     0x801BF9B0:("D_801BF9B0","UNK_TYPE2","",0x2),
     0x801BF9B4:("D_801BF9B4","UNK_TYPE1","",0x1),
     0x801BF9BC:("D_801BF9BC","UNK_TYPE1","",0x1),
@@ -1178,17 +1178,17 @@
     0x801BFCF8:("sTimerBeepSfxSeconds","UNK_TYPE4","",0x4),
     0x801BFCFC:("D_801BFCFC","UNK_TYPE4","",0x4),
     0x801BFD0C:("D_801BFD0C","UNK_TYPE4","",0x4),
-    0x801BFD1C:("D_801BFD1C","UNK_TYPE1","",0x1),
-    0x801BFD24:("D_801BFD24","UNK_TYPE1","",0x1),
-    0x801BFD2C:("D_801BFD2C","UNK_TYPE1","",0x1),
-    0x801BFD40:("D_801BFD40","UNK_TYPE1","",0x1),
-    0x801BFD54:("D_801BFD54","UNK_TYPE1","",0x1),
-    0x801BFD64:("D_801BFD64","UNK_TYPE1","",0x1),
-    0x801BFD6C:("D_801BFD6C","UNK_TYPE2","",0x2),
-    0x801BFD84:("D_801BFD84","UNK_TYPE1","",0x1),
-    0x801BFD8C:("D_801BFD8C","UNK_TYPE1","",0x1),
-    0x801BFD94:("D_801BFD94","UNK_TYPE4","",0x4),
-    0x801BFD98:("D_801BFD98","UNK_TYPE4","[2]",0x8),
+    0x801BFD1C:("sRupeeDigitsFirst","UNK_TYPE1","",0x1),
+    0x801BFD24:("sRupeeDigitsCount","UNK_TYPE1","",0x1),
+    0x801BFD2C:("sRupeeCounterIconPrimColors","UNK_TYPE1","",0x1),
+    0x801BFD40:("sRupeeCounterIconEnvColors","UNK_TYPE1","",0x1),
+    0x801BFD54:("sMinigameCountdownTextures","UNK_TYPE1","",0x1),
+    0x801BFD64:("sMinigameCountdownTexWidths","UNK_TYPE1","",0x1),
+    0x801BFD6C:("sMinigameCountdownPrimColors","UNK_TYPE2","",0x2),
+    0x801BFD84:("sStoryTextures","UNK_TYPE1","",0x1),
+    0x801BFD8C:("sStoryTLUTs","UNK_TYPE1","",0x1),
+    0x801BFD94:("sIsSunsPlayedAtDay","UNK_TYPE4","",0x4),
+    0x801BFD98:("sPrevTimeSpeed","UNK_TYPE4","[2]",0x8),
     0x801BFDA0:("sMaskObjectIds","s16","[24]",0x30),
     0x801BFDD0:("D_801BFDD0","UNK_TYPE1","",0x1),
     0x801BFDE8:("sMaskItemIds","UNK_TYPE1","",0x1),
@@ -1198,7 +1198,7 @@
     0x801BFF3C:("sActionModelGroups","UNK_TYPE1","",0x1),
     0x801BFF90:("D_801BFF90","UNK_TYPE1","",0x1),
     0x801BFF98:("sPlayerStrengths","UNK_TYPE1","",0x1),
-    0x801BFFA0:("sEnvironmentTextTriggers","UNK_TYPE1","",0x1),
+    0x801BFFA0:("sEnvHazardTextTriggers","UNK_TYPE1","",0x1),
     0x801BFFB0:("gPlayerModelTypes","UNK_TYPE1","",0x1),
     0x801BFFFC:("gPlayerWaistDLs","UNK_TYPE1","",0x1),
     0x801C0024:("gPlayerHandHoldingShields","UNK_TYPE1","",0x1),
@@ -4366,7 +4366,7 @@
     0x80209EA0:("gGfxPools","GfxPool","[2]",0x40620),
     0x8024A4C0:("gAudioHeap","u8","[0x138000]",0x138000),
     0x803824C0:("gSystemHeap","u8","[UNK_SIZE]",0x3fdb40),
-    0x80780000:("D_80780000","u8","[0x4600]",0x4600),
+    0x80780000:("gPictoPhotoI8","u8","[0x4600]",0x4600),
     0x80784600:("D_80784600","u8","[0x56200]",0x56200),
     0x807DA800:("gFramebuffer0","u16","[SCREEN_HEIGHT][SCREEN_WIDTH]",0x25800),
     0x80800860:("titleRotation","s16","",0x2),

tools/namefixer.py

@@ -499,6 +499,7 @@ wordReplace = {
     "func_80169E6C": "Play_SetupRespawnPoint",
     "func_8016A0AC": "Play_IsUnderwater",
     "func_801690CC": "Play_InCsMode",
+    "func_801129E4": "Interface_SetSceneRestrictions",
     "func_8011B4E0": "Interface_SetPerfectLetters",
     "func_80112AFC": "Interface_InitMinigame",
     "func_8010E9F0": "Interface_StartTimer",
@@ -811,6 +812,8 @@ wordReplace = {
     "ICHAIN_F32_DIV1000(minVelocityY,": "ICHAIN_F32_DIV1000(terminalVelocity,",
     "ICHAIN_F32(minVelocityY,": "ICHAIN_F32(terminalVelocity,",
 
+    "ACTORCTX_FLAG_2": "ACTORCTX_FLAG_PICTO_BOX_ON",
+
     "EXCH_ITEM_MINUS1": "PLAYER_IA_MINUS1",
     "EXCH_ITEM_NONE": "PLAYER_IA_NONE",
     "EXCH_ITEM_PICTO_BOX": "PLAYER_IA_PICTO_BOX",

tools/sizes/code_functions.csv

@@ -1620,8 +1620,8 @@ asm/non_matchings/code/z_parameter/Interface_UpdateButtonAlphas.s,Interface_Upda
 asm/non_matchings/code/z_parameter/Interface_UpdateHudAlphas.s,Interface_UpdateHudAlphas,0x8010F1A8,0x3A4
 asm/non_matchings/code/z_parameter/func_80110038.s,func_80110038,0x80110038,0x71F
 asm/non_matchings/code/z_parameter/func_80111CB4.s,func_80111CB4,0x80111CB4,0x34C
-asm/non_matchings/code/z_parameter/func_801129E4.s,func_801129E4,0x801129E4,0x44
-asm/non_matchings/code/z_parameter/func_80112AF4.s,func_80112AF4,0x80112AF4,0x2
+asm/non_matchings/code/z_parameter/Interface_SetSceneRestrictions.s,Interface_SetSceneRestrictions,0x801129E4,0x44
+asm/non_matchings/code/z_parameter/Interface_Noop.s,Interface_Noop,0x80112AF4,0x2
 asm/non_matchings/code/z_parameter/Interface_InitMinigame.s,Interface_InitMinigame,0x80112AFC,0x11
 asm/non_matchings/code/z_parameter/Interface_LoadItemIconImpl.s,Interface_LoadItemIconImpl,0x80112B40,0x29
 asm/non_matchings/code/z_parameter/Interface_LoadItemIcon.s,Interface_LoadItemIcon,0x80112BE4,0xA
@@ -1676,8 +1676,8 @@ asm/non_matchings/code/z_parameter/Interface_DrawTimers.s,Interface_DrawTimers,0
 asm/non_matchings/code/z_parameter/Interface_UpdateBottleTimers.s,Interface_UpdateBottleTimers,0x8011E3B4,0xDF
 asm/non_matchings/code/z_parameter/Interface_DrawMinigameIcons.s,Interface_DrawMinigameIcons,0x8011E730,0x26C
 asm/non_matchings/code/z_parameter/Interface_Draw.s,Interface_Draw,0x8011F0E0,0x7AC
-asm/non_matchings/code/z_parameter/func_80120F90.s,func_80120F90,0x80120F90,0x35
-asm/non_matchings/code/z_parameter/func_80121064.s,func_80121064,0x80121064,0x1F
+asm/non_matchings/code/z_parameter/Interface_LoadStory.s,Interface_LoadStory,0x80120F90,0x35
+asm/non_matchings/code/z_parameter/Interface_AllocStory.s,Interface_AllocStory,0x80121064,0x1F
 asm/non_matchings/code/z_parameter/Interface_Update.s,Interface_Update,0x801210E0,0x3AD
 asm/non_matchings/code/z_parameter/Interface_Destroy.s,Interface_Destroy,0x80121F94,0xC
 asm/non_matchings/code/z_parameter/Interface_Init.s,Interface_Init,0x80121FC4,0x147
@@ -1746,7 +1746,7 @@ asm/non_matchings/code/z_player_lib/Player_ActionToExplosive.s,Player_ActionToEx
 asm/non_matchings/code/z_player_lib/Player_GetExplosiveHeld.s,Player_GetExplosiveHeld,0x80124258,0x8
 asm/non_matchings/code/z_player_lib/Player_ActionToSword.s,Player_ActionToSword,0x80124278,0xF
 asm/non_matchings/code/z_player_lib/func_801242B4.s,func_801242B4,0x801242B4,0xA
-asm/non_matchings/code/z_player_lib/Player_GetEnvTimerType.s,Player_GetEnvTimerType,0x801242DC,0x51
+asm/non_matchings/code/z_player_lib/Player_GetEnvironmentalHazard.s,Player_GetEnvironmentalHazard,0x801242DC,0x51
 asm/non_matchings/code/z_player_lib/func_80124420.s,func_80124420,0x80124420,0x7E
 asm/non_matchings/code/z_player_lib/func_80124618.s,func_80124618,0x80124618,0x37
 asm/non_matchings/code/z_player_lib/Player_DrawImpl.s,Player_DrawImpl,0x801246F4,0x5F
@@ -2501,8 +2501,8 @@ asm/non_matchings/code/z_play/func_80165EC0.s,func_80165EC0,0x80165EC0,0x68
 asm/non_matchings/code/z_play/func_80166060.s,func_80166060,0x80166060,0x16
 asm/non_matchings/code/z_play/func_801660B8.s,func_801660B8,0x801660B8,0x21
 asm/non_matchings/code/z_play/Play_Destroy.s,Play_Destroy,0x8016613C,0xA2
-asm/non_matchings/code/z_play/func_801663C4.s,func_801663C4,0x801663C4,0xA0
-asm/non_matchings/code/z_play/func_80166644.s,func_80166644,0x80166644,0x9C
+asm/non_matchings/code/z_play/Play_CompressI8ToI5.s,Play_CompressI8ToI5,0x801663C4,0xA0
+asm/non_matchings/code/z_play/Play_DecompressI5ToI8.s,Play_DecompressI5ToI8,0x80166644,0x9C
 asm/non_matchings/code/z_play/func_801668B4.s,func_801668B4,0x801668B4,0x2D
 asm/non_matchings/code/z_play/func_80166968.s,func_80166968,0x80166968,0x72
 asm/non_matchings/code/z_play/func_80166B30.s,func_80166B30,0x80166B30,0x339

tools/weekeventregconvert.py

@@ -119,7 +119,7 @@ weekEventReg = {
     (14 << 8) | 0x01: "WEEKEVENTREG_14_01",
     (14 << 8) | 0x02: "WEEKEVENTREG_14_02",
     (14 << 8) | 0x04: "WEEKEVENTREG_14_04",
-    (14 << 8) | 0x08: "WEEKEVENTREG_14_08",
+    (14 << 8) | 0x08: "WEEKEVENTREG_DRANK_CHATEAU_ROMANI",
     (14 << 8) | 0x10: "WEEKEVENTREG_14_10",
     (14 << 8) | 0x20: "WEEKEVENTREG_14_20",
     (14 << 8) | 0x40: "WEEKEVENTREG_14_40",