summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorIsghj <42048411+isghj5@users.noreply.github.com>2023-03-07 15:54:12 -0800
committerGitHub <noreply@github.com>2023-03-07 20:54:12 -0300
commite50ab59cf789deb7aef4ccc3e4e5c69eb217b3c2 (patch)
treeacd9388226a6f05376ed2d9469103be535bfcd41 /include
parent2cce8f67671c7162a946dd11604f83c9630fbc28 (diff)
Documented `object_sth` and `object_ahg`, both used by `EnSth` (Moon gazer who wants to buy Ocean spiderhouse) (#1169)
* object_sth/object_ahg: docs * Ssh: formatter * Apply suggestions from code review Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com> * Oops missed one Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com> * Seth: fixes * Sth: more requested changes * Apply suggestions from code review Co-authored-by: Tom Overton <tom-overton@users.noreply.github.com> * Sth/Ahg: requested changes * Apply suggestions from code review Co-authored-by: Tom Overton <tom-overton@users.noreply.github.com> * Sth: further function name requested changes * Sth: minor note * Sth: fix animation name * Sth: forgot to rename saved flag * Seth: change ocean wallet week reg name * Sth: some requested changes * Sth: fixed week event reg, added more * Sth/Ssh/Si: changed from two defines to 1 * Si/Sth/Ssh: mistook fanfare for sfx, token define renamed * Sth/Ssh/Sekihi: requested changes and some weekregflag docs * Sekihi: fix missing header for skull count * Sekihi: moved flag description to z64save * Sekihi: moved flag description to z64save * Sth: removed flag * Update include/z64save.h Co-authored-by: Tom Overton <tom-overton@users.noreply.github.com> --------- Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com> Co-authored-by: Tom Overton <tom-overton@users.noreply.github.com>
Diffstat (limited to 'include')
-rw-r--r--include/z64save.h19
1 files changed, 14 insertions, 5 deletions
diff --git a/include/z64save.h b/include/z64save.h
index 1b5531540..60d3a9a2b 100644
--- a/include/z64save.h
+++ b/include/z64save.h
@@ -622,9 +622,18 @@ typedef enum SunsSongState {
#define WEEKEVENTREG_13_04 PACK_WEEKEVENTREG_FLAG(13, 0x04)
#define WEEKEVENTREG_13_08 PACK_WEEKEVENTREG_FLAG(13, 0x08)
#define WEEKEVENTREG_13_10 PACK_WEEKEVENTREG_FLAG(13, 0x10)
-#define WEEKEVENTREG_13_20 PACK_WEEKEVENTREG_FLAG(13, 0x20)
-#define WEEKEVENTREG_13_40 PACK_WEEKEVENTREG_FLAG(13, 0x40)
-#define WEEKEVENTREG_13_80 PACK_WEEKEVENTREG_FLAG(13, 0x80)
+
+// This flag marks that the player has finished the Oceanside Spider House and has exited.
+// Used to identify if EnSth should be moved deeper into the house.
+// This does NOT flag:
+// A) that the player has completed the house (Inventory_GetSkullTokenCount(play->sceneId))
+// B) that the player has collected a reward (WEEKEVENTREG_OCEANSIDE_SPIDER_HOUSE_COLLECTED_REWARD)
+// C) that the player has collected the wallet (WEEKEVENTREG_RECEIVED_OCEANSIDE_WALLET_UPGRADE)
+#define WEEKEVENTREG_OCEANSIDE_SPIDER_HOUSE_BUYER_MOVED_IN PACK_WEEKEVENTREG_FLAG(13, 0x20)
+
+#define WEEKEVENTREG_RECEIVED_OCEANSIDE_WALLET_UPGRADE PACK_WEEKEVENTREG_FLAG(13, 0x40)
+// You only get a wallet if completed on Day 1: repeat gets silver rupee, other days get less
+#define WEEKEVENTREG_OCEANSIDE_SPIDER_HOUSE_COLLECTED_REWARD PACK_WEEKEVENTREG_FLAG(13, 0x80)
// PlayedMilkMinigame
// Attempted Cremia Cart Ride
@@ -830,10 +839,10 @@ typedef enum SunsSongState {
#define WEEKEVENTREG_34_02 PACK_WEEKEVENTREG_FLAG(34, 0x02)
#define WEEKEVENTREG_34_04 PACK_WEEKEVENTREG_FLAG(34, 0x04)
-#define WEEKEVENTREG_34_08 PACK_WEEKEVENTREG_FLAG(34, 0x08)
+#define WEEKEVENTREG_SWAMP_SPIDER_HOUSE_TALKED PACK_WEEKEVENTREG_FLAG(34, 0x08)
#define WEEKEVENTREG_34_10 PACK_WEEKEVENTREG_FLAG(34, 0x10)
#define WEEKEVENTREG_34_20 PACK_WEEKEVENTREG_FLAG(34, 0x20)
-#define WEEKEVENTREG_34_40 PACK_WEEKEVENTREG_FLAG(34, 0x40)
+#define WEEKEVENTREG_RECEIVED_MASK_OF_TRUTH PACK_WEEKEVENTREG_FLAG(34, 0x40)
// Cremia did Milk Run alone. Player didn't interact or didn't accept the ride
#define WEEKEVENTREG_34_80 PACK_WEEKEVENTREG_FLAG(34, 0x80)