Some documentation of field_control_avatar and related routines

include/constants/quest_log.h

@@ -118,6 +118,18 @@
 #define QL_DEPARTED_MISC_BUILDING_1  8
 #define QL_DEPARTED_MISC_BUILDING_2  9
 
+#define QL_INPUT_OFF 0
+#define QL_INPUT_UP 1
+#define QL_INPUT_DOWN 2
+#define QL_INPUT_LEFT 3
+#define QL_INPUT_RIGHT 4
+#define QL_INPUT_L 5
+#define QL_INPUT_R 6
+#define QL_INPUT_START 7
+#define QL_INPUT_SELECT 8
+#define QL_INPUT_A 9
+#define QL_INPUT_B 10
+
 
 #define FANCLUB_MEMBER1        0
 #define FANCLUB_MEMBER2        1

include/constants/vars.h

@@ -51,7 +51,12 @@
 // every party poke gets a slight boost.
 #define VAR_HAPPINESS_STEP_COUNTER          0x4021
 
-// Maybe unused?
+// Counts up every step while a party Pokemon is
+// poisoned. Wraps around at 5. When wraparound
+// occurs, every party Pokemon with the PSN status
+// takes 1 point of damage.
+// This is a deviation from the typical rate in
+// the series, which is 1 damage every 4 steps.
 #define VAR_POISON_STEP_COUNTER             0x4022
 
 // Step counter. Caps at 1500. If you enter a map with

include/event_scripts.h

@@ -1213,7 +1213,7 @@ extern const u8 CableClub_Text_PleaseWaitBCancel[];
 extern const u8 EventScript_FldEffFlash[];
 
 // field_control_avatar
-extern const u8 gUnknown_81A7ADB[];
+extern const u8 EventScript_CancelMessageBox[];
 extern const u8 PalletTown_PlayersHouse_2F_EventScript_PC[];
 extern const u8 EventScript_HiddenItemScript[];
 extern const u8 EventScript_PC[];
@@ -1246,10 +1246,10 @@ extern const u8 gUnknown_81A76D5[];
 extern const u8 CableClub_EventScript_81BBFD8[];
 extern const u8 EventScript_Questionnaire[];
 extern const u8 CableClub_EventScript_ShowBattleRecords[];
-extern const u8 gUnknown_81A76F0[];
-extern const u8 gUnknown_81A76F9[];
-extern const u8 gUnknown_81A76DE[];
-extern const u8 gUnknown_81A76E7[];
+extern const u8 EventScript_Indigo_UltimateGoal[];
+extern const u8 EventScript_Indigo_HighestAuthority[];
+extern const u8 EventScript_PokemartSign[];
+extern const u8 EventScript_PokecenterSign[];
 extern const u8 EventScript_CurrentTooFast[];
 extern const u8 EventScript_UseSurf[];
 extern const u8 EventScript_Waterfall[];

include/field_control_avatar.h

@@ -21,7 +21,7 @@ struct FieldInput
     u8 dpadDirection;
 };
 
-extern struct FieldInput gUnknown_3005078;
+extern struct FieldInput gInputToStoreInQuestLogMaybe;
 
 void RestartWildEncounterImmunitySteps(void);
 void ClearPoisonStepCounter(void);
@@ -33,7 +33,7 @@ const u8 *GetInteractedLinkPlayerScript(struct MapPosition *position, u8 metatil
 const u8 *GetCoordEventScriptAtMapPosition(struct MapPosition *position);
 void FieldClearPlayerInput(struct FieldInput *input);
 int ProcessPlayerFieldInput(struct FieldInput *input);
-void sub_806CD30(struct FieldInput * input);
+void FieldInput_HandleCancelSignpost(struct FieldInput * input);
 void FieldGetPlayerInput(struct FieldInput *input, u16 newKeys, u16 heldKeys);
 
 #endif //GUARD_FIELD_CONTROL_AVATAR_H

include/script.h

@@ -65,22 +65,22 @@ void sub_80992A0(u8 *script, u16 scriptSize);
 bool32 ValidateRamScript(void);
 void MEventSetRamScript(u8 * script, u16 scriptSize);
 u8 * sub_8069E48(void);
-void sub_8069998(u8 var);
-void sub_80699F8(void);
-void sub_8069964(void);
-void sub_80699A4(void);
-void sub_8069970(void);
-void sub_8069A20(void);
-void sub_8069A2C(void);
+void RegisterQuestLogInput(u8 var);
+void ClearMsgBoxCancelableState(void);
+void SetQuestLogInputIsDpadFlag(void);
+void ClearQuestLogInput(void);
+void ClearQuestLogInputIsDpadFlag(void);
+void MsgSetSignPost(void);
+void MsgSetNotSignPost(void);
 bool8 IsMsgSignPost(void);
-bool8 sub_806997C(void);
-u8 sub_80699B0(void);
-void sub_8069A54(void);
-bool8 sub_8069A04(void);
-void sub_80699E0(void);
+bool8 IsQuestLogInputDpad(void);
+u8 GetRegisteredQuestLogInput(void);
+void ResetFacingNpcOrSignPostVars(void);
+bool8 CanWalkAwayToCancelMsgBox(void);
+void SetWalkingIntoSignVars(void);
 bool8 sub_80699D4(void);
 
 extern const u8 *gRAMScriptPtr;
-extern u8 gUnknown_20370A0;
+extern u8 gWalkAwayFromSignInhibitTimer;
 
 #endif // GUARD_SCRIPT_H

include/script_menu.h

@@ -15,6 +15,6 @@ void ScriptMenu_DisplayPCStartupPrompt(void);
 
 bool8 (*ScriptMenu_GetPicboxWaitFunc(void))(void);
 void QLPlaybackCB_DestroyScriptMenuMonPicSprites(void);
-void sub_809D424(void);
+void PicboxCancel(void);
 
 #endif //GUARD_SCRIPT_MENU_H