Label and document hFFD7 more accurately

19 files changed, 45 insertions, 45 deletions

diff --git a/engine/battle/core.asm b/engine/battle/core.asm
index 5ea60cb4..7957c552 100644
--- a/engine/battle/core.asm
+++ b/engine/battle/core.asm
@@ -51,7 +51,7 @@ SlidePlayerAndEnemySilhouettesOnScreen:
 	ldh [hWY], a
 	ldh [rWY], a
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ldh [hSCY], a
 	dec a
 	ld [wUpdateSpritesEnabled], a
@@ -6275,7 +6275,7 @@ DoBattleTransitionAndInitBattleVariables:
 	ldh [hAutoBGTransferEnabled], a
 	ldh [hWY], a
 	ldh [rWY], a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ld hl, wPlayerStatsToDouble
 	ld [hli], a
 	ld [hli], a
@@ -6866,7 +6866,7 @@ _InitBattleCommon:
 	pop af
 	ld [wMapPalOffset], a
 	ld a, [wSavedTilesetType]
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	scf
 	ret
 .emptyString
diff --git a/engine/battle/init_battle_variables.asm b/engine/battle/init_battle_variables.asm
index 0d403b55..703f5f07 100644
--- a/engine/battle/init_battle_variables.asm
+++ b/engine/battle/init_battle_variables.asm
@@ -1,5 +1,5 @@
 InitBattleVariables:
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	ld [wSavedTilesetType], a
 	xor a
 	ld [wActionResultOrTookBattleTurn], a
diff --git a/engine/menus/league_pc.asm b/engine/menus/league_pc.asm
index f2107c49..533454ad 100644
--- a/engine/menus/league_pc.asm
+++ b/engine/menus/league_pc.asm
@@ -6,10 +6,10 @@ PKMNLeaguePC:
 	push hl
 	ld a, [wUpdateSpritesEnabled]
 	push af
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	push af
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ld [wSpriteFlipped], a
 	ld [wUpdateSpritesEnabled], a
 	ld [wHoFTeamIndex2], a
@@ -40,7 +40,7 @@ PKMNLeaguePC:
 	jr nz, .loop
 .doneShowingTeams
 	pop af
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	pop af
 	ld [wUpdateSpritesEnabled], a
 	pop hl
diff --git a/engine/menus/pokedex.asm b/engine/menus/pokedex.asm
index 5660ecfb..2af8d714 100644
--- a/engine/menus/pokedex.asm
+++ b/engine/menus/pokedex.asm
@@ -410,10 +410,10 @@ ShowPokedexDataInternal:
 	call RunPaletteCommand
 	pop af
 	ld [wd11e], a
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	push af
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 
 	hlcoord 0, 0
 	ld de, 1
@@ -577,7 +577,7 @@ ShowPokedexDataInternal:
 	and A_BUTTON | B_BUTTON
 	jr z, .waitForButtonPress
 	pop af
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	call GBPalWhiteOut
 	call ClearScreen
 	call RunDefaultPaletteCommand
diff --git a/engine/menus/save.asm b/engine/menus/save.asm
index 45fed8a6..72c33d8e 100644
--- a/engine/menus/save.asm
+++ b/engine/menus/save.asm
@@ -70,7 +70,7 @@ LoadSAV0:
 	ld bc, wSpriteDataEnd - wSpriteDataStart
 	call CopyData
 	ld a, [sTilesetType]
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ld hl, sCurBoxData
 	ld de, wBoxDataStart
 	ld bc, wBoxDataEnd - wBoxDataStart
@@ -217,7 +217,7 @@ SaveSAVtoSRAM0:
 	ld de, sCurBoxData
 	ld bc, wBoxDataEnd - wBoxDataStart
 	call CopyData
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	ld [sTilesetType], a
 	ld hl, sPlayerName
 	ld bc, sMainDataCheckSum - sPlayerName
diff --git a/engine/menus/start_sub_menus.asm b/engine/menus/start_sub_menus.asm
index 6a98a10c..c0448121 100644
--- a/engine/menus/start_sub_menus.asm
+++ b/engine/menus/start_sub_menus.asm
@@ -454,10 +454,10 @@ StartMenu_TrainerInfo::
 	call GBPalWhiteOut
 	call ClearScreen
 	call UpdateSprites
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	push af
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	call DrawTrainerInfo
 	predef DrawBadges ; draw badges
 	ld b, SET_PAL_TRAINER_CARD
@@ -471,7 +471,7 @@ StartMenu_TrainerInfo::
 	call ReloadMapData
 	call LoadGBPal
 	pop af
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	jp RedisplayStartMenu
 
 ; loads tile patterns and draws everything except for gym leader faces / badges
diff --git a/engine/movie/evolution.asm b/engine/movie/evolution.asm
index cabe7254..77840556 100644
--- a/engine/movie/evolution.asm
+++ b/engine/movie/evolution.asm
@@ -19,7 +19,7 @@ EvolveMon:
 	call Delay3
 	xor a
 	ldh [hAutoBGTransferEnabled], a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ld a, [wEvoOldSpecies]
 	ld [wWholeScreenPaletteMonSpecies], a
 	ld c, 0
diff --git a/engine/movie/hall_of_fame.asm b/engine/movie/hall_of_fame.asm
index a7d3ed40..d37d95f8 100644
--- a/engine/movie/hall_of_fame.asm
+++ b/engine/movie/hall_of_fame.asm
@@ -19,7 +19,7 @@ AnimateHallOfFame:
 	call FillMemory
 	xor a
 	ld [wUpdateSpritesEnabled], a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ld [wSpriteFlipped], a
 	ld [wLetterPrintingDelayFlags], a ; no delay
 	ld [wHoFMonOrPlayer], a ; mon
diff --git a/engine/movie/oak_speech/oak_speech.asm b/engine/movie/oak_speech/oak_speech.asm
index 4b64f20d..93cdfaab 100644
--- a/engine/movie/oak_speech/oak_speech.asm
+++ b/engine/movie/oak_speech/oak_speech.asm
@@ -52,7 +52,7 @@ OakSpeech:
 	ld [wDestinationMap], a
 	call SpecialWarpIn
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ld a, [wd732]
 	bit 1, a ; possibly a debug mode bit
 	jp nz, .skipChoosingNames
diff --git a/engine/movie/title.asm b/engine/movie/title.asm
index ef015795..8f97f8fa 100644
--- a/engine/movie/title.asm
+++ b/engine/movie/title.asm
@@ -26,7 +26,7 @@ DisplayTitleScreen:
 	ld a, $1
 	ldh [hAutoBGTransferEnabled], a
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ldh [hSCX], a
 	ld a, $40
 	ldh [hSCY], a
diff --git a/engine/overworld/tilesets.asm b/engine/overworld/tilesets.asm
index f40cbbc2..fa5cf626 100644
--- a/engine/overworld/tilesets.asm
+++ b/engine/overworld/tilesets.asm
@@ -23,7 +23,7 @@ LoadTilesetHeader:
 	dec c
 	jr nz, .copyTilesetHeaderLoop
 	ld a, [hl]
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	xor a
 	ldh [hMovingBGTilesCounter1], a
 	pop hl
diff --git a/engine/overworld/update_map.asm b/engine/overworld/update_map.asm
index 53a5592d..26334733 100644
--- a/engine/overworld/update_map.asm
+++ b/engine/overworld/update_map.asm
@@ -52,11 +52,11 @@ RedrawMapView:
 	ret z
 	ldh a, [hAutoBGTransferEnabled]
 	push af
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	push af
 	xor a
 	ldh [hAutoBGTransferEnabled], a
-	ldh [hTilesetType], a ; no flower/water BG tile animations
+	ldh [hTileAnimations], a ; no flower/water BG tile animations
 	call LoadCurrentMapView
 	call RunDefaultPaletteCommand
 	ld hl, wMapViewVRAMPointer
@@ -112,7 +112,7 @@ RedrawMapView:
 	dec c
 	jr nz, .redrawRowLoop
 	pop af
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	pop af
 	ldh [hAutoBGTransferEnabled], a
 	ret
diff --git a/engine/pokemon/evos_moves.asm b/engine/pokemon/evos_moves.asm
index ed44f9a6..21b1c9f4 100644
--- a/engine/pokemon/evos_moves.asm
+++ b/engine/pokemon/evos_moves.asm
@@ -11,7 +11,7 @@ TryEvolvingMon:
 ; this is only called after battle
 ; it is supposed to do level up evolutions, though there is a bug that allows item evolutions to occur
 EvolutionAfterBattle:
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	push af
 	xor a
 	ld [wEvolutionOccurred], a
@@ -245,7 +245,7 @@ Evolution_PartyMonLoop: ; loop over party mons
 	pop bc
 	pop hl
 	pop af
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ld a, [wLinkState]
 	cp LINK_STATE_TRADING
 	ret z
diff --git a/engine/pokemon/status_screen.asm b/engine/pokemon/status_screen.asm
index d4a4e59a..33fef9e4 100644
--- a/engine/pokemon/status_screen.asm
+++ b/engine/pokemon/status_screen.asm
@@ -101,10 +101,10 @@ StatusScreen:
 	ld hl, vChars2 tile $72
 	lb bc, BANK(PTile), 1
 	call CopyVideoDataDouble ; bold P (for PP)
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	push af
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	hlcoord 19, 1
 	lb bc, 6, 10
 	call DrawLineBox ; Draws the box around name, HP and status
@@ -174,7 +174,7 @@ StatusScreen:
 	call PlayCry ; play Pokémon cry
 	call WaitForTextScrollButtonPress ; wait for button
 	pop af
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ret
 
 .GetStringPointer
@@ -296,10 +296,10 @@ StatsText:
 	next "SPECIAL@"
 
 StatusScreen2:
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	push af
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ldh [hAutoBGTransferEnabled], a
 	ld bc, NUM_MOVES + 1
 	ld hl, wMoves
@@ -429,7 +429,7 @@ StatusScreen2:
 	call Delay3
 	call WaitForTextScrollButtonPress ; wait for button
 	pop af
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ld hl, wd72c
 	res 1, [hl]
 	ld a, $77
diff --git a/home/init.asm b/home/init.asm
index fe7dc9a9..e5840e65 100644
--- a/home/init.asm
+++ b/home/init.asm
@@ -65,7 +65,7 @@ rLCDC_DEFAULT EQU %11100011
 	call WriteDMACodeToHRAM
 
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	ldh [rSTAT], a
 	ldh [hSCX], a
 	ldh [hSCY], a
diff --git a/home/overworld.asm b/home/overworld.asm
index a9cfba24..be2c5d55 100644
--- a/home/overworld.asm
+++ b/home/overworld.asm
@@ -813,7 +813,7 @@ LoadPlayerSpriteGraphics::
 	dec a
 	jr z, .ridingBike
 
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	and a
 	jr nz, .determineGraphics
 	jr .startWalking
diff --git a/home/pokemon.asm b/home/pokemon.asm
index 5406c0ad..af83f7a0 100644
--- a/home/pokemon.asm
+++ b/home/pokemon.asm
@@ -175,10 +175,10 @@ GetCryData::
 	ret
 
 DisplayPartyMenu::
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	push af
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	call GBPalWhiteOutWithDelay3
 	call ClearSprites
 	call PartyMenuInit
@@ -186,10 +186,10 @@ DisplayPartyMenu::
 	jp HandlePartyMenuInput
 
 GoBackToPartyMenu::
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	push af
 	xor a
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	call PartyMenuInit
 	call RedrawPartyMenu
 	jp HandlePartyMenuInput
@@ -251,7 +251,7 @@ HandlePartyMenuInput::
 	and a
 	jp nz, .swappingPokemon
 	pop af
-	ldh [hTilesetType], a
+	ldh [hTileAnimations], a
 	bit 1, b
 	jr nz, .noPokemonChosen
 	ld a, [wPartyCount]
diff --git a/home/vcopy.asm b/home/vcopy.asm
index 458fa610..882773a8 100644
--- a/home/vcopy.asm
+++ b/home/vcopy.asm
@@ -379,7 +379,7 @@ UpdateMovingBgTiles::
 ; Animate water and flower
 ; tiles in the overworld.
 
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	and a
 	ret z ; no animations if indoors (or if a menu set this to 0)
 
@@ -417,7 +417,7 @@ UpdateMovingBgTiles::
 	dec c
 	jr nz, .left
 .done
-	ldh a, [hTilesetType]
+	ldh a, [hTileAnimations]
 	rrca
 	ret nc
 ; if in a cave, no flower animations
diff --git a/hram.asm b/hram.asm
index 0ccbc60c..f3567cd9 100644
--- a/hram.asm
+++ b/hram.asm
@@ -277,11 +277,11 @@ hFrameCounter:: db ; decremented every V-blank (used for delays)
 ; you can detect that the V-blank handler has run since then.
 hVBlankOccurred:: db
 
-; 00 = indoor
-; 01 = cave
-; 02 = outdoor
-; this is often set to 00 in order to turn off water and flower BG tile animations
-hTilesetType:: db
+; Controls whether flower and water tiles are animated.
+; 00 = flowers and water are static (breaks Surf)
+; 01 = flowers are static, water is animated 
+; 02 = flowers and water are animated
+hTileAnimations:: db
 
 hMovingBGTilesCounter1:: db