From 8894e29da2ed79a78907cbee89a12aadf66e8236 Mon Sep 17 00:00:00 2001
From: Jordan Moore <46928924+jordanmoore753@users.noreply.github.com>
Date: Thu, 28 Nov 2024 11:20:15 -0500
Subject: [PATCH] Add documentation for HideHeadbuttTree (#1152)

---
 engine/events/field_moves.asm | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/engine/events/field_moves.asm b/engine/events/field_moves.asm
index 27e7ab563ce..6abcc09ca48 100644
--- a/engine/events/field_moves.asm
+++ b/engine/events/field_moves.asm
@@ -79,6 +79,8 @@ HeadbuttTreeGFX:
 INCBIN "gfx/overworld/headbutt_tree.2bpp"
 
 HideHeadbuttTree:
+	; Replaces all four headbutted tree tiles with tile $05
+	; Assumes any tileset with headbutt trees has grass at tile $05
 	xor a
 	ldh [hBGMapMode], a
 	ld a, [wPlayerDirection]
@@ -92,7 +94,7 @@ HideHeadbuttTree:
 	ld h, [hl]
 	ld l, a
 
-	ld a, $05 ; grass block
+	ld a, $05 ; grass tile
 	ld [hli], a
 	ld [hld], a
 	ld bc, SCREEN_WIDTH