Merge pull request #278 from GriffinRichards/doc-miscscript

Split/label some common event scripts

1 files changed, 40 insertions, 328 deletions

diff --git a/data/event_scripts.s b/data/event_scripts.s
index 4e22ed6ca..dae7ba832 100644
--- a/data/event_scripts.s
+++ b/data/event_scripts.s
@@ -813,33 +813,20 @@ Text_WouldYouLikeToMixRecords:: @ 81A5028
 Text_WeHopeToSeeYouAgain2:: @ 81A505B
 	.string "We hope to see you again!$"
 
-Text_BootedUpPC:: @ 81A5075
-	.string "{PLAYER} booted up the PC.$"
-
-Text_AccessWhichPC:: @ 81A508A
-	.string "Which PC should be accessed?$"
-
-Text_AccessedSomeonesPC:: @ 81A50A7
-	.string "Accessed Someone's PC.$"
-
-Text_OpenedPkmnStorage:: @ 81A50BE
-	.string "POKéMON Storage System opened.$"
+	.include "data/text/pc.inc"
 
-Text_AccessedPlayersPC:: @ 81A50DD
-	.string "Accessed {PLAYER}'s PC.$"
-
-Text_AccessedBillsPC:: @ 81A50EF
-	.string "Accessed BILL's PC.$"
-
-Text_1A5103:: @ 81A5103
+@ Unused
+Text_WelcomeTradeCenter:: @ 81A5103
 	.string "Welcome to the POKéMON CABLE CLUB\n"
 	.string "TRADE CENTER.$"
 
-Text_1A5133:: @ 81A5133
+@ Unused
+Text_WelcomeColosseum:: @ 81A5133
 	.string "Welcome to the POKéMON CABLE CLUB\n"
 	.string "COLOSSEUM.$"
 
-Text_1A5160:: @ 81A5160
+@ Unused
+Text_WelcomeTimeCapsule:: @ 81A5160
 	.string "Welcome to the POKéMON CABLE CLUB\n"
 	.string "TIME CAPSULE.$"
 
@@ -858,7 +845,7 @@ Text_PlayerWhatCanIDoForYou:: @ 81A51D0
 
 	.include "data/text/obtain_item.inc"
 
-Text_1A5351:: @ 81A5351
+Text_MakingPreparations:: @ 81A5351
 	.string "じゅんびちゅうです！$"
 
 Text_WantWhichFloor:: @ 81A535C
@@ -868,7 +855,8 @@ Text_BagItemCanBeRegistered:: @ 81A5375
 	.string "An item in the BAG can be\n"
 	.string "registered to SELECT for easy use.$"
 
-Text_1A53B2:: @ 81A53B2
+@ Unused (email from R/S Rivals computer)
+Text_TrainerSchoolEmail:: @ 81A53B2
 	.string "パソコンに\n"
 	.string "ポケモン　トレーナー　こうざの\l"
 	.string "メールが　きている！\p"
@@ -881,7 +869,8 @@ Text_1A53B2:: @ 81A53B2
 Text_PlayerBootedUpPC:: @ 81A5420
 	.string "{PLAYER} booted up the PC.$"
 
-Text_1A5435:: @ 81A5435
+@ Unused
+Text_LinkWasCanceled:: @ 81A5435
 	.string "つうしんは　キャンセルされました$"
 
 @ Unused
@@ -931,7 +920,7 @@ Text_AppearsToBeUndergoingAdjustments:: @ 81A5667
 	.string "It appears to be undergoing\n"
 	.string "adjustments…$"
 
-Text_1A5690:: @ 81A5690
+Text_HandedOverItem:: @ 81A5690
 	.string "{PLAYER} handed over the\n"
 	.string "{STR_VAR_1}.$"
 
@@ -939,16 +928,7 @@ Text_GiveNicknameToThisMon:: @ 81A56A7
 	.string "Do you want to give a nickname to\n"
 	.string "this {STR_VAR_1}?$"
 
-Text_1A56D2:: @ 81A56D2
-	.string "おッ！　ダウジングマシンが\n"
-	.string "はんのう　してるぞ！\p"
-	.string "ましたに　どうぐが　うまってる！\n"
-	.string "‥‥‥$"
-
-Text_DugUpItemFromGround:: @ 81A5700
-	.string "{PLAYER} dug up one {STR_VAR_2}\n"
-	.string "from deep in the ground.$"
-
+	.include "data/text/itemfinder.inc"
 	.include "data/text/route23.inc"
 	.include "data/text/aide.inc"
 	.include "data/text/ingame_trade.inc"
@@ -995,74 +975,20 @@ Text_1A5CC3:: @ 81A5CC3
 Text_1A5CCE:: @ 81A5CCE
 	.string "そっか‥$"
 
-Text_1A5CD3:: @ 81A5CD3
+Text_TheDoorIsClosed:: @ 81A5CD3
 	.string "ドアは　しまっている‥$"
 
 Text_TheDoorIsOpen:: @ 81A5CDF
 	.string "The door is open…$"
 
 	.include "data/text/pc_transfer.inc"
-
-Text_1A5E89:: @ 81A5E89
-	.string "First, you should restore your\n"
-	.string "POKéMON to full health.$"
-
-Text_1A5EC0:: @ 81A5EC0
-	.string "Your POKéMON have been healed\n"
-	.string "to perfect health.\p"
-	.string "If your POKéMON's energy, HP,\n"
-	.string "is down, please come see us.\p"
-	.string "If you're planning to go far in the\n"
-	.string "field, you should buy some POTIONS\l"
-	.string "at the POKéMON MART.\p"
-	.string "We hope you excel!$"
-
-Text_1A5F9B:: @ 81A5F9B
-	.string "Your POKéMON have been healed\n"
-	.string "to perfect health.\p"
-	.string "We hope you excel!$"
-
-Text_1A5FDF:: @ 81A5FDF
-	.string "MOM: {PLAYER}!\n"
-	.string "Welcome home.\p"
-	.string "It sounds like you had quite\n"
-	.string "an experience.\p"
-	.string "Maybe you should take a quick\n"
-	.string "rest.$"
-
-Text_1A6046:: @ 81A6046
-	.string "MOM: Oh, good! You and your\n"
-	.string "POKéMON are looking great.\p"
-	.string "I just heard from PROF. OAK.\p"
-	.string "He said that POKéMON's energy is\n"
-	.string "measured in HP.\p"
-	.string "If your POKéMON lose their HP,\n"
-	.string "you can restore them at any\l"
-	.string "POKéMON CENTER.\p"
-	.string "If you're going to travel far away,\n"
-	.string "the smart TRAINER stocks up on\l"
-	.string "POTIONS at the POKéMON MART.\p"
-	.string "Make me proud, honey!\p"
-	.string "Take care!$"
-
-Text_1A6197:: @ 81A6197
-	.string "{PLAYER} is out of usable\n"
-	.string "POKéMON!\p"
-	.string "{PLAYER} panicked and lost ¥{STR_VAR_1}…\p"
-	.string "… … … …\p"
-	.string "{PLAYER} whited out!$"
-
-Text_1A61E5:: @ 81A61E5
-	.string "{PLAYER} is out of usable\n"
-	.string "POKéMON!\p"
-	.string "{PLAYER} whited out!$"
-
+	.include "data/text/white_out.inc"
 	.include "data/text/poke_mart.inc"
 
 Text_MonFlewAway:: @ 81A63C4
 	.string "The {STR_VAR_1} flew away!$"
 
-Text_1A63D6:: @ 81A63D6
+Text_TheresBedLetsRest:: @ 81A63D6
 	.string "ベッドが　ある‥‥\n"
 	.string "やすんでいこう$"
 
@@ -1133,45 +1059,7 @@ EventScript_ResetAllMapFlags:: @ 81A6481
 	setvar VAR_MASSAGE_COOLDOWN_STEP_COUNTER, 500
 	end
 
-EventScript_1A651A:: @ 81A651A
-	clearflag FLAG_HIDE_POSTGAME_GOSSIPERS
-	call EventScript_ResetEliteFour
-	special Special_UpdateTrainerFanClubGameClear
-	specialvar VAR_RESULT, IsNationalPokedexEnabled
-	compare VAR_RESULT, FALSE
-	call_if_eq EventScript_1A653B
-	call EventScript_ResetLegendaries
-	return
-
-EventScript_1A653B:: @ 81A653B
-	setvar VAR_MAP_SCENE_PALLET_TOWN_OAK, 2
-	return
-
-EventScript_ResetLegendaries:: @ 81A6541
-	clearflag FLAG_LUGIA_FLEW_AWAY
-	clearflag FLAG_HO_OH_FLEW_AWAY
-	clearflag FLAG_DEOXYS_FLEW_AWAY
-	return
-
-gUnknown_81A654B:: @ 81A654B
-	call EventScript_ResetEliteFour
-	end
-
-EventScript_ResetEliteFour:: @ 81A6551
-	clearflag FLAG_DEFEATED_LORELEI
-	clearflag FLAG_DEFEATED_BRUNO
-	clearflag FLAG_DEFEATED_AGATHA
-	clearflag FLAG_DEFEATED_LANCE
-	clearflag FLAG_DEFEATED_CHAMP
-	cleartrainerflag TRAINER_CHAMPION_FIRST_SQUIRTLE
-	cleartrainerflag TRAINER_CHAMPION_FIRST_BULBASAUR
-	cleartrainerflag TRAINER_CHAMPION_FIRST_CHARMANDER
-	cleartrainerflag TRAINER_CHAMPION_REMATCH_SQUIRTLE
-	cleartrainerflag TRAINER_CHAMPION_REMATCH_BULBASAUR
-	cleartrainerflag TRAINER_CHAMPION_REMATCH_CHARMANDER
-	setvar VAR_MAP_SCENE_POKEMON_LEAGUE, 0
-	return
-
+	.include "data/scripts/hall_of_fame.inc"
 	.include "data/scripts/pkmn_center_nurse.inc"
 	.include "data/scripts/obtain_item.inc"
 	.include "data/scripts/pc.inc"
@@ -1212,42 +1100,7 @@ EventScript_WallTownMap:: @ 81A6C32
 
 	.include "data/text/pokedex_rating.inc"
 	.include "data/scripts/pokedex_rating.inc"
-
-EventScript_1A7493:: @ 81A7493
-	lockall
-	setvar VAR_TEMP_1, 1
-	goto EventScript_1A74B7
-	end
-
-EventScript_1A749F:: @ 81A749F
-	lockall
-	setvar VAR_TEMP_2, 1
-	goto EventScript_1A74B7
-	end
-
-EventScript_1A74AB:: @ 81A74AB
-	lockall
-	setvar VAR_TEMP_3, 1
-	goto EventScript_1A74B7
-	end
-
-EventScript_1A74B7:: @ 81A74B7
-	setvar VAR_0x8004, 1
-	setvar VAR_0x8005, 1
-	setvar VAR_0x8006, 8
-	setvar VAR_0x8007, 5
-	special Special_ShakeScreen
-	waitstate
-	releaseall
-	end
-
-EventScript_1A74D1:: @ 81A74D1
-	setvar VAR_TEMP_1, 1
-	setvar VAR_TEMP_2, 1
-	setvar VAR_TEMP_3, 1
-	setvar VAR_TEMP_4, 1
-	setvar VAR_TEMP_5, 1
-	return
+	.include "data/scripts/cave_of_origin.inc"
 
 EventScript_ChangePokemonNickname:: @ 81A74EB
 	fadescreen FADE_TO_BLACK
@@ -1255,10 +1108,11 @@ EventScript_ChangePokemonNickname:: @ 81A74EB
 	waitstate
 	return
 
-EventScript_1A74F2:: @ 81A74F2
+@ Unused
+EventScript_HandOverItem:: @ 81A74F2
 	getitemname 0, VAR_0x8004
 	playfanfare MUS_ME_WAZA
-	message Text_1A5690
+	message Text_HandedOverItem
 	waitmessage
 	waitfanfare
 	removeitem VAR_0x8004, 1
@@ -1267,55 +1121,7 @@ EventScript_1A74F2:: @ 81A74F2
 	.include "data/scripts/pokemon_league.inc"
 	.include "data/scripts/movement.inc"	
 	.include "data/scripts/flavor_text.inc"
-
-gUnknown_81A7702:: @ 81A7702
-	lockall
-	textcolor 3
-	msgbox Text_FillOutQuestionnaire, MSGBOX_YESNO
-	compare VAR_RESULT, NO
-	goto_if_eq EventScript_1A778A
-	setvar VAR_0x8004, EASY_CHAT_TYPE_QUESTIONNAIRE
-	call Common_ShowEasyChatScreen
-	lock
-	faceplayer
-	specialvar VAR_0x8008, Special_GetMartClerkObjectId
-	textcolor 0
-	compare VAR_0x8004, 0
-	goto_if_eq EventScript_1A774D
-	compare VAR_RESULT, 0
-	goto_if_eq EventScript_1A778A
-	compare VAR_RESULT, 1
-	goto_if_eq EventScript_1A778C
-	end
-
-EventScript_1A774D:: @ 81A774D
-	applymovement VAR_0x8008, Movement_FaceDown
-	waitmovement 0
-	playse SE_PIN
-	applymovement VAR_0x8008, Movement_ExclamationMark
-	waitmovement 0
-	applymovement VAR_0x8008, Movement_Delay48
-	waitmovement 0
-	msgbox Text_YouKnowThoseWords
-	setflag FLAG_SYS_MYSTERY_GIFT_ENABLED
-	textcolor 3
-	special sub_80699BC
-	signmsg
-	msgbox Text_YouCanAccessMysteryGift
-	normalmsg
-	releaseall
-	end
-
-EventScript_1A778A:: @ 81A778A
-	releaseall
-	end
-
-EventScript_1A778C:: @ 81A778C
-	applymovement VAR_0x8008, Movement_FaceDown
-	waitmovement 0
-	msgbox Text_QuestionnaireThankYou
-	releaseall
-	end
+	.include "data/scripts/questionnaire.inc"
 
 EventScript_BagItemCanBeRegistered:: @ 81A77A0
 	msgbox Text_BagItemCanBeRegistered, MSGBOX_SIGN
@@ -1364,7 +1170,8 @@ EventScript_ReleaseEnd:: @ 81A7AE0
 
 	.include "data/scripts/pokemon_mansion.inc"
 
-EventScript_1A80FE:: @ 81A80FE
+@ Unused
+EventScript_DelayedLookAround:: @ 81A80FE
 	lockall
 	applymovement VAR_0x8004, Movement_WalkInPlaceFastestLeft
 	waitmovement 0
@@ -1451,137 +1258,42 @@ VermilionCity_PokemonCenter_1F_EventScript_ExplainVSSeeker:: @ 81A8D3F
 	release
 	end
 
-EventScript_ItemfinderDigUpUnderfootItem:: @ 81A8D49
-	lockall
-	textcolor 3
-	waitse
-	call EventScript_TryPickUpHiddenItem
-	compare VAR_0x8007, TRUE
-	goto_if_eq EventScript_DigUpItemPutInPocket
-	compare VAR_0x8007, FALSE
-	goto_if_eq EventScript_DigUpItemBagIsFull
-	end
-
-EventScript_DigUpItemPutInPocket::
-	message Text_DugUpItemFromGround
-	waitfanfare
-	waitmessage
-	delay 60
-	msgbox Text_PutItemAway
-	special Special_SetHiddenItemFlag
-	releaseall
-	end
-
-EventScript_DigUpItemBagIsFull::
-	msgbox Text_DugUpItemFromGround
-	msgbox Text_TooBadBagFull
-	setvar VAR_RESULT, 0
-	releaseall
-	end
-
-EventScript_AfterWhiteOutHeal:: @ 81A8D97
-	lockall
-	textcolor 1
-	msgbox Text_1A5E89
-	call EventScript_PkmnCenterNurse_TakeAndHealPkmn
-	call_if_unset FLAG_DEFEATED_BROCK, EventScript_1A8DC6
-	call_if_set FLAG_DEFEATED_BROCK, EventScript_1A8DCF
-	applymovement VAR_LAST_TALKED, Movement_Bow
-	waitmovement 0
-	fadedefaultbgm
-	releaseall
-	end
-
-EventScript_1A8DC6:: @ 81A8DC6
-	msgbox Text_1A5EC0
-	return
-
-EventScript_1A8DCF:: @ 81A8DCF
-	msgbox Text_1A5F9B
-	return
-
-EventScript_MomHeal:: @ 81A8DD8
-	lockall
-	textcolor 1
-	applymovement 1, Movement_WalkInPlaceFastestDown
-	waitmovement 0
-	msgbox Text_1A5FDF
-	call EventScript_OutOfCenterPartyHeal
-	msgbox Text_1A6046
-	fadedefaultbgm
-	releaseall
-	end
-
-EventScript_PoisonWhiteOut:: @ 81A8DFD
-	lockall
-	textcolor 3
-	special ExecuteWhiteOut
-	waitstate
-	compare VAR_RESULT, 1
-	goto_if_eq EventScript_1A8E11
-	releaseall
-	end
-
-EventScript_1A8E11:: @ 81A8E11
-	checkmoney 1, 0
-	compare VAR_RESULT, FALSE
-	goto_if_eq EventScript_1A8E2E
-	compare VAR_RESULT, TRUE
-	goto_if_eq EventScript_1A8E3C
-	end
-
-EventScript_1A8E2E:: @ 81A8E2E
-	msgbox Text_1A61E5
-	goto EventScript_1A8E4D
-	end
-
-EventScript_1A8E3C:: @ 81A8E3C
-	special Special_OverworldWhiteOutGetMoneyLoss
-	msgbox Text_1A6197
-	goto EventScript_1A8E4D
-	end
-
-EventScript_1A8E4D:: @ 81A8E4D
-	special sub_807F0B0
-	waitstate
-	fadescreen FADE_TO_BLACK
-	special sp0C8_whiteout_maybe
-	waitstate
-	end
+	.include "data/scripts/itemfinder.inc"
+	.include "data/scripts/white_out.inc"
 
 Std_PutItemAway:: @ 81A8E58
 	bufferitemnameplural 1, VAR_0x8000, VAR_0x8001
 	checkitemtype VAR_0x8000
-	call EventScript_1A8E6F
+	call EventScript_BufferPutAwayPocketName
 	msgbox Text_PutItemAway
 	return
 
-EventScript_1A8E6F:: @ 81A8E6F
+EventScript_BufferPutAwayPocketName:: @ 81A8E6F
 	switch VAR_RESULT
-	case POCKET_ITEMS, EventScript_1A8EAC
-	case POCKET_KEY_ITEMS, EventScript_1A8EB1
-	case POCKET_POKE_BALLS, EventScript_1A8EB6
-	case POCKET_TM_CASE, EventScript_1A8EBB
-	case POCKET_BERRY_POUCH, EventScript_1A8EC0
+	case POCKET_ITEMS,       EventScript_BufferPutAwayPocketItems
+	case POCKET_KEY_ITEMS,   EventScript_BufferPutAwayPocketKeyItems
+	case POCKET_POKE_BALLS,  EventScript_BufferPutAwayPocketPokeBalls
+	case POCKET_TM_CASE,     EventScript_BufferPutAwayPocketTMCase
+	case POCKET_BERRY_POUCH, EventScript_BufferPutAwayPocketBerryPouch
 	end
 
-EventScript_1A8EAC:: @ 81A8EAC
+EventScript_BufferPutAwayPocketItems:: @ 81A8EAC
 	getstdstring 2, STDSTRING_ITEMS_POCKET
 	return
 
-EventScript_1A8EB1:: @ 81A8EB1
+EventScript_BufferPutAwayPocketKeyItems:: @ 81A8EB1
 	getstdstring 2, STDSTRING_KEY_ITEMS_POCKET
 	return
 
-EventScript_1A8EB6:: @ 81A8EB6
+EventScript_BufferPutAwayPocketPokeBalls:: @ 81A8EB6
 	getstdstring 2, STDSTRING_POKEBALLS_POCKET
 	return
 
-EventScript_1A8EBB:: @ 81A8EBB
+EventScript_BufferPutAwayPocketTMCase:: @ 81A8EBB
 	getstdstring 2, STDSTRING_TM_CASE
 	return
 
-EventScript_1A8EC0:: @ 81A8EC0
+EventScript_BufferPutAwayPocketBerryPouch:: @ 81A8EC0
 	getstdstring 2, STDSTRING_BERRY_POUCH
 	return
 
@@ -1613,7 +1325,7 @@ EventScript_NoMoreRoomForPokemon:: @ 81A927C
 
 @ Test message!
 @ Welcome to the world of Pokémon!
-Text_1ACD45:: @ 81ACD45
+Text_TestMsg:: @ 81ACD45
 	.string "テストよう　メッセージです！\n"
 	.string "ポケモンの　せかいへ　ようこそ！$"