From 45f75213c0599405ccaee8c9a453392a00fa470b Mon Sep 17 00:00:00 2001 From: PikalaxALT Date: Fri, 19 Mar 2021 09:26:01 -0400 Subject: Some more quest log and field player avater documentation --- include/quest_log.h | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) (limited to 'include/quest_log.h') diff --git a/include/quest_log.h b/include/quest_log.h index ffe5c2cea..a9a04657e 100644 --- a/include/quest_log.h +++ b/include/quest_log.h @@ -8,10 +8,11 @@ struct QuestLogEntry { - u8 localId; - u8 mapNum; - u8 mapGroup; - u8 animId; + // When command == 2, these fields have different meanings + u8 localId; // cmd == 2: Pressed A/B, checked wild, held direction, took step + u8 mapNum; // cmd == 2: Always set to 0 + u8 mapGroup; // cmd == 2: Dpad direction + u8 animId; // cmd == 2: Always set to 0 u16 duration; u8 command; }; @@ -32,7 +33,7 @@ extern u16 *gUnknown_203AE04; extern u16 *sEventRecordingPointer; extern u16 sQuestLogCursor; -void sub_8112720(u8); +void QuestLogRecordPlayerAvatarGfxTransition(u8); void SetQuestLogEvent(u16, const u16 *); void SetQLPlayedTheSlots(void); void QuestLog_RecordEnteredMap(u16); @@ -54,15 +55,18 @@ void *QuestLogGetFlagOrVarPtr(bool8 isFlag, u16 idx); void QuestLogSetFlagOrVar(bool8 isFlag, u16 idx, u16 value); void SetQuestLogRecordAndPlaybackPointers(void *oldSave); void sub_811246C(struct Sprite *sprite); -void sub_81124EC(u8 a0, u8 a1, u8 a2, u8 a3); +void QuestLogRecordNPCStep(u8 a0, u8 a1, u8 a2, u8 a3); bool8 sub_8111C2C(void); -void sub_81128BC(u8 a0); -void sub_811278C(u8 movementActionId, u8 duration); + +#define QL_ESCALATOR_OUT 1 +#define QL_ESCALATOR_IN 2 +void QuestLog_OnEscalatorWarp(u8 direction); +void QuestLogRecordPlayerAvatarGfxTransitionWithDuration(u8 movementActionId, u8 duration); void Special_UpdateTrainerFansAfterLinkBattle(void); -void sub_8112628(u8 movementActionId); -void sub_81126AC(u8 movementActionId, u8 duration); -void sub_8112588(u8 localId, u8 mapNum, u8 mapGroup, u8 movementActionId, u8 duration); -void sub_8112C9C(void); +void QuestLogRecordPlayerStep(u8 movementActionId); +void QuestLogRecordPlayerStepWithDuration(u8 movementActionId, u8 duration); +void QuestLogRecordNPCStepWithDuration(u8 localId, u8 mapNum, u8 mapGroup, u8 movementActionId, u8 duration); +void QL_AfterRecordFishActionSuccessful(void); void sub_8110920(void); void sub_8111708(void); void sub_81127F8(struct FieldInput * a0); -- cgit v1.2.3 From cdfeb638f40ffa0e3f5d437f7b1613f8313896ab Mon Sep 17 00:00:00 2001 From: PikalaxALT Date: Sat, 20 Mar 2021 11:13:58 -0400 Subject: Document remaining routines in field_specials --- include/quest_log.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'include/quest_log.h') diff --git a/include/quest_log.h b/include/quest_log.h index a9a04657e..748b9c3da 100644 --- a/include/quest_log.h +++ b/include/quest_log.h @@ -39,7 +39,7 @@ void SetQLPlayedTheSlots(void); void QuestLog_RecordEnteredMap(u16); u8 sub_8112CAC(void); bool8 QuestLog_SchedulePlaybackCB(void (*func)(void)); -void sub_8111F38(u16 offset, u16 idx); +void QuestLog_BackUpPalette(u16 offset, u16 size); void CommitQuestLogWindow1(void); void QuestLog_DrawPreviouslyOnQuestHeaderIfInPlaybackMode(void); void ResetQuestLog(void); @@ -77,7 +77,7 @@ bool8 QuestLogScenePlaybackIsEnding(void); void sub_8115798(void); bool8 QuestLog_ShouldEndSceneOnMapChange(void); void QuestLog_AdvancePlayhead_(void); -void sub_8111F14(void); +void QuestLog_InitPalettesBackup(void); void sub_8110FCC(void); u8 GetQuestLogStartType(void); void sub_81113E4(void); @@ -94,7 +94,7 @@ u16 *sub_8113CC8(u16 *, struct QuestLogEntry *); u16 *sub_8113D08(u16 *, struct QuestLogEntry *); u16 *sub_8113D48(u16 *, struct QuestLogEntry *); u16 *sub_8113D94(u16 *, struct QuestLogEntry *); -void sub_811381C(void); +void QL_EnableRecordingSteps(void); u16 *QuestLog_SkipCommand(u16 *, u16 **); void sub_8113ABC(const u16 *); u16 *sub_8113C20(u16 *, struct QuestLogEntry *); -- cgit v1.2.3 From f6565a15d403cf5878c4fbcfd30f4885ea77480f Mon Sep 17 00:00:00 2001 From: PikalaxALT Date: Sun, 21 Mar 2021 20:28:42 -0400 Subject: Style fixes; attempt to match help_system NONMATCHING --- include/quest_log.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'include/quest_log.h') diff --git a/include/quest_log.h b/include/quest_log.h index 748b9c3da..295f942f2 100644 --- a/include/quest_log.h +++ b/include/quest_log.h @@ -6,6 +6,10 @@ #include "constants/quest_log.h" #include "field_control_avatar.h" +// Parameter to QuestLog_OnEscalatorWarp +#define QL_ESCALATOR_OUT 1 +#define QL_ESCALATOR_IN 2 + struct QuestLogEntry { // When command == 2, these fields have different meanings @@ -57,9 +61,6 @@ void SetQuestLogRecordAndPlaybackPointers(void *oldSave); void sub_811246C(struct Sprite *sprite); void QuestLogRecordNPCStep(u8 a0, u8 a1, u8 a2, u8 a3); bool8 sub_8111C2C(void); - -#define QL_ESCALATOR_OUT 1 -#define QL_ESCALATOR_IN 2 void QuestLog_OnEscalatorWarp(u8 direction); void QuestLogRecordPlayerAvatarGfxTransitionWithDuration(u8 movementActionId, u8 duration); void Special_UpdateTrainerFansAfterLinkBattle(void); -- cgit v1.2.3