Merge pull request #304 from SatoMew/master

Rename *TilesetType to *TileAnimations
2025-12-15 15:41:37 +13:00 · 2020-11-30 16:35:33 -06:00 · 2020-11-30 16:35:33 -06:00 · bb76c06120
parent 6adbaefde1 ae0e2fd194
commit bb76c06120
25 changed files with 88 additions and 89 deletions
--- a/audio.asm
+++ b/audio.asm
@ -411,7 +411,7 @@ INCLUDE "audio/music/pokecenter.asm"
 SECTION "Music 2", ROMX

 INCLUDE "audio/sfx/pokeflute_ch5_ch6.asm"
-INCLUDE "audio/sfx/unused2_2.asm"
+INCLUDE "audio/sfx/unused_fanfare.asm"
 INCLUDE "audio/music/gymleaderbattle.asm"
 INCLUDE "audio/music/trainerbattle.asm"
 INCLUDE "audio/music/wildbattle.asm"
--- a/audio/sfx/unused_fanfare.asm
+++ b/audio/sfx/unused_fanfare.asm
@ -1,4 +1,5 @@
-SFX_Unused2_Ch5:
+; This corresponds to SFX_KEY_ITEM in pokegold and pokecrystal.
+SFX_UnusedFanfare_Ch5: ; unreferenced
 	execute_music
 	tempo 256
 	volume 7, 7
@ -16,8 +17,7 @@ SFX_Unused2_Ch5:
 	note E_, 8
 	sound_ret

-
-SFX_Unused2_Ch6:
+SFX_UnusedFanfare_Ch6: ; unreferenced
 	execute_music
 	vibrato 8, 2, 7
 	duty_cycle 2
@ -32,8 +32,7 @@ SFX_Unused2_Ch6:
 	note B_, 8
 	sound_ret

-
-SFX_Unused2_Ch7:
+SFX_UnusedFanfare_Ch7: ; unreferenced
 	execute_music
 	note_type 6, 1, 0
 	octave 4
--- a/constants/map_data_constants.asm
+++ b/constants/map_data_constants.asm
@ -4,13 +4,13 @@ MAP_BORDER EQU 3

 ; connection directions
 	const_def
-	shift_const EAST  ; 1
-	shift_const WEST  ; 2
-	shift_const SOUTH ; 4
-	shift_const NORTH ; 8
+	shift_const EAST   ; 1
+	shift_const WEST   ; 2
+	shift_const SOUTH  ; 4
+	shift_const NORTH  ; 8

-; tileset environments
+; flower and water tile animations
 	const_def
-	const INDOOR  ; 0
-	const CAVE    ; 1
-	const OUTDOOR ; 2
+	const TILEANIM_NONE          ; 0
+	const TILEANIM_WATER         ; 1
+	const TILEANIM_WATER_FLOWER  ; 2
--- a/data/tilesets/tileset_headers.asm
+++ b/data/tilesets/tileset_headers.asm
@ -8,27 +8,27 @@ ENDM

 Tilesets:
 	; block, gfx, coll, 3 counter tiles, grass tile, permission
-	tileset Overworld_Block,   Overworld_GFX,   Overworld_Coll,   $FF,$FF,$FF, $52, OUTDOOR
-	tileset RedsHouse1_Block,  RedsHouse1_GFX,  RedsHouse1_Coll,  $FF,$FF,$FF, $FF, INDOOR
-	tileset Mart_Block,        Mart_GFX,        Mart_Coll,        $18,$19,$1E, $FF, INDOOR
-	tileset Forest_Block,      Forest_GFX,      Forest_Coll,      $FF,$FF,$FF, $20, CAVE
-	tileset RedsHouse2_Block,  RedsHouse2_GFX,  RedsHouse2_Coll,  $FF,$FF,$FF, $FF, INDOOR
-	tileset Dojo_Block,        Dojo_GFX,        Dojo_Coll,        $3A,$FF,$FF, $FF, OUTDOOR
-	tileset Pokecenter_Block,  Pokecenter_GFX,  Pokecenter_Coll,  $18,$19,$1E, $FF, INDOOR
-	tileset Gym_Block,         Gym_GFX,         Gym_Coll,         $3A,$FF,$FF, $FF, OUTDOOR
-	tileset House_Block,       House_GFX,       House_Coll,       $FF,$FF,$FF, $FF, INDOOR
-	tileset ForestGate_Block,  ForestGate_GFX,  ForestGate_Coll,  $17,$32,$FF, $FF, INDOOR
-	tileset Museum_Block,      Museum_GFX,      Museum_Coll,      $17,$32,$FF, $FF, INDOOR
-	tileset Underground_Block, Underground_GFX, Underground_Coll, $FF,$FF,$FF, $FF, INDOOR
-	tileset Gate_Block,        Gate_GFX,        Gate_Coll,        $17,$32,$FF, $FF, INDOOR
-	tileset Ship_Block,        Ship_GFX,        Ship_Coll,        $FF,$FF,$FF, $FF, CAVE
-	tileset ShipPort_Block,    ShipPort_GFX,    ShipPort_Coll,    $FF,$FF,$FF, $FF, CAVE
-	tileset Cemetery_Block,    Cemetery_GFX,    Cemetery_Coll,    $12,$FF,$FF, $FF, INDOOR
-	tileset Interior_Block,    Interior_GFX,    Interior_Coll,    $FF,$FF,$FF, $FF, INDOOR
-	tileset Cavern_Block,      Cavern_GFX,      Cavern_Coll,      $FF,$FF,$FF, $FF, CAVE
-	tileset Lobby_Block,       Lobby_GFX,       Lobby_Coll,       $15,$36,$FF, $FF, INDOOR
-	tileset Mansion_Block,     Mansion_GFX,     Mansion_Coll,     $FF,$FF,$FF, $FF, INDOOR
-	tileset Lab_Block,         Lab_GFX,         Lab_Coll,         $FF,$FF,$FF, $FF, INDOOR
-	tileset Club_Block,        Club_GFX,        Club_Coll,        $07,$17,$FF, $FF, INDOOR
-	tileset Facility_Block,    Facility_GFX,    Facility_Coll,    $12,$FF,$FF, $FF, CAVE
-	tileset Plateau_Block,     Plateau_GFX,     Plateau_Coll,     $FF,$FF,$FF, $45, CAVE
+	tileset Overworld_Block,   Overworld_GFX,   Overworld_Coll,   $FF,$FF,$FF, $52, TILEANIM_WATER_FLOWER
+	tileset RedsHouse1_Block,  RedsHouse1_GFX,  RedsHouse1_Coll,  $FF,$FF,$FF, $FF, TILEANIM_NONE
+	tileset Mart_Block,        Mart_GFX,        Mart_Coll,        $18,$19,$1E, $FF, TILEANIM_NONE
+	tileset Forest_Block,      Forest_GFX,      Forest_Coll,      $FF,$FF,$FF, $20, TILEANIM_WATER
+	tileset RedsHouse2_Block,  RedsHouse2_GFX,  RedsHouse2_Coll,  $FF,$FF,$FF, $FF, TILEANIM_NONE
+	tileset Dojo_Block,        Dojo_GFX,        Dojo_Coll,        $3A,$FF,$FF, $FF, TILEANIM_WATER_FLOWER
+	tileset Pokecenter_Block,  Pokecenter_GFX,  Pokecenter_Coll,  $18,$19,$1E, $FF, TILEANIM_NONE
+	tileset Gym_Block,         Gym_GFX,         Gym_Coll,         $3A,$FF,$FF, $FF, TILEANIM_WATER_FLOWER
+	tileset House_Block,       House_GFX,       House_Coll,       $FF,$FF,$FF, $FF, TILEANIM_NONE
+	tileset ForestGate_Block,  ForestGate_GFX,  ForestGate_Coll,  $17,$32,$FF, $FF, TILEANIM_NONE
+	tileset Museum_Block,      Museum_GFX,      Museum_Coll,      $17,$32,$FF, $FF, TILEANIM_NONE
+	tileset Underground_Block, Underground_GFX, Underground_Coll, $FF,$FF,$FF, $FF, TILEANIM_NONE
+	tileset Gate_Block,        Gate_GFX,        Gate_Coll,        $17,$32,$FF, $FF, TILEANIM_NONE
+	tileset Ship_Block,        Ship_GFX,        Ship_Coll,        $FF,$FF,$FF, $FF, TILEANIM_WATER
+	tileset ShipPort_Block,    ShipPort_GFX,    ShipPort_Coll,    $FF,$FF,$FF, $FF, TILEANIM_WATER
+	tileset Cemetery_Block,    Cemetery_GFX,    Cemetery_Coll,    $12,$FF,$FF, $FF, TILEANIM_NONE
+	tileset Interior_Block,    Interior_GFX,    Interior_Coll,    $FF,$FF,$FF, $FF, TILEANIM_NONE
+	tileset Cavern_Block,      Cavern_GFX,      Cavern_Coll,      $FF,$FF,$FF, $FF, TILEANIM_WATER
+	tileset Lobby_Block,       Lobby_GFX,       Lobby_Coll,       $15,$36,$FF, $FF, TILEANIM_NONE
+	tileset Mansion_Block,     Mansion_GFX,     Mansion_Coll,     $FF,$FF,$FF, $FF, TILEANIM_NONE
+	tileset Lab_Block,         Lab_GFX,         Lab_Coll,         $FF,$FF,$FF, $FF, TILEANIM_NONE
+	tileset Club_Block,        Club_GFX,        Club_Coll,        $07,$17,$FF, $FF, TILEANIM_NONE
+	tileset Facility_Block,    Facility_GFX,    Facility_Coll,    $12,$FF,$FF, $FF, TILEANIM_WATER
+	tileset Plateau_Block,     Plateau_GFX,     Plateau_Coll,     $FF,$FF,$FF, $45, TILEANIM_WATER
--- 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
@ -6865,8 +6865,8 @@ _InitBattleCommon:
 	ld [wLetterPrintingDelayFlags], a
 	pop af
 	ld [wMapPalOffset], a
-	ld a, [wSavedTilesetType]
-	ldh [hTilesetType], a
+	ld a, [wSavedTileAnimations]
+	ldh [hTileAnimations], a
 	scf
 	ret
 .emptyString
--- a/engine/battle/init_battle_variables.asm
+++ b/engine/battle/init_battle_variables.asm
@ -1,6 +1,6 @@
 InitBattleVariables:
-	ldh a, [hTilesetType]
-	ld [wSavedTilesetType], a
+	ldh a, [hTileAnimations]
+	ld [wSavedTileAnimations], a
 	xor a
 	ld [wActionResultOrTookBattleTurn], a
 	ld [wBattleResult], a
--- 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
--- 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
--- a/engine/menus/save.asm
+++ b/engine/menus/save.asm
@ -69,8 +69,8 @@ LoadSAV0:
 	ld de, wSpriteDataStart
 	ld bc, wSpriteDataEnd - wSpriteDataStart
 	call CopyData
-	ld a, [sTilesetType]
-	ldh [hTilesetType], a
+	ld a, [sTileAnimations]
+	ldh [hTileAnimations], a
 	ld hl, sCurBoxData
 	ld de, wBoxDataStart
 	ld bc, wBoxDataEnd - wBoxDataStart
@ -217,8 +217,8 @@ SaveSAVtoSRAM0:
 	ld de, sCurBoxData
 	ld bc, wBoxDataEnd - wBoxDataStart
 	call CopyData
-	ldh a, [hTilesetType]
-	ld [sTilesetType], a
+	ldh a, [hTileAnimations]
+	ld [sTileAnimations], a
 	ld hl, sPlayerName
 	ld bc, sMainDataCheckSum - sPlayerName
 	call SAVCheckSum
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
 	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
--- 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
--- 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
--- 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
--- 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
--- 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]
--- 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
--- 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 which tiles are animated.
+; 0 = no animations (breaks Surf)
+; 1 = water tile $14 is animated
+; 2 = water tile $14 and flower tile $03 are animated
+hTileAnimations:: db

 hMovingBGTilesCounter1:: db

--- a/sram.asm
+++ b/sram.asm
@ -17,7 +17,7 @@ sMainData::    ds wMainDataEnd   - wMainDataStart
 sSpriteData::  ds wSpriteDataEnd - wSpriteDataStart
 sPartyData::   ds wPartyDataEnd  - wPartyDataStart
 sCurBoxData::  ds wBoxDataEnd    - wBoxDataStart
-sTilesetType:: ds 1
+sTileAnimations:: ds 1
 sMainDataCheckSum:: ds 1


--- a/wram.asm
+++ b/wram.asm
@ -2000,7 +2000,7 @@ wMonHLearnset::
 	ds 1
 wMonHeaderEnd::

-wSavedTilesetType::
+wSavedTileAnimations::
 ; saved at the start of a battle and then written back at the end of the battle
 	ds 1