Start misc battle documentation

1 files changed, 59 insertions, 48 deletions

diff --git a/include/battle_transition.h b/include/battle_transition.h
index a33032fb4..784c5f968 100644
--- a/include/battle_transition.h
+++ b/include/battle_transition.h
@@ -11,8 +11,7 @@ void GetBg0TilesDst(u16 **tilemap, u16 **tileset);
 
 extern const struct SpritePalette gSpritePalette_Pokeball;
 
-enum // TRANSITION_MUGSHOT
-{
+enum {
     MUGSHOT_SIDNEY,
     MUGSHOT_PHOEBE,
     MUGSHOT_GLACIA,
@@ -21,52 +20,64 @@ enum // TRANSITION_MUGSHOT
     MUGSHOTS_COUNT
 };
 
-// credits for the names go to Dyskinesia, Tetrable and Farore
-// names are naturally subject to change
+enum {
+    B_TRANSITION_BLUR,
+    B_TRANSITION_SWIRL,
+    B_TRANSITION_SHUFFLE,
+    B_TRANSITION_BIG_POKEBALL,
+    B_TRANSITION_POKEBALLS_TRAIL,
+    B_TRANSITION_CLOCKWISE_BLACKFADE,
+    B_TRANSITION_RIPPLE,
+    B_TRANSITION_WAVE,
+    B_TRANSITION_SLICE,
+    B_TRANSITION_WHITEFADE,
+    B_TRANSITION_GRID_SQUARES,
+    B_TRANSITION_SHARDS,
+    B_TRANSITION_SIDNEY,
+    B_TRANSITION_PHOEBE,
+    B_TRANSITION_GLACIA,
+    B_TRANSITION_DRAKE,
+    B_TRANSITION_CHAMPION,
+    B_TRANSITION_AQUA, // Here below added in Emerald
+    B_TRANSITION_MAGMA,
+    B_TRANSITION_REGICE,
+    B_TRANSITION_REGISTEEL,
+    B_TRANSITION_REGIROCK,
+    B_TRANSITION_KYOGRE,
+    B_TRANSITION_GROUDON,
+    B_TRANSITION_RAYQUAZA,
+    B_TRANSITION_SHRED_SPLIT,
+    B_TRANSITION_BLACKHOLE1,
+    B_TRANSITION_BLACKHOLE2,
+    B_TRANSITION_RECTANGULAR_SPIRAL,
+    B_TRANSITION_FRONTIER_LOGO_WIGGLE,
+    B_TRANSITION_FRONTIER_LOGO_WAVE,
+    B_TRANSITION_FRONTIER_SQUARES,
+    B_TRANSITION_FRONTIER_SQUARES_SCROLL,
+    B_TRANSITION_FRONTIER_SQUARES_SPIRAL,
+    B_TRANSITION_FRONTIER_CIRCLES_MEET,
+    B_TRANSITION_FRONTIER_CIRCLES_CROSS,
+    B_TRANSITION_FRONTIER_CIRCLES_ASYMMETRIC_SPIRAL,
+    B_TRANSITION_FRONTIER_CIRCLES_SYMMETRIC_SPIRAL,
+    B_TRANSITION_FRONTIER_CIRCLES_MEET_IN_SEQ,
+    B_TRANSITION_FRONTIER_CIRCLES_CROSS_IN_SEQ,
+    B_TRANSITION_FRONTIER_CIRCLES_ASYMMETRIC_SPIRAL_IN_SEQ,
+    B_TRANSITION_FRONTIER_CIRCLES_SYMMETRIC_SPIRAL_IN_SEQ,
+    B_TRANSITION_COUNT
+};
 
-#define B_TRANSITION_BLUR                                      0
-#define B_TRANSITION_SWIRL                                     1
-#define B_TRANSITION_SHUFFLE                                   2
-#define B_TRANSITION_BIG_POKEBALL                              3
-#define B_TRANSITION_POKEBALLS_TRAIL                           4
-#define B_TRANSITION_CLOCKWISE_BLACKFADE                       5
-#define B_TRANSITION_RIPPLE                                    6
-#define B_TRANSITION_WAVE                                      7
-#define B_TRANSITION_SLICE                                     8
-#define B_TRANSITION_WHITEFADE                                 9
-#define B_TRANSITION_GRID_SQUARES                              10
-#define B_TRANSITION_SHARDS                                    11
-#define B_TRANSITION_SIDNEY                                    12
-#define B_TRANSITION_PHOEBE                                    13
-#define B_TRANSITION_GLACIA                                    14
-#define B_TRANSITION_DRAKE                                     15
-#define B_TRANSITION_CHAMPION                                  16
-// added in Emerald
-#define B_TRANSITION_AQUA                                      17
-#define B_TRANSITION_MAGMA                                     18
-#define B_TRANSITION_REGICE                                    19
-#define B_TRANSITION_REGISTEEL                                 20
-#define B_TRANSITION_REGIROCK                                  21
-#define B_TRANSITION_KYOGRE                                    22
-#define B_TRANSITION_GROUDON                                   23
-#define B_TRANSITION_RAYQUAZA                                  24
-#define B_TRANSITION_SHRED_SPLIT                               25
-#define B_TRANSITION_BLACKHOLE1                                26
-#define B_TRANSITION_BLACKHOLE2                                27
-#define B_TRANSITION_RECTANGULAR_SPIRAL                        28
-#define B_TRANSITION_FRONTIER_LOGO_WIGGLE                      29
-#define B_TRANSITION_FRONTIER_LOGO_WAVE                        30
-#define B_TRANSITION_FRONTIER_SQUARES                          31
-#define B_TRANSITION_FRONTIER_SQUARES_SCROLL                   32
-#define B_TRANSITION_FRONTIER_SQUARES_SPIRAL                   33
-#define B_TRANSITION_FRONTIER_CIRCLES_MEET                     34
-#define B_TRANSITION_FRONTIER_CIRCLES_CROSS                    35
-#define B_TRANSITION_FRONTIER_CIRCLES_ASYMMETRIC_SPIRAL        36
-#define B_TRANSITION_FRONTIER_CIRCLES_SYMMETRIC_SPIRAL         37
-#define B_TRANSITION_FRONTIER_CIRCLES_MEET_IN_SEQ              38
-#define B_TRANSITION_FRONTIER_CIRCLES_CROSS_IN_SEQ             39
-#define B_TRANSITION_FRONTIER_CIRCLES_ASYMMETRIC_SPIRAL_IN_SEQ 40
-#define B_TRANSITION_FRONTIER_CIRCLES_SYMMETRIC_SPIRAL_IN_SEQ  41
-#define B_TRANSITION_COUNT                                     42
+// IDs for GetSpecialBattleTransition
+enum {
+    B_TRANSITION_GROUP_B_TOWER,
+    B_TRANSITION_GROUP_B_DOME = 3,
+    B_TRANSITION_GROUP_B_PALACE,
+    B_TRANSITION_GROUP_B_ARENA,
+    B_TRANSITION_GROUP_B_FACTORY,
+    B_TRANSITION_GROUP_B_PIKE,
+    B_TRANSITION_GROUP_B_PYRAMID = 10,
+    B_TRANSITION_GROUP_TRAINER_HILL,
+    B_TRANSITION_GROUP_SECRET_BASE,
+    B_TRANSITION_GROUP_E_READER,
+};
 
 #endif // GUARD_BATTLE_TRANSITION_H