Merge pull request #520 from cbt6/field-effect

Document src/field_effect.c

data/field_effect_scripts.s

@@ -33,7 +33,7 @@ gFieldEffectScriptPointers::
 	.4byte gFldEffScript_TreeDisguise
 	.4byte gFldEffScript_MountainDisguise
 	.4byte gFldEffScript_NpcflyOut
-	.4byte gFldEffScript_UseFly
+	.4byte gFldEffScript_FlyOut
 	.4byte gFldEffScript_FlyIn
 	.4byte gFldEffScript_QuestionMarkIcon
 	.4byte gFldEffScript_FeetInFlowingWater
@@ -70,8 +70,8 @@ gFieldEffectScriptPointers::
 	.4byte gFldEffScript_UseVsSeeker
 	.4byte gFldEffScript_DoubleExclMarkIcon
 	.4byte gFldEffScript_MoveDeoxysRock
-	.4byte gFldEffScript_Unk44
+	.4byte gFldEffScript_DestroyDeoxysRock
-	.4byte gFldEffScript_Unk45
+	.4byte gFldEffScript_PhotoFlash
 
 gFldEffScript_ExclamationMarkIcon::
 	callnative FldEff_ExclamationMarkIcon1
@@ -173,7 +173,7 @@ gFldEffScript_DeepSandFootprints::
 	end 
 
 gFldEffScript_PokecenterHeal::
-	loadfadedpal gUnknown_83CBE9C
+	loadfadedpal gSpritePalette_PokeballGlow 
 	loadfadedpal_callnative gSpritePalette_GeneralFieldEffect0, FldEff_PokecenterHeal
 	end 
 
@@ -195,8 +195,8 @@ gFldEffScript_NpcflyOut::
 	callnative FldEff_NpcFlyOut
 	end 
 
-gFldEffScript_UseFly::
+gFldEffScript_FlyOut::
-	callnative FldEff_UseFly
+	callnative FldEff_FlyOut 
 	end 
 
 gFldEffScript_FlyIn::
@@ -313,8 +313,8 @@ gFldEffScript_PcturnOn::
 	end 
 
 gFldEffScript_HallOfFameRecord::
-	loadfadedpal gUnknown_83CBE9C
+	loadfadedpal gSpritePalette_PokeballGlow 
-	loadfadedpal_callnative gUnknown_83CBEA4, FldEff_HallOfFameRecord
+	loadfadedpal_callnative gSpritePalette_HofMonitor, FldEff_HallOfFameRecord
 	end 
 
 gFldEffScript_UseTeleport::
@@ -337,10 +337,10 @@ gFldEffScript_MoveDeoxysRock::
 	callnative FldEff_MoveDeoxysRock
 	end 
 
-gFldEffScript_Unk44::
+gFldEffScript_DestroyDeoxysRock::
-	callnative FldEff_Unk44
+	callnative FldEff_DestroyDeoxysRock
 	end 
 
-gFldEffScript_Unk45::
+gFldEffScript_PhotoFlash::
-	callnative FldEff_Unk45
+	callnative FldEff_PhotoFlash
 	end 

data/scripts/trainer_card.inc

@@ -47,7 +47,7 @@ CeladonCity_GameCorner_EventScript_PrintPhoto::
 	message CeladonCity_GameCorner_Text_BigSmileForPhoto
 	waitmessage
 	playse MUS_PHOTO
-	dofieldeffect FLDEFF_UNK_45
+	dofieldeffect FLDEFF_PHOTO_FLASH
 	delay 60
 	special UpdateTrainerCardPhotoIcons
 	msgbox CeladonCity_GameCorner_Text_PrintIsReadyCheckTrainerCard

graphics/field_effects/unk_83CAF70.pal

@@ -1,19 +0,0 @@
-JASC-PAL
-0100
-16
-115 197 164
-255 222 205
-238 180 148
-197 139 106
-106 74 74
-139 156 164
-139 156 172
-74 98 123
-49 65 82
-213 213 222
-131 16 41
-115 115 115
-213 82 90
-180 41 57
-255 255 255
-0 0 0

graphics/field_effects/unk_83CB3D0.pal

@@ -1,19 +0,0 @@
-JASC-PAL
-0100
-16
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-82 82 106
-115 255 255
-98 197 205
-90 139 156
-65 115 139

graphics/field_effects/unk_83CB7F0.pal

@@ -1,19 +0,0 @@
-JASC-PAL
-0100
-16
-0 0 0
-0 0 0
-255 255 255
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0

graphics/field_effects/unk_83CBB10.pal

@@ -1,19 +0,0 @@
-JASC-PAL
-0100
-16
-0 139 57
-0 0 0
-148 148 148
-197 197 197
-255 255 255
-123 156 230
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0
-0 0 0

include/constants/field_effects.h

@@ -32,7 +32,7 @@
 #define FLDEFF_TREE_DISGUISE             28
 #define FLDEFF_MOUNTAIN_DISGUISE         29
 #define FLDEFF_NPCFLY_OUT                30
-#define FLDEFF_USE_FLY                   31
+#define FLDEFF_FLY_OUT                   31
 #define FLDEFF_FLY_IN                    32
 #define FLDEFF_QUESTION_MARK_ICON        33
 #define FLDEFF_FEET_IN_FLOWING_WATER     34
@@ -70,7 +70,7 @@
 #define FLDEFF_DOUBLE_EXCL_MARK_ICON     66
 #define FLDEFF_MOVE_DEOXYS_ROCK          67
 #define FLDEFF_DESTROY_DEOXYS_ROCK       68
-#define FLDEFF_UNK_45                    69 // TODO: related to fame checker photos
+#define FLDEFF_PHOTO_FLASH               69
 
 #define FLDEFF_PAL_TAG_GENERAL_0          0x1004
 #define FLDEFF_PAL_TAG_GENERAL_1          0x1005

src/data/field_effects/field_effect_objects.h

@@ -1105,31 +1105,31 @@ static const struct SpriteFrameImage sPicTable_Bird[] =
     overworld_frame(gFieldEffectObjectPic_Bird, 8, 8, 4),
 };
 
-static const union AnimCmd sAnim_Bird_0[] =
+static const union AnimCmd sAnim_Bird_WithoutPlayer[] =
 {
     ANIMCMD_FRAME(0, 1),
     ANIMCMD_END,
 };
 
-static const union AnimCmd sAnim_Bird_1[] =
+static const union AnimCmd sAnim_Bird_Red_FlyOut[] =
 {
     ANIMCMD_FRAME(1, 1),
     ANIMCMD_END,
 };
 
-static const union AnimCmd sAnim_Bird_2[] =
+static const union AnimCmd sAnim_Bird_Red_FlyIn[] =
 {
     ANIMCMD_FRAME(2, 1),
     ANIMCMD_END,
 };
 
-static const union AnimCmd sAnim_Bird_3[] =
+static const union AnimCmd sAnim_Bird_Green_FlyOut[] =
 {
     ANIMCMD_FRAME(3, 1),
     ANIMCMD_END,
 };
 
-static const union AnimCmd sAnim_Bird_4[] =
+static const union AnimCmd sAnim_Bird_Green_FlyIn[] =
 {
     ANIMCMD_FRAME(4, 1),
     ANIMCMD_END,
@@ -1137,11 +1137,11 @@ static const union AnimCmd sAnim_Bird_4[] =
 
 static const union AnimCmd *const sAnimTable_Bird[] =
 {
-    sAnim_Bird_0,
+    sAnim_Bird_WithoutPlayer,
-    sAnim_Bird_1,
+    sAnim_Bird_Red_FlyOut,
-    sAnim_Bird_2,
+    sAnim_Bird_Red_FlyIn,
-    sAnim_Bird_3,
+    sAnim_Bird_Green_FlyOut,
-    sAnim_Bird_4,
+    sAnim_Bird_Green_FlyIn,
 };
 
 const struct SpriteTemplate gFieldEffectObjectTemplate_Bird =