Merge pull request #316 from PikalaxALT/various_documentation

Various documentation

16 files changed, 84 insertions, 32 deletions

diff --git a/include/battle_anim.h b/include/battle_anim.h
index f568d0f97..c8704707b 100644
--- a/include/battle_anim.h
+++ b/include/battle_anim.h
@@ -412,9 +412,9 @@ void TrySetSpriteRotScale(struct Sprite *sprite, bool8 recalcCenterVector, s16 x
 void sub_8075AD8(struct Sprite *sprite);
 u16 ArcTan2Neg(s16 a, s16 b);
 void SetGreyscaleOrOriginalPalette(u16 paletteNum, bool8 restoreOriginalColor);
-u32 sub_8075BE8(u8 battleBackground, u8 attacker, u8 target, u8 attackerPartner, u8 targetPartner, u8 a6, u8 a7);
-u32 sub_8075CB8(u8 a1, u8 a2, u8 a3, u8 a4);
-u8 sub_8075D80(u8 a1);
+u32 SelectBattleAnimSpriteAndBgPalettes(bool8 battleBackground, bool8 attacker, bool8 target, bool8 attackerPartner, bool8 targetPartner, bool8 a6, bool8 a7);
+u32 SelectBattlerSpritePalettes(bool8 playerLeft, bool8 playerRight, bool8 foeLeft, bool8 foeRight);
+u8 GetSpritePalIdxByBattler(u8 a1);
 void AnimSpriteOnMonPos(struct Sprite *sprite);
 void TranslateAnimSpriteToTargetMonLocation(struct Sprite *sprite);
 void AnimThrowProjectile(struct Sprite *sprite);
@@ -468,7 +468,7 @@ void sub_8099BD4(u8 taskId);
 extern const struct SpriteTemplate gUnknown_83E7C98;
 extern const struct SpriteTemplate gBasicHitSplatSpriteTemplate;
 u32 UnpackSelectedBattleAnimPalettes(s16 selector);
-void sub_80B9BDC(u8 taskId);
+void AnimTask_CurseBlendEffect(u8 taskId);
 void sub_80B9CE4(u8 taskId);
 void sub_80B9E58(u8 taskId);
 void sub_80B9F6C(u8 taskId);
@@ -561,13 +561,13 @@ void AnimWaterPulseRing(struct Sprite *sprite);
 u8 SmokescreenImpact(s16 x, s16 y, u8 a3);
 
 // battle_anim_utility_funcs.c
-void sub_80BA7F8(u8 taskId);
-void sub_80BA83C(u8 taskId);
+void AnimTask_BlendSelected(u8 taskId);
+void AnimTask_BlendExcept(u8 taskId);
 void AnimTask_SetCamouflageBlend(u8 taskId);
 void AnimTask_BlendParticle(u8 taskId);
-void sub_80BAB38(u8 taskId);
-void sub_80BAB98(u8 taskId);
-void sub_80BACEC(u8 taskId);
+void AnimTask_HardwarePaletteFade(u8 taskId);
+void AnimTask_CloneBattlerSpriteWithBlend(u8 taskId);
+void AnimTask_SetUpCurseBackground(u8 taskId);
 void sub_80BB088(u8 taskId);
 void sub_80BB660(u8 taskId);
 void sub_80BB7DC(u8 taskId);
diff --git a/include/bike.h b/include/bike.h
index abffae435..e4f94becb 100644
--- a/include/bike.h
+++ b/include/bike.h
@@ -25,8 +25,8 @@ enum
     ACRO_STATE_TURN_JUMP,
 };
 
-void sub_80BD620(u32 directionHistory, u32 abStartSelectHistory);
-bool8 sub_80BD540(void);
+void InitPlayerAvatarBikeState(u32 directionHistory, u32 abStartSelectHistory);
+bool8 MetatileAtPlayerPositionForbidsBiking(void);
 void StartTransitionToFlipBikeState(u8 flags);
 s16 GetPlayerSpeed(void);
 bool8 sub_80BD460(u8);
diff --git a/include/constants/flags.h b/include/constants/flags.h
index 212718bc9..d7b4195e2 100644
--- a/include/constants/flags.h
+++ b/include/constants/flags.h
@@ -1437,7 +1437,7 @@
 // SPECIAL FLAGS (unknown purpose)
 #define SPECIAL_FLAGS_START 0x4000
 #define SPECIAL_FLAGS_COUNT 16
-#define FLAG_SPECIAL_FLAG_0x4000    0x4000
+#define FLAG_DONT_SHOW_MAP_NAME_POPUP    0x4000
 #define FLAG_DONT_TRANSITION_MUSIC    0x4001
 #define FLAG_SPECIAL_FLAG_0x4002    0x4002
 #define FLAG_SPECIAL_FLAG_0x4003    0x4003
diff --git a/include/decoration.h b/include/decoration.h
new file mode 100644
index 000000000..fadb2a3c8
--- /dev/null
+++ b/include/decoration.h
@@ -0,0 +1,55 @@
+#ifndef GUARD_DECORATION_H
+#define GUARD_DECORATION_H
+
+enum DecorationPermission
+{
+    /*
+     * The nomenclature here describes collision and placement permissions, in that order.
+     */
+    DECORPERM_SOLID_FLOOR,
+    DECORPERM_PASS_FLOOR,
+    DECORPERM_BEHIND_FLOOR,
+    DECORPERM_NA_WALL,
+    DECORPERM_SPRITE,
+};
+
+enum DecorationShape
+{
+    DECORSHAPE_1x1,
+    DECORSHAPE_2x1,
+    DECORSHAPE_3x1, // unused
+    DECORSHAPE_4x2,
+    DECORSHAPE_2x2,
+    DECORSHAPE_1x2,
+    DECORSHAPE_1x3, // unused
+    DECORSHAPE_2x4,
+    DECORSHAPE_3x3,
+    DECORSHAPE_3x2,
+};
+
+enum DecorationCategory
+{
+    DECORCAT_DESK,
+    DECORCAT_CHAIR,
+    DECORCAT_PLANT,
+    DECORCAT_ORNAMENT,
+    DECORCAT_MAT,
+    DECORCAT_POSTER,
+    DECORCAT_DOLL,
+    DECORCAT_CUSHION,
+    DECORCAT_COUNT,
+};
+
+struct Decoration
+{
+    u8 id;
+    u8 name[16];
+    u8 permission;
+    u8 shape;
+    u8 category;
+    u16 price;
+    const u8 *description;
+    const u16 *tiles;
+};
+
+#endif //GUARD_DECORATION_H
diff --git a/include/event_scripts.h b/include/event_scripts.h
index a1bb5e35d..0f076ed28 100644
--- a/include/event_scripts.h
+++ b/include/event_scripts.h
@@ -1254,7 +1254,7 @@ extern const u8 EventScript_CurrentTooFast[];
 extern const u8 EventScript_UseSurf[];
 extern const u8 EventScript_Waterfall[];
 extern const u8 EventScript_CantUseWaterfall[];
-extern const u8 gUnknown_81A8CED[];
+extern const u8 EventScript_VsSeekerChargingDone[];
 extern const u8 EventScript_FieldPoison[];
 extern const u8 EventScript_EggHatch[];
 extern const u8 EventScript_1C1361[];
diff --git a/include/field_player_avatar.h b/include/field_player_avatar.h
index 79e6c2aef..df9084eab 100644
--- a/include/field_player_avatar.h
+++ b/include/field_player_avatar.h
@@ -15,7 +15,7 @@ void MovePlayerNotOnBike(u8 direction, u16 heldKeys);
 
 void MovementType_Player(struct Sprite * sprite);
 void sub_805C270(void);
-void sub_805C780(void);
+void StopPlayerAvatar(void);
 void GetXYCoordsOneStepInFrontOfPlayer(s16 *xPtr, s16 *yPtr);
 u8 GetPlayerAvatarGraphicsIdByStateId(u8);
 void SetPlayerAvatarStateMask(u8 mask);
diff --git a/include/global.fieldmap.h b/include/global.fieldmap.h
index cd553a55a..5fa15b95a 100644
--- a/include/global.fieldmap.h
+++ b/include/global.fieldmap.h
@@ -333,6 +333,7 @@ enum
     COLLISION_ISOLATED_HORIZONTAL_RAIL,
     COLLISION_VERTICAL_RAIL,
     COLLISION_HORIZONTAL_RAIL,
+    COLLISION_COUNT
 };
 
 // player running states
diff --git a/include/intro.h b/include/intro.h
index 19cdcd032..1630b845e 100644
--- a/include/intro.h
+++ b/include/intro.h
@@ -1,7 +1,7 @@
 #ifndef GUARD_INTRO_H
 #define GUARD_INTRO_H
 
-void sub_80EC864(void);
+void CB2_CopyrightScreen(void);
 void c2_copyright_1(void);
 
 #endif //GUARD_INTRO_H
diff --git a/include/link.h b/include/link.h
index d6f35f66d..899f0cb03 100644
--- a/include/link.h
+++ b/include/link.h
@@ -79,8 +79,8 @@
 #define LINKTYPE_BATTLE_TOWER        0x2288
 #define LINKTYPE_0x3311              0x3311
 #define LINKTYPE_0x3322              0x3322
-#define LINKTYPE_0x4411              0x4411
-#define LINKTYPE_0x6601              0x6601
+#define LINKTYPE_BERRY_BLENDER_SETUP              0x4411
+#define LINKTYPE_CONTEST_GMODE              0x6601
 
 #define MASTER_HANDSHAKE 0x8FFF
 #define SLAVE_HANDSHAKE  0xB9A0
diff --git a/include/menu_helpers.h b/include/menu_helpers.h
index d26f50483..fda77d1b6 100644
--- a/include/menu_helpers.h
+++ b/include/menu_helpers.h
@@ -15,7 +15,7 @@ struct YesNoFuncTable
 };
 
 bool16 RunTextPrinters_CheckActive(u8 textPrinterId);
-bool32 sub_80BF72C(void);
+bool32 MenuHelpers_CallLinkSomething(void);
 bool8 sub_80BF748(void);
 bool8 MenuHelpers_LinkSomething(void);
 void SetVBlankHBlankCallbacksToNull(void);
diff --git a/include/overworld.h b/include/overworld.h
index 5f3728dec..f5cb1987e 100644
--- a/include/overworld.h
+++ b/include/overworld.h
@@ -81,7 +81,7 @@ void SetWarpDestinationToEscapeWarp(void);
 void SetWarpDestinationToLastHealLocation(void);
 u8 IsMapTypeOutdoors(u8 mapType);
 void Overworld_ClearSavedMusic(void);
-bool32 sub_8056124(u16 song);
+bool32 Overworld_MusicCanOverrideMapMusic(u16 song);
 
 void player_avatar_init_params_reset(void);
 
@@ -146,7 +146,7 @@ bool8 BGMusicStopped(void);
 bool8 IsMapTypeIndoors(u8 mapType);
 bool32 Overworld_IsBikingAllowed(void);
 void Overworld_ResetStateAfterDigEscRope(void);
-bool32 sub_8058244(void);
+bool32 Overworld_LinkRecvQueueLengthMoreThan2(void);
 u8 GetCurrentMapType(void);
 
 u8 GetLastUsedWarpMapType(void);
diff --git a/include/quest_log.h b/include/quest_log.h
index 54da8822a..090d0daf6 100644
--- a/include/quest_log.h
+++ b/include/quest_log.h
@@ -9,7 +9,7 @@
 extern u8 gQuestLogState;
 extern u8 gUnknown_3005E88;
 extern const u16 gUnknown_84566A8[];
-extern struct FieldInput gUnknown_3005E90;
+extern struct FieldInput gQuestLogFieldInput;
 
 void sub_8112720(u8);
 void SetQuestLogEvent(u16, const u16 *);
@@ -27,8 +27,8 @@ void sub_8111CF0(void);
 void ResetQuestLog(void);
 void ResetTrainerFanClub(void);
 void TrySetUpQuestLogScenes_ElseContinueFromSave(u8 taskId);
-void sub_8112450(void);
-void sub_8112364(void);
+void SaveQuestLogData(void);
+void QuestLog_OnInteractionWithSpecialNpc(void);
 u8 sub_8112CAC(void);
 void sub_81138F8(void);
 void sub_811231C(void);
diff --git a/include/save_location.h b/include/save_location.h
index c8e362231..2d2cb1974 100644
--- a/include/save_location.h
+++ b/include/save_location.h
@@ -10,7 +10,7 @@
 
 void TrySetMapSaveWarpStatus(void);
 bool32 IsCurMapPokeCenter(void);
-void sub_810B810(void);
-void sub_810B82C(void);
+void SetUnlockedPokedexFlags(void);
+void SetPostgameFlags(void);
 
 #endif // GUARD_SAVE_LOCATION_H
diff --git a/include/script.h b/include/script.h
index a37909137..ba1de4f1c 100644
--- a/include/script.h
+++ b/include/script.h
@@ -78,7 +78,7 @@ u8 GetRegisteredQuestLogInput(void);
 void ResetFacingNpcOrSignPostVars(void);
 bool8 CanWalkAwayToCancelMsgBox(void);
 void SetWalkingIntoSignVars(void);
-bool8 sub_80699D4(void);
+bool8 IsMsgBoxWalkawayDisabled(void);
 
 extern const u8 *gRAMScriptPtr;
 extern u8 gWalkAwayFromSignInhibitTimer;
diff --git a/include/strings.h b/include/strings.h
index eb6a47ce7..6979f6757 100644
--- a/include/strings.h
+++ b/include/strings.h
@@ -916,7 +916,7 @@ extern const u8 gText_GiveUpTryingToTeachNewMove[];
 extern const u8 gText_DecimalPoint[];
 
 // map_name_popup
-extern const u8 gUnknown_841D18D[];
+extern const u8 gText_Rooftop2[];
 
 // option menu
 extern const u8 gText_TextSpeed[];
diff --git a/include/vs_seeker.h b/include/vs_seeker.h
index 8c3b86194..6668cc6b4 100644
--- a/include/vs_seeker.h
+++ b/include/vs_seeker.h
@@ -3,18 +3,14 @@
 
 #include "global.h"
 
-void sub_810C604(void);
-void sub_810C640(void);
-
 void Task_VsSeeker_0(u8 taskId);
 void sub_810CB90(void);
 void sub_810CDE8(void);
 int GetRematchTrainerId(u16 a0);
 bool8 sub_810CF04(u8 a0);
-u8 sub_810CF54();
 void sub_810D0D0(void);
 void sub_810CB90(void);
-bool8 sub_810C4EC(void);
+bool8 UpdateVsSeekerStepCounter(void);
 void TryUpdateRandomTrainerRematches(u16 mapGroup, u16 mapNum);
 
 #endif //GUARD_VS_SEEKER_H