More engine flag constants

2025-09-08 08:13:02 -07:00 · 2018-01-22 14:34:55 -05:00
parent 125d51b3b2
commit 4d8528f903
27 changed files with 75 additions and 54 deletions
--- a/constants/engine_flags.asm
+++ b/constants/engine_flags.asm
@@ -120,7 +120,7 @@
 ; wPlayerGender
 	const ENGINE_PLAYER_IS_FEMALE
 ; wCelebiEvent
-	const ENGINE_HAVE_EXAMINED_GS_BALL
+	const ENGINE_FOREST_IS_RESTLESS
 ; wDailyRematchFlags
 	const ENGINE_JACK
 	const ENGINE_HUEY
--- a/constants/wram_constants.asm
+++ b/constants/wram_constants.asm
@@ -105,6 +105,16 @@ DARKNESS EQU 1 << DARKNESS_F

 ANYTIME EQU MORN | DAY | NITE

+; wPlayerSpriteSetupFlags:: ; d45b
+PLAYERSPRITESETUP_FACING_MASK       EQU %11
+PLAYERSPRITESETUP_FEMALE_TO_MALE_F  EQU 2
+PLAYERSPRITESETUP_CUSTOM_FACING_F   EQU 5
+PLAYERSPRITESETUP_SKIP_RELOAD_GFX_F EQU 6
+PLAYERSPRITESETUP_RESET_ACTION_F    EQU 7
+
+; wPlayerGender:: ; d472
+PLAYERGENDER_FEMALE_F EQU 0
+
 ; ScriptFlags:: ; d434
 SCRIPT_RUNNING EQU 2

@@ -185,12 +195,18 @@ PLAYER_SKATE     EQU 2
 PLAYER_SURF      EQU 4
 PLAYER_SURF_PIKA EQU 8

+; wCelebiEvent:: ; dbf3
+CELEBIEVENT_FOREST_IS_RESTLESS_F EQU 2
+
 ; wBikeFlags:: ; dbf5
 	const_def
 	const BIKEFLAGS_STRENGTH_ACTIVE_F ; 0
 	const BIKEFLAGS_ALWAYS_ON_BIKE_F  ; 1
 	const BIKEFLAGS_DOWNHILL_F        ; 2

+; wLuckyNumberShowFlag:: ; dc9d
+LUCKYNUMBERSHOW_GAME_OVER_F EQU 0
+
 ; wDayCareMan:: ; def5
 DAYCAREMAN_HAS_MON_F         EQU 0
 DAYCAREMAN_MONS_COMPATIBLE_F EQU 5
--- a/data/engine_flags.asm
+++ b/data/engine_flags.asm
@@ -99,7 +99,7 @@ EngineFlags: ; 80462
 	engine_flag wVisitedSpawns, SPAWN_MT_SILVER
 	engine_flag wVisitedSpawns, NUM_SPAWNS ; unused

-	engine_flag wLuckyNumberShowFlag, 0 ; lucky number show
+	engine_flag wLuckyNumberShowFlag, LUCKYNUMBERSHOW_GAME_OVER_F
 	engine_flag wStatusFlags2, 3 ; ????

 	engine_flag wDailyFlags, 0 ; kurt making balls ; $50
@@ -125,9 +125,9 @@ EngineFlags: ; 80462

 	engine_flag wGameTimerPause, 7 ; $62

-	engine_flag wPlayerGender, 0 ; player is female
+	engine_flag wPlayerGender, PLAYERGENDER_FEMALE_F

-	engine_flag wCelebiEvent, 2 ; have gs ball after kurt examined it
+	engine_flag wCelebiEvent, CELEBIEVENT_FOREST_IS_RESTLESS_F

 	; rematches
 	engine_flag wDailyRematchFlags,  0 ; jack
@@ -191,7 +191,7 @@ EngineFlags: ; 80462
 	engine_flag wDailyPhoneTimeOfDayFlags, 22 ; parry
 	engine_flag wDailyPhoneTimeOfDayFlags, 23 ; erin

-	engine_flag wPlayerSpriteSetupFlags, 2 ; female player has been transformed into male
+	engine_flag wPlayerSpriteSetupFlags, PLAYERSPRITESETUP_FEMALE_TO_MALE_F

 	engine_flag wSwarmFlags, 2 ; dunsparce swarm ; $a0
 	engine_flag wSwarmFlags, 3 ; yanma swarm
--- a/engine/battle/core.asm
+++ b/engine/battle/core.asm
@@ -9263,10 +9263,10 @@ GetTrainerBackpic: ; 3fbff

 ; What gender are we?
 	ld a, [wPlayerSpriteSetupFlags]
-	bit 2, a ; transformed to male
+	bit PLAYERSPRITESETUP_FEMALE_TO_MALE_F, a
 	jr nz, .Chris
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .Chris

 ; It's a girl.
--- a/engine/caught_data.asm
+++ b/engine/caught_data.asm
@@ -194,7 +194,7 @@ SetBoxmonOrEggmonCaughtData: ; 4db53
 	call GetWorldMapLocation
 	ld b, a
 	ld a, [wPlayerGender]
-	rrca
+	rrca ; shift bit 0 (PLAYERGENDER_FEMALE_F) to bit 7 (CAUGHT_GENDER_MASK)
 	or b
 	ld [hl], a
 	ret
--- a/engine/cgb_layouts.asm
+++ b/engine/cgb_layouts.asm
@@ -184,7 +184,7 @@ InitPartyMenuBGPal0: ; 8e9f

 _CGB_PokegearPals: ; 8eb9
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .male
 	ld hl, FemalePokegearPals
 	jr .got_pals
@@ -821,7 +821,7 @@ _CGB_PackPals: ; 93d3
 	jr z, .tutorial_male

 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .tutorial_male

 	ld hl, .KrisPackPals
--- a/engine/color.asm
+++ b/engine/color.asm
@@ -707,7 +707,7 @@ GetPlayerOrMonPalettePointer:
 	and a
 	jp nz, GetMonNormalOrShinyPalettePointer
 	ld a, [wPlayerSpriteSetupFlags]
-	bit 2, a ; transformed to male
+	bit PLAYERSPRITESETUP_FEMALE_TO_MALE_F, a
 	jr nz, .male
 	ld a, [wPlayerGender]
 	and a
--- a/engine/events/loadfishinggfx.asm
+++ b/engine/events/loadfishinggfx.asm
@@ -6,7 +6,7 @@ LoadFishingGFX: ; b84b3

 	ld de, FishingGFX
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .got_gender
 	ld de, KrisFishingGFX
 .got_gender
--- a/engine/events/magnet_train.asm
+++ b/engine/events/magnet_train.asm
@@ -327,7 +327,7 @@ MagnetTrain_Jumptable: ; 8cdf7
 	ld a, BANK(wPlayerGender)
 	ld [rSVBK], a
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .got_gender
 	ld b, SPRITE_ANIM_INDEX_MAGNET_TRAIN_BLUE

--- a/engine/intro_menu.asm
+++ b/engine/intro_menu.asm
@@ -812,7 +812,7 @@ NamePlayer: ; 0x6074
 	ld hl, PlayerName
 	ld de, .Chris
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .Male
 	ld de, .Kris
 .Male:
@@ -988,7 +988,7 @@ Intro_PlacePlayerSprite: ; 61cd

 	ld b, PAL_OW_RED
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .male
 	ld b, PAL_OW_BLUE
 .male
--- a/engine/map_objects.asm
+++ b/engine/map_objects.asm
@@ -2543,7 +2543,7 @@ RefreshPlayerSprite: ; 579d

 .TryResetPlayerAction: ; 57bc
 	ld hl, wPlayerSpriteSetupFlags
-	bit 7, [hl]
+	bit PLAYERSPRITESETUP_RESET_ACTION_F, [hl]
 	jr nz, .ok
 	ret

@@ -2555,10 +2555,10 @@ RefreshPlayerSprite: ; 579d

 .SpawnInCustomFacing: ; 57ca
 	ld hl, wPlayerSpriteSetupFlags
-	bit 5, [hl]
+	bit PLAYERSPRITESETUP_CUSTOM_FACING_F, [hl]
 	ret z
 	ld a, [wPlayerSpriteSetupFlags]
-	and 3
+	and PLAYERSPRITESETUP_FACING_MASK
 	add a
 	add a
 	jr ContinueSpawnFacing
--- a/engine/map_setup.asm
+++ b/engine/map_setup.asm
@@ -143,13 +143,13 @@ LoadObjectsRunCallback_02: ; 154d7

 DelayClearingOldSprites: ; 154eb
 	ld hl, wPlayerSpriteSetupFlags
-	set 7, [hl]
+	set PLAYERSPRITESETUP_RESET_ACTION_F, [hl]
 	ret
 ; 154f1

 DelayLoadingNewSprites: ; 154f1
 	ld hl, wPlayerSpriteSetupFlags
-	set 6, [hl]
+	set PLAYERSPRITESETUP_SKIP_RELOAD_GFX_F, [hl]
 	ret

 CheckReplaceKrisSprite: ; 154f7
--- a/engine/overworld.asm
+++ b/engine/overworld.asm
@@ -62,10 +62,10 @@ GetPlayerSprite: ; 14183
 ; Get Chris or Kris's sprite.
 	ld hl, .Chris
 	ld a, [wPlayerSpriteSetupFlags]
-	bit 2, a
+	bit PLAYERSPRITESETUP_FEMALE_TO_MALE_F, a
 	jr nz, .go
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .go
 	ld hl, .Kris

--- a/engine/pack.asm
+++ b/engine/pack.asm
@@ -1288,7 +1288,7 @@ DrawPackGFX: ; 1089d
 	cp BATTLETYPE_TUTORIAL
 	jr z, .male_dude
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr nz, .female
 .male_dude
 	ld hl, PackGFXPointers
--- a/engine/player_gfx.asm
+++ b/engine/player_gfx.asm
@@ -1,7 +1,7 @@
 Unreferenced_Function88248: ; 88248
 	ld c, CAL
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .okay
 	ld c, KAREN

@@ -58,7 +58,7 @@ MovePlayerPic: ; 88266
 ShowPlayerNamingChoices: ; 88297
 	ld hl, ChrisNameMenuDataHeader
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .GotGender
 	ld hl, KrisNameMenuDataHeader
 .GotGender:
@@ -76,7 +76,7 @@ GetPlayerNameArray: ; 88318 This Function is never called
 	ld hl, PlayerName
 	ld de, MalePlayerNameArray
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .done
 	ld de, FemalePlayerNameArray

@@ -92,7 +92,7 @@ GetPlayerIcon: ; 8832c
 	ld b, BANK(ChrisSpriteGFX)

 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .done

 ; Female
@@ -105,7 +105,7 @@ GetPlayerIcon: ; 8832c
 GetCardPic: ; 8833e
 	ld hl, ChrisCardPic
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .GotClass
 	ld hl, KrisCardPic
 .GotClass:
@@ -131,7 +131,7 @@ INCBIN "gfx/trainer_card/trainer_card.2bpp"

 GetPlayerBackpic: ; 88825
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, GetChrisBackpic
 	call GetKrisBackpic
 	ret
@@ -150,7 +150,7 @@ HOF_LoadTrainerFrontpic: ; 88840
 	ld [hBGMapMode], a
 	ld e, 0
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .GotClass
 	ld e, 1

@@ -159,7 +159,7 @@ HOF_LoadTrainerFrontpic: ; 88840
 	ld [TrainerClass], a
 	ld de, ChrisPic
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .GotPic
 	ld de, KrisPic

@@ -179,7 +179,7 @@ DrawIntroPlayerPic: ; 88874
 ; Get class
 	ld e, CHRIS
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .GotClass
 	ld e, KRIS
 .GotClass:
@@ -189,7 +189,7 @@ DrawIntroPlayerPic: ; 88874
 ; Load pic
 	ld de, ChrisPic
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .GotPic
 	ld de, KrisPic
 .GotPic:
--- a/engine/player_object.asm
+++ b/engine/player_object.asm
@@ -31,10 +31,10 @@ SpawnPlayer: ; 8029
 	add hl, bc
 	ln e, PAL_NPC_RED, OBJECTTYPE_SCRIPT
 	ld a, [wPlayerSpriteSetupFlags]
-	bit 2, a
+	bit PLAYERSPRITESETUP_FEMALE_TO_MALE_F, a
 	jr nz, .ok
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .ok
 	ln e, PAL_NPC_BLUE, OBJECTTYPE_SCRIPT

--- a/engine/pokegear.asm
+++ b/engine/pokegear.asm
@@ -687,7 +687,7 @@ PokegearMap_InitPlayerIcon: ; 9106a
 	depixel 0, 0
 	ld b, SPRITE_ANIM_INDEX_RED_WALK
 	ld a, [wPlayerGender]
-	bit 0, a ; ENGINE_PLAYER_IS_FEMALE
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .got_gender
 	ld b, SPRITE_ANIM_INDEX_BLUE_WALK
 .got_gender
@@ -2690,7 +2690,7 @@ Pokedex_GetArea: ; 91d11
 	push bc
 	ld c, PAL_OW_RED
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .male
 	inc c ; PAL_OW_BLUE
 .male
@@ -2917,7 +2917,7 @@ TownMapPlayerIcon: ; 91fa6
 	depixel 0, 0
 	ld b, SPRITE_ANIM_INDEX_RED_WALK ; Male
 	ld a, [wPlayerGender]
-	bit 0, a
+	bit PLAYERGENDER_FEMALE_F, a
 	jr z, .got_gender
 	ld b, SPRITE_ANIM_INDEX_BLUE_WALK ; Female
 .got_gender
--- a/engine/scripting.asm
+++ b/engine/scripting.asm
@@ -2477,7 +2477,7 @@ Script_warpfacing:
 	maskbits NUM_DIRECTIONS
 	ld c, a
 	ld a, [wPlayerSpriteSetupFlags]
-	set 5, a
+	set PLAYERSPRITESETUP_CUSTOM_FACING_F, a
 	or c
 	ld [wPlayerSpriteSetupFlags], a
 ; fall through
--- a/engine/specials.asm
+++ b/engine/specials.asm
@@ -350,7 +350,7 @@ Special_CheckPokerus: ; c419
 Special_ResetLuckyNumberShowFlag: ; c422
 	farcall RestartLuckyNumberCountdown
 	ld hl, wLuckyNumberShowFlag
-	res 0, [hl]
+	res LUCKYNUMBERSHOW_GAME_OVER_F, [hl]
 	farcall LoadOrRegenerateLuckyIDNumber
 	ret
 ; c434
--- a/engine/tileset_anims.asm
+++ b/engine/tileset_anims.asm
@@ -502,7 +502,7 @@ ForestTreeLeftAnimation: ; fc45c

 ; Only during the Celebi event.
 	ld a, [wCelebiEvent]
-	bit 2, a
+	bit CELEBIEVENT_FOREST_IS_RESTLESS_F, a
 	jr nz, .asm_fc46c
 	ld hl, ForestTreeLeftFrames
 	jr .asm_fc47d
@@ -544,7 +544,7 @@ ForestTreeRightAnimation: ; fc4c4

 ; Only during the Celebi event.
 	ld a, [wCelebiEvent]
-	bit 2, a
+	bit CELEBIEVENT_FOREST_IS_RESTLESS_F, a
 	jr nz, .asm_fc4d4
 	ld hl, ForestTreeRightFrames
 	jr .asm_fc4eb
@@ -579,7 +579,7 @@ ForestTreeLeftAnimation2: ; fc4f2

 ; Only during the Celebi event.
 	ld a, [wCelebiEvent]
-	bit 2, a
+	bit CELEBIEVENT_FOREST_IS_RESTLESS_F, a
 	jr nz, .asm_fc502
 	ld hl, ForestTreeLeftFrames
 	jr .asm_fc515
@@ -611,7 +611,7 @@ ForestTreeRightAnimation2: ; fc51c

 ; Only during the Celebi event.
 	ld a, [wCelebiEvent]
-	bit 2, a
+	bit CELEBIEVENT_FOREST_IS_RESTLESS_F, a
 	jr nz, .asm_fc52c
 	ld hl, ForestTreeRightFrames
 	jr .asm_fc545
--- a/Show More
+++ b/Show More