Use macros to enforce "hidden object" constraints, and rename them to "hidden events" (#559)

28 files changed, 29 insertions, 29 deletions

diff --git a/engine/events/hidden_objects/bench_guys.asm b/engine/events/hidden_events/bench_guys.asm
index e5a2a724..e5a2a724 100644
--- a/engine/events/hidden_objects/bench_guys.asm
+++ b/engine/events/hidden_events/bench_guys.asm
diff --git a/engine/events/hidden_objects/bills_house_pc.asm b/engine/events/hidden_events/bills_house_pc.asm
index 3972e20c..3972e20c 100644
--- a/engine/events/hidden_objects/bills_house_pc.asm
+++ b/engine/events/hidden_events/bills_house_pc.asm
diff --git a/engine/events/hidden_objects/blues_room.asm b/engine/events/hidden_events/blues_room.asm
index bcbad556..bcbad556 100644
--- a/engine/events/hidden_objects/blues_room.asm
+++ b/engine/events/hidden_events/blues_room.asm
diff --git a/engine/events/hidden_objects/book_or_sculpture.asm b/engine/events/hidden_events/book_or_sculpture.asm
index e04f4047..e04f4047 100644
--- a/engine/events/hidden_objects/book_or_sculpture.asm
+++ b/engine/events/hidden_events/book_or_sculpture.asm
diff --git a/engine/events/hidden_objects/bookshelves.asm b/engine/events/hidden_events/bookshelves.asm
index 813cfc49..813cfc49 100644
--- a/engine/events/hidden_objects/bookshelves.asm
+++ b/engine/events/hidden_events/bookshelves.asm
diff --git a/engine/events/hidden_objects/cinnabar_gym_quiz.asm b/engine/events/hidden_events/cinnabar_gym_quiz.asm
index a14bd198..9762c214 100644
--- a/engine/events/hidden_objects/cinnabar_gym_quiz.asm
+++ b/engine/events/hidden_events/cinnabar_gym_quiz.asm
@@ -9,7 +9,7 @@ CinnabarGymQuiz::
 	text_asm
 	xor a
 	ld [wOpponentAfterWrongAnswer], a
-	ld a, [wHiddenObjectFunctionArgument]
+	ld a, [wHiddenEventFunctionArgument]
 	push af
 	and $f
 	ldh [hGymGateIndex], a
diff --git a/engine/events/hidden_objects/elevator.asm b/engine/events/hidden_events/elevator.asm
index ab0f731f..ab0f731f 100644
--- a/engine/events/hidden_objects/elevator.asm
+++ b/engine/events/hidden_events/elevator.asm
diff --git a/engine/events/hidden_objects/fighting_dojo.asm b/engine/events/hidden_events/fighting_dojo.asm
index b4f89985..b4f89985 100644
--- a/engine/events/hidden_objects/fighting_dojo.asm
+++ b/engine/events/hidden_events/fighting_dojo.asm
diff --git a/engine/events/hidden_objects/gym_statues.asm b/engine/events/hidden_events/gym_statues.asm
index 1c7eb970..1c7eb970 100644
--- a/engine/events/hidden_objects/gym_statues.asm
+++ b/engine/events/hidden_events/gym_statues.asm
diff --git a/engine/events/hidden_objects/indigo_plateau_hq.asm b/engine/events/hidden_events/indigo_plateau_hq.asm
index e8fd0220..e8fd0220 100644
--- a/engine/events/hidden_objects/indigo_plateau_hq.asm
+++ b/engine/events/hidden_events/indigo_plateau_hq.asm
diff --git a/engine/events/hidden_objects/indigo_plateau_statues.asm b/engine/events/hidden_events/indigo_plateau_statues.asm
index f78a5a72..f78a5a72 100644
--- a/engine/events/hidden_objects/indigo_plateau_statues.asm
+++ b/engine/events/hidden_events/indigo_plateau_statues.asm
diff --git a/engine/events/hidden_objects/magazines.asm b/engine/events/hidden_events/magazines.asm
index b58636ff..b58636ff 100644
--- a/engine/events/hidden_objects/magazines.asm
+++ b/engine/events/hidden_events/magazines.asm
diff --git a/engine/events/hidden_objects/museum_fossils.asm b/engine/events/hidden_events/museum_fossils.asm
index df74293f..df74293f 100644
--- a/engine/events/hidden_objects/museum_fossils.asm
+++ b/engine/events/hidden_events/museum_fossils.asm
diff --git a/engine/events/hidden_objects/new_bike.asm b/engine/events/hidden_events/new_bike.asm
index 5bce5937..5bce5937 100644
--- a/engine/events/hidden_objects/new_bike.asm
+++ b/engine/events/hidden_events/new_bike.asm
diff --git a/engine/events/hidden_objects/oaks_lab_email.asm b/engine/events/hidden_events/oaks_lab_email.asm
index b66babe0..b66babe0 100644
--- a/engine/events/hidden_objects/oaks_lab_email.asm
+++ b/engine/events/hidden_events/oaks_lab_email.asm
diff --git a/engine/events/hidden_objects/oaks_lab_posters.asm b/engine/events/hidden_events/oaks_lab_posters.asm
index 502cf951..502cf951 100644
--- a/engine/events/hidden_objects/oaks_lab_posters.asm
+++ b/engine/events/hidden_events/oaks_lab_posters.asm
diff --git a/engine/events/hidden_objects/pokecenter_pc.asm b/engine/events/hidden_events/pokecenter_pc.asm
index 59867d1a..59867d1a 100644
--- a/engine/events/hidden_objects/pokecenter_pc.asm
+++ b/engine/events/hidden_events/pokecenter_pc.asm
diff --git a/engine/events/hidden_objects/pokemon_stuff.asm b/engine/events/hidden_events/pokemon_stuff.asm
index 267a191a..267a191a 100644
--- a/engine/events/hidden_objects/pokemon_stuff.asm
+++ b/engine/events/hidden_events/pokemon_stuff.asm
diff --git a/engine/events/hidden_objects/reds_room.asm b/engine/events/hidden_events/reds_room.asm
index 7b8d51a0..7b8d51a0 100644
--- a/engine/events/hidden_objects/reds_room.asm
+++ b/engine/events/hidden_events/reds_room.asm
diff --git a/engine/events/hidden_objects/route_15_binoculars.asm b/engine/events/hidden_events/route_15_binoculars.asm
index 733ab73e..733ab73e 100644
--- a/engine/events/hidden_objects/route_15_binoculars.asm
+++ b/engine/events/hidden_events/route_15_binoculars.asm
diff --git a/engine/events/hidden_objects/safari_game.asm b/engine/events/hidden_events/safari_game.asm
index fc014ce0..fc014ce0 100644
--- a/engine/events/hidden_objects/safari_game.asm
+++ b/engine/events/hidden_events/safari_game.asm
diff --git a/engine/events/hidden_objects/school_blackboard.asm b/engine/events/hidden_events/school_blackboard.asm
index 4ac83953..71e24ed0 100644
--- a/engine/events/hidden_objects/school_blackboard.asm
+++ b/engine/events/hidden_events/school_blackboard.asm
@@ -2,7 +2,7 @@ PrintBlackboardLinkCableText:
 	call EnableAutoTextBoxDrawing
 	ld a, $1
 	ld [wDoNotWaitForButtonPressAfterDisplayingText], a
-	ld a, [wHiddenObjectFunctionArgument]
+	ld a, [wHiddenEventFunctionArgument]
 	call PrintPredefTextID
 	ret
 
diff --git a/engine/events/hidden_objects/school_notebooks.asm b/engine/events/hidden_events/school_notebooks.asm
index 96a44ab5..2387c089 100644
--- a/engine/events/hidden_objects/school_notebooks.asm
+++ b/engine/events/hidden_events/school_notebooks.asm
@@ -2,7 +2,7 @@ PrintNotebookText:
 	call EnableAutoTextBoxDrawing
 	ld a, $1
 	ld [wDoNotWaitForButtonPressAfterDisplayingText], a
-	ld a, [wHiddenObjectFunctionArgument]
+	ld a, [wHiddenEventFunctionArgument]
 	jp PrintPredefTextID
 
 TMNotebook::
diff --git a/engine/events/hidden_objects/town_map.asm b/engine/events/hidden_events/town_map.asm
index 11f7cbc7..11f7cbc7 100644
--- a/engine/events/hidden_objects/town_map.asm
+++ b/engine/events/hidden_events/town_map.asm
diff --git a/engine/events/hidden_objects/vermilion_gym_trash.asm b/engine/events/hidden_events/vermilion_gym_trash.asm
index 73e50cca..40e200d6 100644
--- a/engine/events/hidden_objects/vermilion_gym_trash.asm
+++ b/engine/events/hidden_events/vermilion_gym_trash.asm
@@ -8,7 +8,7 @@ VermilionGymTrashText::
 
 GymTrashScript:
 	call EnableAutoTextBoxDrawing
-	ld a, [wHiddenObjectFunctionArgument]
+	ld a, [wHiddenEventFunctionArgument]
 	ld [wGymTrashCanIndex], a
 
 ; Don't do the trash can puzzle if it's already been done.
diff --git a/engine/events/hidden_items.asm b/engine/events/hidden_items.asm
index e42f60f9..065c2d5e 100644
--- a/engine/events/hidden_items.asm
+++ b/engine/events/hidden_items.asm
@@ -13,7 +13,7 @@ HiddenItems:
 	call EnableAutoTextBoxDrawing
 	ld a, 1
 	ld [wDoNotWaitForButtonPressAfterDisplayingText], a
-	ld a, [wHiddenObjectFunctionArgument] ; item ID
+	ld a, [wHiddenEventFunctionArgument] ; item ID
 	ld [wNamedObjectIndex], a
 	call GetItemName
 	tx_pre_jump FoundHiddenItemText
@@ -23,7 +23,7 @@ INCLUDE "data/events/hidden_item_coords.asm"
 FoundHiddenItemText::
 	text_far _FoundHiddenItemText
 	text_asm
-	ld a, [wHiddenObjectFunctionArgument] ; item ID
+	ld a, [wHiddenEventFunctionArgument] ; item ID
 	ld b, a
 	ld c, 1
 	call GiveItem
@@ -70,7 +70,7 @@ HiddenCoins:
 	ldh [hUnusedCoinsByte], a
 	ldh [hCoins], a
 	ldh [hCoins + 1], a
-	ld a, [wHiddenObjectFunctionArgument]
+	ld a, [wHiddenEventFunctionArgument]
 	sub COIN
 	cp 10
 	jr z, .bcd10
@@ -132,9 +132,9 @@ DroppedHiddenCoinsText::
 	text_end
 
 FindHiddenItemOrCoinsIndex:
-	ld a, [wHiddenObjectY]
+	ld a, [wHiddenEventY]
 	ld d, a
-	ld a, [wHiddenObjectX]
+	ld a, [wHiddenEventX]
 	ld e, a
 	ld a, [wCurMap]
 	ld b, a
diff --git a/engine/overworld/hidden_objects.asm b/engine/overworld/hidden_events.asm
index 2798864a..8369e533 100644
--- a/engine/overworld/hidden_objects.asm
+++ b/engine/overworld/hidden_events.asm
@@ -14,16 +14,16 @@ IsPlayerOnDungeonWarp::
 	set BIT_DUNGEON_WARP, [hl]
 	ret
 
-; if a hidden object was found, stores $00 in [hDidntFindAnyHiddenObject], else stores $ff
-CheckForHiddenObject::
+; if a hidden event was found, stores $00 in [hDidntFindAnyHiddenEvent], else stores $ff
+CheckForHiddenEvent::
 	ld hl, hItemAlreadyFound
 	xor a
 	ld [hli], a ; [hItemAlreadyFound]
 	ld [hli], a ; [hSavedMapTextPtr]
 	ld [hli], a ; [hSavedMapTextPtr + 1]
-	ld [hl], a  ; [hDidntFindAnyHiddenObject]
+	ld [hl], a  ; [hDidntFindAnyHiddenEvent]
 	ld de, $0
-	ld hl, HiddenObjectMaps
+	ld hl, HiddenEventMaps
 .hiddenMapLoop
 	ld a, [hli]
 	ld b, a
@@ -36,52 +36,52 @@ CheckForHiddenObject::
 	inc de
 	jr .hiddenMapLoop
 .foundMatchingMap
-	ld hl, HiddenObjectPointers
+	ld hl, HiddenEventPointers
 	add hl, de
 	ld a, [hli]
 	ld h, [hl]
 	ld l, a
 	push hl
-	ld hl, wHiddenObjectFunctionArgument
+	ld hl, wHiddenEventFunctionArgument
 	xor a
 	ld [hli], a
 	ld [hli], a
 	ld [hl], a
 	pop hl
-.hiddenObjectLoop
+.hiddenEventLoop
 	ld a, [hli]
 	cp $ff
 	jr z, .noMatch
-	ld [wHiddenObjectY], a
+	ld [wHiddenEventY], a
 	ld b, a
 	ld a, [hli]
-	ld [wHiddenObjectX], a
+	ld [wHiddenEventX], a
 	ld c, a
 	call CheckIfCoordsInFrontOfPlayerMatch
 	ldh a, [hCoordsInFrontOfPlayerMatch]
 	and a
-	jr z, .foundMatchingObject
+	jr z, .foundMatchingEvent
 	inc hl
 	inc hl
 	inc hl
 	inc hl
 	push hl
-	ld hl, wHiddenObjectIndex
+	ld hl, wHiddenEventIndex
 	inc [hl]
 	pop hl
-	jr .hiddenObjectLoop
-.foundMatchingObject
+	jr .hiddenEventLoop
+.foundMatchingEvent
 	ld a, [hli]
-	ld [wHiddenObjectFunctionArgument], a
+	ld [wHiddenEventFunctionArgument], a
 	ld a, [hli]
-	ld [wHiddenObjectFunctionRomBank], a
+	ld [wHiddenEventFunctionRomBank], a
 	ld a, [hli]
 	ld h, [hl]
 	ld l, a
 	ret
 .noMatch
 	ld a, $ff
-	ldh [hDidntFindAnyHiddenObject], a
+	ldh [hDidntFindAnyHiddenEvent], a
 	ret
 
 ; checks if the coordinates in front of the player's sprite match Y in b and X in c
@@ -130,4 +130,4 @@ CheckIfCoordsInFrontOfPlayerMatch:
 	ldh [hCoordsInFrontOfPlayerMatch], a
 	ret
 
-INCLUDE "data/events/hidden_objects.asm"
+INCLUDE "data/events/hidden_events.asm"
diff --git a/engine/slots/game_corner_slots.asm b/engine/slots/game_corner_slots.asm
index 48321974..d83d9d6a 100644
--- a/engine/slots/game_corner_slots.asm
+++ b/engine/slots/game_corner_slots.asm
@@ -1,5 +1,5 @@
 StartSlotMachine:
-	ld a, [wHiddenObjectFunctionArgument]
+	ld a, [wHiddenEventFunctionArgument]
 	cp SLOTS_OUTOFORDER
 	jr z, .printOutOfOrder
 	cp SLOTS_OUTTOLUNCH
@@ -10,9 +10,9 @@ StartSlotMachine:
 	ld a, [wCanPlaySlots]
 	and a
 	ret z
-	ld a, [wLuckySlotHiddenObjectIndex]
+	ld a, [wLuckySlotHiddenEventIndex]
 	ld b, a
-	ld a, [wHiddenObjectIndex]
+	ld a, [wHiddenEventIndex]
 	inc a
 	cp b
 	jr z, .match