From 0e49aef88ef94b9d3e80d89e4eb718e9425045df Mon Sep 17 00:00:00 2001
From: Rangi <35663410+Rangi42@users.noreply.github.com>
Date: Wed, 7 Jan 2026 22:05:37 -0500
Subject: Use macros to enforce "hidden object" constraints, and rename them to
 "hidden events" (#559)

---
 engine/overworld/hidden_events.asm  | 133 ++++++++++++++++++++++++++++++++++++
 engine/overworld/hidden_objects.asm | 133 ------------------------------------
 2 files changed, 133 insertions(+), 133 deletions(-)
 create mode 100644 engine/overworld/hidden_events.asm
 delete mode 100644 engine/overworld/hidden_objects.asm

(limited to 'engine/overworld')

diff --git a/engine/overworld/hidden_events.asm b/engine/overworld/hidden_events.asm
new file mode 100644
index 00000000..8369e533
--- /dev/null
+++ b/engine/overworld/hidden_events.asm
@@ -0,0 +1,133 @@
+IsPlayerOnDungeonWarp::
+	xor a
+	ld [wWhichDungeonWarp], a
+	ld a, [wStatusFlags3]
+	bit BIT_ON_DUNGEON_WARP, a
+	ret nz
+	call ArePlayerCoordsInArray
+	ret nc
+	ld a, [wCoordIndex]
+	ld [wWhichDungeonWarp], a
+	ld hl, wStatusFlags3
+	set BIT_ON_DUNGEON_WARP, [hl]
+	ld hl, wStatusFlags6
+	set BIT_DUNGEON_WARP, [hl]
+	ret
+
+; 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  ; [hDidntFindAnyHiddenEvent]
+	ld de, $0
+	ld hl, HiddenEventMaps
+.hiddenMapLoop
+	ld a, [hli]
+	ld b, a
+	cp $ff
+	jr z, .noMatch
+	ld a, [wCurMap]
+	cp b
+	jr z, .foundMatchingMap
+	inc de
+	inc de
+	jr .hiddenMapLoop
+.foundMatchingMap
+	ld hl, HiddenEventPointers
+	add hl, de
+	ld a, [hli]
+	ld h, [hl]
+	ld l, a
+	push hl
+	ld hl, wHiddenEventFunctionArgument
+	xor a
+	ld [hli], a
+	ld [hli], a
+	ld [hl], a
+	pop hl
+.hiddenEventLoop
+	ld a, [hli]
+	cp $ff
+	jr z, .noMatch
+	ld [wHiddenEventY], a
+	ld b, a
+	ld a, [hli]
+	ld [wHiddenEventX], a
+	ld c, a
+	call CheckIfCoordsInFrontOfPlayerMatch
+	ldh a, [hCoordsInFrontOfPlayerMatch]
+	and a
+	jr z, .foundMatchingEvent
+	inc hl
+	inc hl
+	inc hl
+	inc hl
+	push hl
+	ld hl, wHiddenEventIndex
+	inc [hl]
+	pop hl
+	jr .hiddenEventLoop
+.foundMatchingEvent
+	ld a, [hli]
+	ld [wHiddenEventFunctionArgument], a
+	ld a, [hli]
+	ld [wHiddenEventFunctionRomBank], a
+	ld a, [hli]
+	ld h, [hl]
+	ld l, a
+	ret
+.noMatch
+	ld a, $ff
+	ldh [hDidntFindAnyHiddenEvent], a
+	ret
+
+; checks if the coordinates in front of the player's sprite match Y in b and X in c
+; [hCoordsInFrontOfPlayerMatch] = $00 if they match, $ff if they don't match
+CheckIfCoordsInFrontOfPlayerMatch:
+	ld a, [wSpritePlayerStateData1FacingDirection]
+	cp SPRITE_FACING_UP
+	jr z, .facingUp
+	cp SPRITE_FACING_LEFT
+	jr z, .facingLeft
+	cp SPRITE_FACING_RIGHT
+	jr z, .facingRight
+; facing down
+	ld a, [wYCoord]
+	inc a
+	jr .upDownCommon
+.facingUp
+	ld a, [wYCoord]
+	dec a
+.upDownCommon
+	cp b
+	jr nz, .didNotMatch
+	ld a, [wXCoord]
+	cp c
+	jr nz, .didNotMatch
+	jr .matched
+.facingLeft
+	ld a, [wXCoord]
+	dec a
+	jr .leftRightCommon
+.facingRight
+	ld a, [wXCoord]
+	inc a
+.leftRightCommon
+	cp c
+	jr nz, .didNotMatch
+	ld a, [wYCoord]
+	cp b
+	jr nz, .didNotMatch
+.matched
+	xor a
+	jr .done
+.didNotMatch
+	ld a, $ff
+.done
+	ldh [hCoordsInFrontOfPlayerMatch], a
+	ret
+
+INCLUDE "data/events/hidden_events.asm"
diff --git a/engine/overworld/hidden_objects.asm b/engine/overworld/hidden_objects.asm
deleted file mode 100644
index 2798864a..00000000
--- a/engine/overworld/hidden_objects.asm
+++ /dev/null
@@ -1,133 +0,0 @@
-IsPlayerOnDungeonWarp::
-	xor a
-	ld [wWhichDungeonWarp], a
-	ld a, [wStatusFlags3]
-	bit BIT_ON_DUNGEON_WARP, a
-	ret nz
-	call ArePlayerCoordsInArray
-	ret nc
-	ld a, [wCoordIndex]
-	ld [wWhichDungeonWarp], a
-	ld hl, wStatusFlags3
-	set BIT_ON_DUNGEON_WARP, [hl]
-	ld hl, wStatusFlags6
-	set BIT_DUNGEON_WARP, [hl]
-	ret
-
-; if a hidden object was found, stores $00 in [hDidntFindAnyHiddenObject], else stores $ff
-CheckForHiddenObject::
-	ld hl, hItemAlreadyFound
-	xor a
-	ld [hli], a ; [hItemAlreadyFound]
-	ld [hli], a ; [hSavedMapTextPtr]
-	ld [hli], a ; [hSavedMapTextPtr + 1]
-	ld [hl], a  ; [hDidntFindAnyHiddenObject]
-	ld de, $0
-	ld hl, HiddenObjectMaps
-.hiddenMapLoop
-	ld a, [hli]
-	ld b, a
-	cp $ff
-	jr z, .noMatch
-	ld a, [wCurMap]
-	cp b
-	jr z, .foundMatchingMap
-	inc de
-	inc de
-	jr .hiddenMapLoop
-.foundMatchingMap
-	ld hl, HiddenObjectPointers
-	add hl, de
-	ld a, [hli]
-	ld h, [hl]
-	ld l, a
-	push hl
-	ld hl, wHiddenObjectFunctionArgument
-	xor a
-	ld [hli], a
-	ld [hli], a
-	ld [hl], a
-	pop hl
-.hiddenObjectLoop
-	ld a, [hli]
-	cp $ff
-	jr z, .noMatch
-	ld [wHiddenObjectY], a
-	ld b, a
-	ld a, [hli]
-	ld [wHiddenObjectX], a
-	ld c, a
-	call CheckIfCoordsInFrontOfPlayerMatch
-	ldh a, [hCoordsInFrontOfPlayerMatch]
-	and a
-	jr z, .foundMatchingObject
-	inc hl
-	inc hl
-	inc hl
-	inc hl
-	push hl
-	ld hl, wHiddenObjectIndex
-	inc [hl]
-	pop hl
-	jr .hiddenObjectLoop
-.foundMatchingObject
-	ld a, [hli]
-	ld [wHiddenObjectFunctionArgument], a
-	ld a, [hli]
-	ld [wHiddenObjectFunctionRomBank], a
-	ld a, [hli]
-	ld h, [hl]
-	ld l, a
-	ret
-.noMatch
-	ld a, $ff
-	ldh [hDidntFindAnyHiddenObject], a
-	ret
-
-; checks if the coordinates in front of the player's sprite match Y in b and X in c
-; [hCoordsInFrontOfPlayerMatch] = $00 if they match, $ff if they don't match
-CheckIfCoordsInFrontOfPlayerMatch:
-	ld a, [wSpritePlayerStateData1FacingDirection]
-	cp SPRITE_FACING_UP
-	jr z, .facingUp
-	cp SPRITE_FACING_LEFT
-	jr z, .facingLeft
-	cp SPRITE_FACING_RIGHT
-	jr z, .facingRight
-; facing down
-	ld a, [wYCoord]
-	inc a
-	jr .upDownCommon
-.facingUp
-	ld a, [wYCoord]
-	dec a
-.upDownCommon
-	cp b
-	jr nz, .didNotMatch
-	ld a, [wXCoord]
-	cp c
-	jr nz, .didNotMatch
-	jr .matched
-.facingLeft
-	ld a, [wXCoord]
-	dec a
-	jr .leftRightCommon
-.facingRight
-	ld a, [wXCoord]
-	inc a
-.leftRightCommon
-	cp c
-	jr nz, .didNotMatch
-	ld a, [wYCoord]
-	cp b
-	jr nz, .didNotMatch
-.matched
-	xor a
-	jr .done
-.didNotMatch
-	ld a, $ff
-.done
-	ldh [hCoordsInFrontOfPlayerMatch], a
-	ret
-
-INCLUDE "data/events/hidden_objects.asm"
-- 
cgit v1.3.1-sl0p