document remaining funcs

2 files changed, 70 insertions, 64 deletions

diff --git a/data/event_scripts.s b/data/event_scripts.s
index 397cbd503..5ad4fa778 100644
--- a/data/event_scripts.s
+++ b/data/event_scripts.s
@@ -19,6 +19,7 @@
 #include "constants/vars.h"
 #include "constants/weather.h"
 #include "constants/trainer_hill.h"
+#include "constants/lilycove_lady.h"
 #include "constants/battle.h"
 #include "constants/metatile_labels.h"
 	.include "asm/macros.inc"
@@ -4283,9 +4284,9 @@ GraniteCave_B1F_Movement_2A8369: @ 82A8369
 LilycoveCity_PokemonCenter_1F_EventScript_2A836B:: @ 82A836B
 	special Script_GetLilycoveLadyId
 	switch VAR_RESULT
-	case 0, LilycoveCity_PokemonCenter_1F_EventScript_2A8554
-	case 1, LilycoveCity_PokemonCenter_1F_EventScript_2A8395
-	case 2, LilycoveCity_PokemonCenter_1F_EventScript_2A882A
+	case LILYCOVE_LADY_QUIZ, LilycoveCity_PokemonCenter_1F_EventScript_2A8554
+	case LILYCOVE_LADY_FAVOR, LilycoveCity_PokemonCenter_1F_EventScript_2A8395
+	case LILYCOVE_LADY_CONTEST, LilycoveCity_PokemonCenter_1F_EventScript_2A882A
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A8395:: @ 82A8395
@@ -4293,11 +4294,11 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A8395:: @ 82A8395
 	faceplayer
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A8A69, MSGBOX_DEFAULT
 	specialvar VAR_RESULT, GetFavorLadyState
-	compare VAR_RESULT, 0
+	compare VAR_RESULT, LILYCOVE_LADY_STATE_READY
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A83D0
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LILYCOVE_LADY_STATE_COMPLETED
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A83C6
-	compare VAR_RESULT, 2
+	compare VAR_RESULT, LILYCOVE_LADY_STATE_PRIZE
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A8510
 	end
 
@@ -4307,9 +4308,9 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A83C6:: @ 82A83C6
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A83D0:: @ 82A83D0
-	special BufferFavorLadyDescription
+	special BufferFavorLadyRequest
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A8A7D, MSGBOX_DEFAULT
-	specialvar VAR_RESULT, sub_818DC60
+	specialvar VAR_RESULT, HasAnotherPlayerGivenFavorLadyItem
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A8435
 	compare VAR_RESULT, 1
@@ -4357,7 +4358,7 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A845E:: @ 82A845E
 LilycoveCity_PokemonCenter_1F_EventScript_2A846C:: @ 82A846C
 	fadescreen 1
 	setvar VAR_RESULT, 0
-	special FavorLadyOpenBagMenu
+	special Script_FavorLadyOpenBagMenu
 	waitstate
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A848E
@@ -4374,7 +4375,7 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A848E:: @ 82A848E
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A84AD:: @ 82A84AD
-	specialvar VAR_RESULT, Script_ShowFavorLadyItem
+	specialvar VAR_RESULT, Script_DoesFavorLadyLikeItem
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A84C9
 	compare VAR_RESULT, 1
@@ -4382,13 +4383,13 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A84AD:: @ 82A84AD
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A84C9:: @ 82A84C9
-	special BufferFavorLadyDescription
+	special BufferFavorLadyRequest
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A8C0F, MSGBOX_DEFAULT
 	release
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A84D6:: @ 82A84D6
-	specialvar VAR_RESULT, DidFavorLadyLoveItem
+	specialvar VAR_RESULT, IsFavorLadyThresholdMet
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A84F2
 	compare VAR_RESULT, 1
@@ -4396,13 +4397,13 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A84D6:: @ 82A84D6
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A84F2:: @ 82A84F2
-	special BufferFavorLadyDescription
+	special BufferFavorLadyRequest
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A8C6F, MSGBOX_DEFAULT
 	release
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A84FF:: @ 82A84FF
-	special BufferFavorLadyDescription
+	special BufferFavorLadyRequest
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A8CC8, MSGBOX_DEFAULT
 	goto LilycoveCity_PokemonCenter_1F_EventScript_2A8510
 	end
@@ -4433,21 +4434,21 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A8554:: @ 82A8554
 	faceplayer
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A8E2B, MSGBOX_DEFAULT
 	specialvar VAR_RESULT, GetQuizLadyState
-	compare VAR_RESULT, 0
+	compare VAR_RESULT, LILYCOVE_LADY_STATE_READY
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A8585
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, LILYCOVE_LADY_STATE_COMPLETED
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A85AC
-	compare VAR_RESULT, 2
+	compare VAR_RESULT, LILYCOVE_LADY_STATE_PRIZE
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A86EC
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A8585:: @ 82A8585
 	specialvar VAR_RESULT, GetQuizAuthor
-	compare VAR_RESULT, 0
+	compare VAR_RESULT, QUIZ_AUTHOR_PLAYER
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A85C8
-	compare VAR_RESULT, 1
+	compare VAR_RESULT, QUIZ_AUTHOR_OTHER_PLAYER
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A85D2
-	compare VAR_RESULT, 2
+	compare VAR_RESULT, QUIZ_AUTHOR_LADY
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A85E0
 	end
 
@@ -4489,7 +4490,7 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A8612:: @ 82A8612
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A861C:: @ 82A861C
-	special ClearQuizLadyResponse
+	special ClearQuizLadyPlayerAnswer
 	compare VAR_0x8004, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A864C
 	compare VAR_0x8004, EASY_CHAT_TYPE_QUIZ_ANSWER
@@ -4509,7 +4510,7 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A864C:: @ 82A864C
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A8656:: @ 82A8656
-	special QuizLadyShowEasyChatScreen
+	special QuizLadyGetPlayerAnswer
 	waitstate
 	goto LilycoveCity_PokemonCenter_1F_EventScript_2A8635
 	end
@@ -4530,7 +4531,7 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A867F:: @ 82A867F
 LilycoveCity_PokemonCenter_1F_EventScript_2A8689:: @ 82A8689
 	special SetQuizLadyState_Complete
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A8F4D, MSGBOX_DEFAULT
-	specialvar VAR_RESULT, sub_818E308
+	specialvar VAR_RESULT, IsQuizAnswerCorrect
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A86C7
 	compare VAR_RESULT, 1
@@ -4546,8 +4547,8 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A86B0:: @ 82A86B0
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A86C7:: @ 82A86C7
-	special sub_818E538
-	special sub_818E274
+	special BufferQuizCorrectAnswer
+	special BufferQuizPrizeName
 	playse SE_HAZURE
 	delay 10
 	playse SE_HAZURE
@@ -4556,8 +4557,9 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A86C7:: @ 82A86C7
 	goto LilycoveCity_PokemonCenter_1F_EventScript_2A8759
 	end
 
+@VAR_RESULT is essentially ignored, both scripts are identical
 LilycoveCity_PokemonCenter_1F_EventScript_2A86EC:: @ 82A86EC
-	specialvar VAR_RESULT, sub_818E298
+	specialvar VAR_RESULT, BufferQuizAuthorNameAndCheckIfLady
 	compare VAR_RESULT, 1
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A8708
 	compare VAR_RESULT, 0
@@ -4599,7 +4601,7 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A8759:: @ 82A8759
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A8778:: @ 82A8778
-	special sub_818E3EC
+	special QuizLadyPickNewQuestion
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A9131, MSGBOX_DEFAULT
 	release
 	end
@@ -4610,7 +4612,7 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A8785:: @ 82A8785
 LilycoveCity_PokemonCenter_1F_EventScript_2A878D:: @ 82A878D
 	fadescreen 1
 	setvar VAR_RESULT, 0
-	special sub_818E3E0
+	special Script_QuizLadyOpenBagMenu
 	waitstate
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A87AF
@@ -4628,13 +4630,13 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A87AF:: @ 82A87AF
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A87CE:: @ 82A87CE
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A9270, MSGBOX_DEFAULT
-	special sub_818E430
-	special ClearQuizLadyResponse
-	setvar VAR_0x8004, 16
+	special ClearQuizLadyQuestionAndAnswer
+	special ClearQuizLadyPlayerAnswer
+	setvar VAR_0x8004, EASY_CHAT_TYPE_QUIZ_QUESTION
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A87E1:: @ 82A87E1
 	fadescreen 1
-	special sub_818E47C
+	special QuizLadySetCustomQuestion
 	waitstate
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A87F8
@@ -4650,9 +4652,9 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A87F8:: @ 82A87F8
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A8817:: @ 82A8817
-	special sub_818E490
-	special sub_818E4A4
-	special sub_818E510
+	special QuizLadyTakePrizeForCustomQuiz
+	special QuizLadyRecordCustomQuizData
+	special QuizLadySetWaitingForChallenger
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A9336, MSGBOX_DEFAULT
 	release
 	end
@@ -4661,15 +4663,16 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A882A:: @ 82A882A
 	lock
 	faceplayer
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A93A7, MSGBOX_DEFAULT
-	specialvar VAR_RESULT, sub_818E8B4
+	specialvar VAR_RESULT, HasPlayerGivenContestLadyPokeblock
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A8850
 	compare VAR_RESULT, 1
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A886C
 	end
 
+@ Redundant with above script, VAR_RESULT will always be 0 here
 LilycoveCity_PokemonCenter_1F_EventScript_2A8850:: @ 82A8850
-	specialvar VAR_RESULT, sub_818E8E0
+	specialvar VAR_RESULT, ShouldContestLadyShowGoOnAir
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A8876
 	compare VAR_RESULT, 1
@@ -4682,7 +4685,7 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A886C:: @ 82A886C
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A8876:: @ 82A8876
-	special sub_818E914
+	special Script_BufferContestLadyCategoryAndMonName
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A93F4, MSGBOX_DEFAULT
 	checkitem ITEM_POKEBLOCK_CASE, 1
 	compare VAR_RESULT, 0
@@ -4719,11 +4722,12 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A88D7:: @ 82A88D7
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A88F6:: @ 82A88F6
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A9571, MSGBOX_DEFAULT
-	special ContestLadyGivenPokeblock
+	special SetContestLadyGivenPokeblock
 	special GetContestLadyMonSpecies
 	goto LilycoveCity_PokemonCenter_1F_EventScript_2A890A
 	end
 
+@VAR_0x8004 here is the return value from GivePokeblockToContestLady
 LilycoveCity_PokemonCenter_1F_EventScript_2A890A:: @ 82A890A
 	applymovement 4, LilycoveCity_PokemonCenter_1F_Movement_2A89B8
 	waitmovement 0
@@ -4745,6 +4749,7 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A893F:: @ 82A893F
 	waitmovement 0
 	delay 60
 
+@VAR_0x8004 here is the return value from GivePokeblockToContestLady
 LilycoveCity_PokemonCenter_1F_EventScript_2A894C:: @ 82A894C
 	applymovement 4, LilycoveCity_PokemonCenter_1F_Movement_2A89C0
 	waitmovement 0
@@ -4761,13 +4766,13 @@ LilycoveCity_PokemonCenter_1F_EventScript_2A8970:: @ 82A8970
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A897E:: @ 82A897E
-	special sub_818E914
+	special Script_BufferContestLadyCategoryAndMonName
 	msgbox LilycoveCity_PokemonCenter_1F_Text_2A9605, MSGBOX_DEFAULT
 	goto LilycoveCity_PokemonCenter_1F_EventScript_2A898F
 	end
 
 LilycoveCity_PokemonCenter_1F_EventScript_2A898F:: @ 82A898F
-	specialvar VAR_RESULT, sub_818E8E0
+	specialvar VAR_RESULT, ShouldContestLadyShowGoOnAir
 	compare VAR_RESULT, 1
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A89A1
 	release
@@ -4809,9 +4814,10 @@ LilycoveCity_PokemonCenter_1F_Movement_2A89C2: @ 82A89C2
 	jump_in_place_left
 	step_end
 
+@TODO, these are CONTEST_CATEGORY_ constants, move into a new constants/contest.h?
 LilycoveCity_PokemonCenter_1F_EventScript_2A89C7:: @ 82A89C7
 	specialvar VAR_RESULT, GetContestLadyCategory
-	special sub_818E914
+	special Script_BufferContestLadyCategoryAndMonName
 	special GetContestLadyMonSpecies
 	compare VAR_RESULT, 0
 	goto_if_eq LilycoveCity_PokemonCenter_1F_EventScript_2A8A0A
diff --git a/data/specials.inc b/data/specials.inc
index ac25698e4..eaf661194 100644
--- a/data/specials.inc
+++ b/data/specials.inc
@@ -375,42 +375,42 @@ gSpecials:: @ 81DBA64
 	def_special SetLilycoveLadyGfx
 	def_special Script_GetLilycoveLadyId
 	def_special GetFavorLadyState
-	def_special BufferFavorLadyDescription
-	def_special sub_818DC60
+	def_special BufferFavorLadyRequest
+	def_special HasAnotherPlayerGivenFavorLadyItem
 	def_special BufferFavorLadyItemName
 	def_special BufferFavorLadyPlayerName
 	def_special DidFavorLadyLikeItem
-	def_special FavorLadyOpenBagMenu
-	def_special Script_ShowFavorLadyItem
-	def_special DidFavorLadyLoveItem
+	def_special Script_FavorLadyOpenBagMenu
+	def_special Script_DoesFavorLadyLikeItem
+	def_special IsFavorLadyThresholdMet
 	def_special FavorLadyGetPrize
 	def_special SetFavorLadyState_Complete
 	def_special GetQuizLadyState
 	def_special GetQuizAuthor
 	def_special IsQuizLadyWaitingForChallenger
 	def_special sub_811A858
-	def_special QuizLadyShowEasyChatScreen
-	def_special sub_818E308
+	def_special QuizLadyGetPlayerAnswer
+	def_special IsQuizAnswerCorrect
 	def_special BufferQuizPrizeItem
 	def_special SetQuizLadyState_Complete
-	def_special sub_818E298
+	def_special BufferQuizAuthorNameAndCheckIfLady
 	def_special SetQuizLadyState_GivePrize
-	def_special ClearQuizLadyResponse
-	def_special sub_818E3E0
-	def_special sub_818E430
-	def_special sub_818E47C
-	def_special sub_818E490
+	def_special ClearQuizLadyPlayerAnswer
+	def_special Script_QuizLadyOpenBagMenu
+	def_special ClearQuizLadyQuestionAndAnswer
+	def_special QuizLadySetCustomQuestion
+	def_special QuizLadyTakePrizeForCustomQuiz
 	def_special sub_813986C
-	def_special sub_818E4A4
-	def_special sub_818E510
-	def_special sub_818E538
-	def_special sub_818E274
-	def_special sub_818E3EC
-	def_special sub_818E8E0
-	def_special sub_818E8B4
-	def_special sub_818E914
+	def_special QuizLadyRecordCustomQuizData
+	def_special QuizLadySetWaitingForChallenger
+	def_special BufferQuizCorrectAnswer
+	def_special BufferQuizPrizeName
+	def_special QuizLadyPickNewQuestion
+	def_special ShouldContestLadyShowGoOnAir
+	def_special HasPlayerGivenContestLadyPokeblock
+	def_special Script_BufferContestLadyCategoryAndMonName
 	def_special OpenPokeblockCaseForContestLady
-	def_special ContestLadyGivenPokeblock
+	def_special SetContestLadyGivenPokeblock
 	def_special GetContestLadyMonSpecies
 	def_special GetContestLadyCategory
 	def_special PutLilycoveContestLadyShowOnTheAir