Merge pull request #1520 from GriffinRichards/doc-random

Document random remaining symbols

4 files changed, 72 insertions, 71 deletions

diff --git a/data/maps/MauvilleCity_PokemonCenter_1F/scripts.inc b/data/maps/MauvilleCity_PokemonCenter_1F/scripts.inc
index 4347c4773..463d652b3 100644
--- a/data/maps/MauvilleCity_PokemonCenter_1F/scripts.inc
+++ b/data/maps/MauvilleCity_PokemonCenter_1F/scripts.inc
@@ -12,7 +12,7 @@ MauvilleCity_PokemonCenter_1F_OnTransition:
 	end
 
 MauvilleCity_PokemonCenter_1F_EventScript_SetMauvilleOldManGfx::
-	special ScrSpecial_SetMauvilleOldManObjEventGfx
+	special SetMauvilleOldManObjEventGfx
 	end
 
 MauvilleCity_PokemonCenter_1F_EventScript_Nurse::
diff --git a/data/scripts/mauville_man.inc b/data/scripts/mauville_man.inc
index a9c008e5e..b34f84e8e 100644
--- a/data/scripts/mauville_man.inc
+++ b/data/scripts/mauville_man.inc
@@ -1,5 +1,5 @@
 MauvilleCity_PokemonCenter_1F_EventScript_MauvilleOldMan::
-	special ScrSpecial_GetCurrentMauvilleMan
+	special Script_GetCurrentMauvilleMan
 	switch VAR_RESULT
 	case MAUVILLE_MAN_BARD, MauvilleCity_PokemonCenter_1F_EventScript_Bard
 	case MAUVILLE_MAN_HIPSTER, MauvilleCity_PokemonCenter_1F_EventScript_Hipster
@@ -21,9 +21,9 @@ MauvilleCity_PokemonCenter_1F_EventScript_Bard::
 
 MauvilleCity_PokemonCenter_1F_EventScript_PlaySong::
 	setvar VAR_0x8004, 0
-	special ScrSpecial_PlayBardSong
+	special PlayBardSong
 	delay 60
-	special ScrSpecial_HasBardSongBeenChanged
+	special HasBardSongBeenChanged
 	compare VAR_RESULT, FALSE
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_AskToWriteLyrics
 	msgbox MauvilleCity_PokemonCenter_1F_Text_WishICouldPlaySongForOthers, MSGBOX_DEFAULT
@@ -52,12 +52,12 @@ MauvilleCity_PokemonCenter_1F_EventScript_WriteLyrics::
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_DeclineWritingLyrics
 	msgbox MauvilleCity_PokemonCenter_1F_Text_LetMeSingItForYou, MSGBOX_DEFAULT
 	setvar VAR_0x8004, 1
-	special ScrSpecial_PlayBardSong
+	special PlayBardSong
 	delay 60
 	msgbox MauvilleCity_PokemonCenter_1F_Text_ThatHowYouWantedSongToGo, MSGBOX_YESNO
 	compare VAR_RESULT, NO
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_WriteLyrics
-	special ScrSpecial_SaveBardSongLyrics
+	special SaveBardSongLyrics
 	msgbox MauvilleCity_PokemonCenter_1F_Text_IllSingThisSongForAWhile, MSGBOX_DEFAULT
 	release
 	end
@@ -73,7 +73,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_Hipster::
 	faceplayer
 	setflag FLAG_SYS_HIPSTER_MEET
 	msgbox MauvilleCity_PokemonCenter_1F_Text_TeachWhatsHipAndHappening, MSGBOX_DEFAULT
-	special ScrSpecial_GetHipsterSpokenFlag
+	special GetHipsterSpokenFlag
 	compare VAR_RESULT, FALSE
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_TryTeachWord
 	msgbox MauvilleCity_PokemonCenter_1F_Text_IAlreadyTaughtYou, MSGBOX_DEFAULT
@@ -81,7 +81,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_Hipster::
 	end
 
 MauvilleCity_PokemonCenter_1F_EventScript_TryTeachWord::
-	special ScrSpecial_HipsterTeachWord
+	special HipsterTryTeachWord
 	compare VAR_RESULT, TRUE
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_TeachWord
 	msgbox MauvilleCity_PokemonCenter_1F_Text_IveGotNothingNewToTeach, MSGBOX_DEFAULT
@@ -90,7 +90,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_TryTeachWord::
 
 MauvilleCity_PokemonCenter_1F_EventScript_TeachWord::
 	msgbox MauvilleCity_PokemonCenter_1F_Text_HaveYouHeardOfPhrase, MSGBOX_DEFAULT
-	special ScrSpecial_SetHipsterSpokenFlag
+	special SetHipsterSpokenFlag
 	release
 	end
 
@@ -160,7 +160,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_Trader::
 	msgbox MauvilleCity_PokemonCenter_1F_Text_WantToTradeDecor, MSGBOX_YESNO
 	compare VAR_RESULT, NO
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_DeclineTrade
-	special ScrSpecial_GetTraderTradedFlag
+	special GetTraderTradedFlag
 	compare VAR_RESULT, TRUE
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_AlreadyTraded
 	message MauvilleCity_PokemonCenter_1F_Text_PickADecorItem
@@ -179,7 +179,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_AlreadyTraded::
 	end
 
 MauvilleCity_PokemonCenter_1F_EventScript_PickDecorToReceive::
-	special ScrSpecial_TraderMenuGetDecoration
+	special TraderMenuGetDecoration
 	waitstate
 	compare VAR_0x8004, 0
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_CancelPickDecor
@@ -188,7 +188,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_PickDecorToReceive::
 	msgbox MauvilleCity_PokemonCenter_1F_Text_OnceBelongedToPlayerDoYouWantIt, MSGBOX_YESNO
 	compare VAR_RESULT, NO
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_PickDifferentDecor
-	special ScrSpecial_DoesPlayerHaveNoDecorations
+	special DoesPlayerHaveNoDecorations
 	compare VAR_RESULT, TRUE
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_DontHaveAnyDecor
 	goto MauvilleCity_PokemonCenter_1F_EventScript_PickDecorToGive
@@ -218,19 +218,19 @@ MauvilleCity_PokemonCenter_1F_EventScript_DontHaveAnyDecor::
 
 MauvilleCity_PokemonCenter_1F_EventScript_PickDecorToGive::
 	msgbox MauvilleCity_PokemonCenter_1F_Text_PickTheDecorToTrade, MSGBOX_DEFAULT
-	special ScrSpecial_TraderMenuGiveDecoration
+	special TraderShowDecorationMenu
 	waitstate
 	compare VAR_0x8006, 0
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_CancelGiveDecor
 	compare VAR_0x8006, 0xFFFF
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_DecorInUse
-	special ScrSpecial_IsDecorationFull
+	special IsDecorationCategoryFull
 	compare VAR_RESULT, TRUE
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_NoRoomForDecor
 	msgbox MauvilleCity_PokemonCenter_1F_Text_SoWellTradeTheseDecor, MSGBOX_YESNO
 	compare VAR_RESULT, NO
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_PickDecorToGive
-	special ScrSpecial_TraderDoDecorationTrade
+	special TraderDoDecorationTrade
 	msgbox MauvilleCity_PokemonCenter_1F_Text_SendDecorToYourPC, MSGBOX_DEFAULT
 	release
 	end
@@ -818,20 +818,20 @@ MauvilleCity_PokemonCenter_1F_EventScript_Storyteller::
 	msgbox MauvilleCity_PokemonCenter_1F_Text_WillYouHearMyTale, MSGBOX_YESNO
 	compare VAR_RESULT, NO
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_DeclineStoryteller
-	specialvar VAR_RESULT, ScrSpecial_StorytellerGetFreeStorySlot
+	specialvar VAR_RESULT, StorytellerGetFreeStorySlot
 	compare VAR_RESULT, 0
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_KnowNoTales
 	message MauvilleCity_PokemonCenter_1F_Text_WhichTaleToTell
 	waitmessage
-	special ScrSpecial_StorytellerStoryListMenu
+	special StorytellerStoryListMenu
 	waitstate
 	compare VAR_RESULT, 0
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_CancelStorySelection
 	setvar VAR_0x8008, 1
-	special ScrSpecial_StorytellerDisplayStory
+	special Script_StorytellerDisplayStory
 	waitmessage
 	waitbuttonpress
-	specialvar VAR_RESULT, ScrSpecial_StorytellerUpdateStat
+	specialvar VAR_RESULT, StorytellerUpdateStat
 	compare VAR_RESULT, 0
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_AreThereOtherTales
 	goto MauvilleCity_PokemonCenter_1F_EventScript_TellPlayersTale
@@ -842,7 +842,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_CancelStorySelection::
 
 MauvilleCity_PokemonCenter_1F_EventScript_AreThereOtherTales::
 	msgbox MauvilleCity_PokemonCenter_1F_Text_CouldThereBeOtherLegends, MSGBOX_DEFAULT
-	specialvar VAR_RESULT, ScrSpecial_HasStorytellerAlreadyRecorded
+	specialvar VAR_RESULT, HasStorytellerAlreadyRecorded
 	compare VAR_RESULT, TRUE
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_StorytellerEnd
 	goto MauvilleCity_PokemonCenter_1F_EventScript_DoYouHaveAnyTales
@@ -853,7 +853,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_DoYouHaveAnyTales::
 	msgbox MauvilleCity_PokemonCenter_1F_Text_HaveYouAnyLegendaryTales, MSGBOX_YESNO
 	compare VAR_RESULT, NO
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_DeclineStoryteller
-	specialvar VAR_RESULT, ScrSpecial_StorytellerInitializeRandomStat
+	specialvar VAR_RESULT, Script_StorytellerInitializeRandomStat
 	compare VAR_RESULT, 1
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_TellPlayersTale
 	msgbox MauvilleCity_PokemonCenter_1F_Text_NotWorthyOfLegend, MSGBOX_DEFAULT
@@ -909,7 +909,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_Giddy::
 	end
 
 MauvilleCity_PokemonCenter_1F_EventScript_TryTellTale::
-	special ScrSpecial_GiddyShouldTellAnotherTale
+	special GiddyShouldTellAnotherTale
 	compare VAR_RESULT, TRUE
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_GiddyTellTale
 	compare VAR_RESULT, FALSE
@@ -917,7 +917,7 @@ MauvilleCity_PokemonCenter_1F_EventScript_TryTellTale::
 	end
 
 MauvilleCity_PokemonCenter_1F_EventScript_TryTellNewTale::
-	special ScrSpecial_GiddyShouldTellAnotherTale
+	special GiddyShouldTellAnotherTale
 	compare VAR_RESULT, TRUE
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_GiddyStartNewTale
 	compare VAR_RESULT, FALSE
@@ -929,15 +929,16 @@ MauvilleCity_PokemonCenter_1F_EventScript_GiddyStartNewTale::
 	goto MauvilleCity_PokemonCenter_1F_EventScript_GiddyTellTale
 	end
 
-@ Regardless of whether yes or no is selected below, Giddy will continue to tell stories until he's told 10
+@ Giddy will continue to tell stories regardless of whether yes or no is selected below.
+@ Each story there is a 10% chance it will be his last. Otherwise he will stop at 10 stories.
 MauvilleCity_PokemonCenter_1F_EventScript_GiddyTellTale::
-	special ScrSpecial_GenerateGiddyLine
+	special GenerateGiddyLine
 	special ShowFieldMessageStringVar4
 	waitmessage
 	yesnobox 20, 8
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, YES
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_TryTellNewTale
-	compare VAR_RESULT, 0
+	compare VAR_RESULT, NO
 	goto_if_eq MauvilleCity_PokemonCenter_1F_EventScript_TryTellNewTale
 	end
 
diff --git a/data/specials.inc b/data/specials.inc
index b8d7f232c..82eacbac0 100644
--- a/data/specials.inc
+++ b/data/specials.inc
@@ -108,28 +108,28 @@ gSpecials::
 	def_special DoWateringBerryTreeAnim
 	def_special ShowEasyChatScreen
 	def_special ShowEasyChatProfile
-	def_special ScrSpecial_GetCurrentMauvilleMan
-	def_special ScrSpecial_HasBardSongBeenChanged
-	def_special ScrSpecial_SaveBardSongLyrics
-	def_special ScrSpecial_GetHipsterSpokenFlag
-	def_special ScrSpecial_SetHipsterSpokenFlag
-	def_special ScrSpecial_HipsterTeachWord
-	def_special ScrSpecial_PlayBardSong
-	def_special ScrSpecial_SetMauvilleOldManObjEventGfx
-	def_special ScrSpecial_GenerateGiddyLine
-	def_special ScrSpecial_GiddyShouldTellAnotherTale
-	def_special ScrSpecial_StorytellerGetFreeStorySlot
-	def_special ScrSpecial_StorytellerDisplayStory
-	def_special ScrSpecial_StorytellerStoryListMenu
-	def_special ScrSpecial_StorytellerUpdateStat
-	def_special ScrSpecial_StorytellerInitializeRandomStat
-	def_special ScrSpecial_HasStorytellerAlreadyRecorded
-	def_special ScrSpecial_TraderMenuGetDecoration
-	def_special ScrSpecial_GetTraderTradedFlag
-	def_special ScrSpecial_DoesPlayerHaveNoDecorations
-	def_special ScrSpecial_IsDecorationFull
-	def_special ScrSpecial_TraderMenuGiveDecoration
-	def_special ScrSpecial_TraderDoDecorationTrade
+	def_special Script_GetCurrentMauvilleMan
+	def_special HasBardSongBeenChanged
+	def_special SaveBardSongLyrics
+	def_special GetHipsterSpokenFlag
+	def_special SetHipsterSpokenFlag
+	def_special HipsterTryTeachWord
+	def_special PlayBardSong
+	def_special SetMauvilleOldManObjEventGfx
+	def_special GenerateGiddyLine
+	def_special GiddyShouldTellAnotherTale
+	def_special StorytellerGetFreeStorySlot
+	def_special Script_StorytellerDisplayStory
+	def_special StorytellerStoryListMenu
+	def_special StorytellerUpdateStat
+	def_special Script_StorytellerInitializeRandomStat
+	def_special HasStorytellerAlreadyRecorded
+	def_special TraderMenuGetDecoration
+	def_special GetTraderTradedFlag
+	def_special DoesPlayerHaveNoDecorations
+	def_special IsDecorationCategoryFull
+	def_special TraderShowDecorationMenu
+	def_special TraderDoDecorationTrade
 	def_special GetSeedotSizeRecordInfo
 	def_special CompareSeedotSize
 	def_special GetLotadSizeRecordInfo
@@ -455,7 +455,7 @@ gSpecials::
 	def_special ClearLinkContestFlags
 	def_special TryContestEModeLinkup
 	def_special ShowScrollableMultichoice
-	def_special sub_813A630
+	def_special ScrollableMultichoice_TryReturnToList
 	def_special BufferBattleTowerElevatorFloors
 	def_special TryStoreHeldItemsInPyramidBag
 	def_special ChooseItemsToTossFromPyramidBag
@@ -484,10 +484,10 @@ gSpecials::
 	def_special CountPlayerTrainerStars
 	def_special BufferBattleFrontierTutorMoveName
 	def_special CloseBattleFrontierTutorWindow
-	def_special sub_813ADD4
+	def_special ScrollableMultichoice_RedrawPersistentMenu
 	def_special ChooseMonForMoveTutor
 	def_special GetBattleFrontierTutorMoveIndex
-	def_special sub_813AF48
+	def_special ScrollableMultichoice_ClosePersistentMenu
 	def_special DoDeoxysRockInteraction
 	def_special SetDeoxysRockPalette
 	def_special CreateEventLegalEnemyMon
diff --git a/data/text/mauville_man.inc b/data/text/mauville_man.inc
index 5d9954d9b..5b7dfbb7b 100644
--- a/data/text/mauville_man.inc
+++ b/data/text/mauville_man.inc
@@ -1,63 +1,63 @@
-@ Only contains a portion of the mauville_man text. The rest is in scripts/mauville_man.inc
-gText_SoPretty::
+@ Only contains the text for the Mauville Man named Giddy. The rest is in scripts/mauville_man.inc
+GiddyText_SoPretty::
 	.string " so pretty!$"
 
-gText_SoDarling::
+GiddyText_SoDarling::
 	.string " so darling!$"
 
-gText_SoRelaxed::
+GiddyText_SoRelaxed::
 	.string " so relaxed!$"
 
-gText_SoSunny::
+GiddyText_SoSunny::
 	.string " so sunny!$"
 
-gText_SoDesirable::
+GiddyText_SoDesirable::
 	.string " so desirable!$"
 
-gText_SoExciting::
+GiddyText_SoExciting::
 	.string " so exciting!$"
 
-gText_SoAmusing::
+GiddyText_SoAmusing::
 	.string " so amusing!$"
 
-gText_SoMagical::
+GiddyText_SoMagical::
 	.string " so magical!$"
 
-gOtherText_Is::
+GiddyText_Is::
 	.string " is$"
 
-gOtherText_DontYouAgree::
+GiddyText_DontYouAgree::
 	.string "\n"
 	.string "Don't you agree?$"
 
-gMauvilleManText_ISoWantToGoOnAVacation::
+GiddyText_ISoWantToGoOnAVacation::
 	.string "I so want to go on a vacation.\n"
 	.string "Would you happen to know a nice place?$"
 
-gMauvilleManText_IBoughtCrayonsWith120Colors::
+GiddyText_IBoughtCrayonsWith120Colors::
 	.string "I bought crayons with 120 colors!\n"
 	.string "Don't you think that's nice?$"
 
-gMauvilleManText_WouldntItBeNiceIfWeCouldFloat::
+GiddyText_WouldntItBeNiceIfWeCouldFloat::
 	.string "Wouldn't it be nice if we could float\n"
 	.string "away on a cloud of bubbles?$"
 
-gMauvilleManText_WhenYouWriteOnASandyBeach::
+GiddyText_WhenYouWriteOnASandyBeach::
 	.string "When you write on a sandy beach,\n"
 	.string "they wash away. It makes me sad.$"
 
-gMauvilleManText_WhatsTheBottomOfTheSeaLike::
+GiddyText_WhatsTheBottomOfTheSeaLike::
 	.string "What's the bottom of the sea like?\n"
 	.string "Just once I would so love to go!$"
 
-gMauvilleManText_WhenYouSeeTheSettingSunDoesIt::
+GiddyText_WhenYouSeeTheSettingSunDoesIt::
 	.string "When you see the setting sun, does it\n"
 	.string "make you want to go home?$"
 
-gMauvilleManText_LyingBackInTheGreenGrass::
+GiddyText_LyingBackInTheGreenGrass::
 	.string "Lying back in the green grass…\n"
 	.string "Oh, it's so, so nice!$"
 
-gMauvilleManText_SecretBasesAreSoWonderful::
+GiddyText_SecretBasesAreSoWonderful::
 	.string "SECRET BASES are so wonderful!\n"
 	.string "Can't you feel the excitement?$"