Identify wCurrentMapScriptFlags bits (pret#467)

Author: Rangi42

constants/ram_constants.asm

@@ -23,6 +23,12 @@ DEF BIT_TEXT_PREDEF EQU 0
 ; wFontLoaded
 DEF BIT_FONT_LOADED EQU 0
 
+; wCurrentMapScriptFlags
+	const_def 5
+	const BIT_CUR_MAP_LOADED_1 ; 5
+	const BIT_CUR_MAP_LOADED_2 ; 6
+	const BIT_CUR_MAP_USED_ELEVATOR ; 7
+
 ; wOptions
 DEF TEXT_DELAY_MASK EQU %111
 	const_def 6

engine/events/card_key.asm

@@ -58,7 +58,7 @@ PrintCardKeyText:
 	ld [wNewTileBlockID], a
 	predef ReplaceTileBlock
 	ld hl, wCurrentMapScriptFlags
-	set 5, [hl]
+	set BIT_CUR_MAP_LOADED_1, [hl]
 	ld a, SFX_GO_INSIDE
 	jp PlaySound
 .noCardKey

engine/events/elevator.asm

@@ -20,7 +20,7 @@ DisplayElevatorFloorMenu:
 	ld [wListScrollOffset], a
 	ret c
 	ld hl, wCurrentMapScriptFlags
-	set 7, [hl]
+	set BIT_CUR_MAP_USED_ELEVATOR, [hl]
 	ld hl, wElevatorWarpMaps
 	ld a, [wWhichPokemon]
 	add a

engine/events/hidden_objects/cinnabar_gym_quiz.asm

@@ -88,7 +88,7 @@ CinnabarGymQuiz_AskQuestion:
 	cp c
 	jr nz, .wrongAnswer
 	ld hl, wCurrentMapScriptFlags
-	set 5, [hl]
+	set BIT_CUR_MAP_LOADED_1, [hl]
 	ldh a, [hGymGateIndex]
 	ldh [hBackupGymGateIndex], a
 	ld hl, CinnabarGymQuizCorrectText

engine/events/hidden_objects/vermilion_gym_trash.asm

@@ -97,7 +97,7 @@ GymTrashScript:
 ; Completed the trash can puzzle.
 	SetEvent EVENT_2ND_LOCK_OPENED
 	ld hl, wCurrentMapScriptFlags
-	set 6, [hl]
+	set BIT_CUR_MAP_LOADED_2, [hl]
 
 	tx_pre_id VermilionGymTrashSuccessText3
 

engine/menus/main_menu.asm

@@ -91,7 +91,7 @@ MainMenu:
 .choseContinue
 	call DisplayContinueGameInfo
 	ld hl, wCurrentMapScriptFlags
-	set 5, [hl]
+	set BIT_CUR_MAP_LOADED_1, [hl]
 .inputLoop
 	xor a
 	ldh [hJoyPressed], a

home/overworld.asm

@@ -33,8 +33,8 @@ EnterMap::
 	res BIT_NO_NPC_FACE_PLAYER, [hl]
 	call UpdateSprites
 	ld hl, wCurrentMapScriptFlags
-	set 5, [hl]
-	set 6, [hl]
+	set BIT_CUR_MAP_LOADED_1, [hl]
+	set BIT_CUR_MAP_LOADED_2, [hl]
 	xor a
 	ld [wJoyIgnore], a
 
@@ -340,8 +340,8 @@ OverworldLoopLessDelay::
 	ld hl, wStatusFlags7
 	res BIT_TRAINER_BATTLE, [hl]
 	ld hl, wCurrentMapScriptFlags
-	set 5, [hl]
-	set 6, [hl]
+	set BIT_CUR_MAP_LOADED_1, [hl]
+	set BIT_CUR_MAP_LOADED_2, [hl]
 	xor a
 	ldh [hJoyHeld], a
 	ld a, [wCurMap]

home/trainers.asm

@@ -184,8 +184,8 @@ StartTrainerBattle::
 
 EndTrainerBattle::
 	ld hl, wCurrentMapScriptFlags
-	set 5, [hl]
-	set 6, [hl]
+	set BIT_CUR_MAP_LOADED_1, [hl]
+	set BIT_CUR_MAP_LOADED_2, [hl]
 	ld hl, wStatusFlags3
 	res BIT_PRINT_END_BATTLE_TEXT, [hl]
 	ld hl, wMiscFlags

ram/wram.asm

@@ -1599,7 +1599,10 @@ wIsKeyItem:: db
 
 wTextBoxID:: db
 
-wCurrentMapScriptFlags:: db ; not exactly sure what this is used for, but it seems to be used as a multipurpose temp flag value
+; bit 5: set when maps first load; can be reset to re-run a script
+; bit 6: set when maps first load; can be reset to re-run a script (used less often than bit 5)
+; bit 7: set when using an elevator map's menu; triggers the shaking animation
+wCurrentMapScriptFlags:: db
 
 wCurEnemyLevel:: db
 

scripts/AgathasRoom.asm

@@ -11,8 +11,8 @@ AgathasRoom_Script:
 AgathaShowOrHideExitBlock:
 ; Blocks or clears the exit to the next room.
 	ld hl, wCurrentMapScriptFlags
-	bit 5, [hl]
-	res 5, [hl]
+	bit BIT_CUR_MAP_LOADED_1, [hl]
+	res BIT_CUR_MAP_LOADED_1, [hl]
 	ret z
 	;CheckEvent EVENT_BEAT_AGATHAS_ROOM_TRAINER_0 ; marcelnote - Agatha rematch
 	CheckEitherEventSet EVENT_BEAT_AGATHAS_ROOM_TRAINER_0, EVENT_BEAT_AGATHAS_ROOM_TRAINER_1