Add documentation for HideHeadbuttTree

pret · Nov 29, 2024 · 3257bc1 · 3257bc1
1 parent 9b19999
commit 3257bc1
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/engine/events/field_moves.asm b/engine/events/field_moves.asm
@@ -74,6 +74,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]
@@ -87,7 +89,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