Document battle animation scripts.

5 files changed, 55 insertions, 42 deletions

diff --git a/asm/battle_anim_80A5C6C.s b/asm/battle_anim_80A5C6C.s
index 44ba33c08..a0fb859d4 100644
--- a/asm/battle_anim_80A5C6C.s
+++ b/asm/battle_anim_80A5C6C.s
@@ -4802,8 +4802,8 @@ _080A8136:
 	.pool
 	thumb_func_end sub_80A80C8
 
-	thumb_func_start sub_80A8140
-sub_80A8140: @ 80A8140
+	thumb_func_start AnimTask_GetHappinessPowerLevel
+AnimTask_GetHappinessPowerLevel: @ 80A8140
 	push {lr}
 	lsls r0, 24
 	lsrs r2, r0, 24
@@ -4827,7 +4827,7 @@ _080A815E:
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_80A8140
+	thumb_func_end AnimTask_GetHappinessPowerLevel
 
 	thumb_func_start sub_80A8174
 sub_80A8174: @ 80A8174
diff --git a/asm/battle_anim_80FE840.s b/asm/battle_anim_80FE840.s
index f5b9697af..cfeb8d8d4 100644
--- a/asm/battle_anim_80FE840.s
+++ b/asm/battle_anim_80FE840.s
@@ -17049,8 +17049,8 @@ _08107118:
 	.pool
 	thumb_func_end sub_81070AC
 
-	thumb_func_start sub_8107144
-sub_8107144: @ 8107144
+	thumb_func_start AnimTask_IsFuryCutterHitRight
+AnimTask_IsFuryCutterHitRight: @ 8107144
 	push {lr}
 	lsls r0, 24
 	lsrs r0, 24
@@ -17065,10 +17065,10 @@ sub_8107144: @ 8107144
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_8107144
+	thumb_func_end AnimTask_IsFuryCutterHitRight
 
-	thumb_func_start sub_8107168
-sub_8107168: @ 8107168
+	thumb_func_start AnimTask_GetFuryCutterHitCount
+AnimTask_GetFuryCutterHitCount: @ 8107168
 	push {lr}
 	lsls r0, 24
 	lsrs r0, 24
@@ -17081,7 +17081,7 @@ sub_8107168: @ 8107168
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_8107168
+	thumb_func_end AnimTask_GetFuryCutterHitCount
 
 	thumb_func_start sub_8107188
 sub_8107188: @ 8107188
@@ -28522,8 +28522,8 @@ _0810CDF6:
 	bx r0
 	thumb_func_end sub_810CDB0
 
-	thumb_func_start sub_810CDFC
-sub_810CDFC: @ 810CDFC
+	thumb_func_start AnimTask_GetRolloutCounter
+AnimTask_GetRolloutCounter: @ 810CDFC
 	push {lr}
 	lsls r0, 24
 	lsrs r0, 24
@@ -28544,7 +28544,7 @@ sub_810CDFC: @ 810CDFC
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_810CDFC
+	thumb_func_end AnimTask_GetRolloutCounter
 
 	thumb_func_start unc_080B08A0
 unc_080B08A0: @ 810CE2C
@@ -45184,8 +45184,8 @@ _081155F4:
 	.pool
 	thumb_func_end sub_8115588
 
-	thumb_func_start sub_8115600
-sub_8115600: @ 8115600
+	thumb_func_start AnimTask_IsPowerOver99
+AnimTask_IsPowerOver99: @ 8115600
 	push {lr}
 	lsls r0, 24
 	lsrs r1, r0, 24
@@ -45203,7 +45203,7 @@ _08115614:
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_8115600
+	thumb_func_end AnimTask_IsPowerOver99
 
 	thumb_func_start sub_8115628
 sub_8115628: @ 8115628
@@ -49190,8 +49190,8 @@ _0811773E:
 	.pool
 	thumb_func_end sub_81176D8
 
-	thumb_func_start sub_8117754
-sub_8117754: @ 8117754
+	thumb_func_start AnimTask_IsAttackerOpponentSide
+AnimTask_IsAttackerOpponentSide: @ 8117754
 	push {r4,lr}
 	adds r4, r0, 0
 	lsls r4, 24
@@ -49209,10 +49209,10 @@ sub_8117754: @ 8117754
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_8117754
+	thumb_func_end AnimTask_IsAttackerOpponentSide
 
-	thumb_func_start sub_8117780
-sub_8117780: @ 8117780
+	thumb_func_start AnimTask_IsTargetOpponentSide
+AnimTask_IsTargetOpponentSide: @ 8117780
 	push {r4,lr}
 	adds r4, r0, 0
 	lsls r4, 24
@@ -49230,10 +49230,10 @@ sub_8117780: @ 8117780
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_8117780
+	thumb_func_end AnimTask_IsTargetOpponentSide
 
-	thumb_func_start sub_81177AC
-sub_81177AC: @ 81177AC
+	thumb_func_start AnimTask_IsTargetPartner
+AnimTask_IsTargetPartner: @ 81177AC
 	push {r4,r5,lr}
 	lsls r0, 24
 	lsrs r3, r0, 24
@@ -49256,7 +49256,7 @@ _081177C8:
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_81177AC
+	thumb_func_end AnimTask_IsTargetPartner
 
 	thumb_func_start sub_81177E4
 sub_81177E4: @ 81177E4
@@ -50032,8 +50032,8 @@ _08117E34:
 	.pool
 	thumb_func_end sub_8117DD8
 
-	thumb_func_start sub_8117E60
-sub_8117E60: @ 8117E60
+	thumb_func_start AnimTask_IsContest
+AnimTask_IsContest: @ 8117E60
 	push {r4,lr}
 	lsls r0, 24
 	lsrs r4, r0, 24
@@ -50057,7 +50057,7 @@ _08117E84:
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_8117E60
+	thumb_func_end AnimTask_IsContest
 
 	thumb_func_start sub_8117E94
 sub_8117E94: @ 8117E94
diff --git a/asm/battle_anim_815A0D4.s b/asm/battle_anim_815A0D4.s
index 6b894a0f1..b49a591bb 100644
--- a/asm/battle_anim_815A0D4.s
+++ b/asm/battle_anim_815A0D4.s
@@ -1012,8 +1012,8 @@ _0815A8C2:
 	bx r0
 	thumb_func_end sub_815A8AC
 
-	thumb_func_start sub_815A8C8
-sub_815A8C8: @ 815A8C8
+	thumb_func_start AnimTask_IsTargetPlayerSide
+AnimTask_IsTargetPlayerSide: @ 815A8C8
 	push {r4,lr}
 	lsls r0, 24
 	lsrs r4, r0, 24
@@ -1039,10 +1039,10 @@ _0815A8F0:
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_815A8C8
+	thumb_func_end AnimTask_IsTargetPlayerSide
 
-	thumb_func_start sub_815A904
-sub_815A904: @ 815A904
+	thumb_func_start AnimTask_IsHealingMove
+AnimTask_IsHealingMove: @ 815A904
 	push {lr}
 	lsls r0, 24
 	lsrs r2, r0, 24
@@ -1064,7 +1064,7 @@ _0815A924:
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_815A904
+	thumb_func_end AnimTask_IsHealingMove
 
 	thumb_func_start sub_815A934
 sub_815A934: @ 815A934
@@ -10861,8 +10861,8 @@ _0815F896:
 	.pool
 	thumb_func_end sub_815F7C4
 
-	thumb_func_start sub_815F8A0
-sub_815F8A0: @ 815F8A0
+	thumb_func_start AnimTask_GetHappinessPowerLevel2
+AnimTask_GetHappinessPowerLevel2: @ 815F8A0
 	push {r4,lr}
 	lsls r0, 24
 	lsrs r4, r0, 24
@@ -10904,7 +10904,7 @@ _0815F8E0:
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_815F8A0
+	thumb_func_end AnimTask_GetHappinessPowerLevel2
 
 	thumb_func_start sub_815F8F4
 sub_815F8F4: @ 815F8F4
@@ -12336,8 +12336,8 @@ _081604E8:
 	bx r0
 	thumb_func_end sub_81603F4
 
-	thumb_func_start sub_81604F0
-sub_81604F0: @ 81604F0
+	thumb_func_start AnimTask_GetWeather
+AnimTask_GetWeather: @ 81604F0
 	push {lr}
 	lsls r0, 24
 	lsrs r3, r0, 24
@@ -12380,7 +12380,7 @@ _08160538:
 	bl DestroyAnimVisualTask
 	pop {r0}
 	bx r0
-	thumb_func_end sub_81604F0
+	thumb_func_end AnimTask_GetWeather
 
 	thumb_func_start sub_8160544
 sub_8160544: @ 8160544
diff --git a/asm/battle_anim_8170478.s b/asm/battle_anim_8170478.s
index ef7e609d9..4288d4eb8 100644
--- a/asm/battle_anim_8170478.s
+++ b/asm/battle_anim_8170478.s
@@ -1030,8 +1030,8 @@ sub_8170D24: @ 8170D24
 	.pool
 	thumb_func_end sub_8170D24
 
-	thumb_func_start sub_8170D4C
-sub_8170D4C: @ 8170D4C
+	thumb_func_start AnimTask_IsBallBlockedByTrainer
+AnimTask_IsBallBlockedByTrainer: @ 8170D4C
 	push {lr}
 	lsls r0, 24
 	lsrs r2, r0, 24
@@ -1055,7 +1055,7 @@ _08170D74:
 	pop {r0}
 	bx r0
 	.pool
-	thumb_func_end sub_8170D4C
+	thumb_func_end AnimTask_IsBallBlockedByTrainer
 
 	thumb_func_start ItemIdToBallId
 ItemIdToBallId: @ 8170D84
diff --git a/asm/macros/battle_anim_script.inc b/asm/macros/battle_anim_script.inc
index d1a8f6656..2b7501734 100644
--- a/asm/macros/battle_anim_script.inc
+++ b/asm/macros/battle_anim_script.inc
@@ -266,3 +266,16 @@
 	.macro stopsound
 	.byte 0x2f
 	.endm
+	
+@ useful macros
+	.macro jumpreteq value, ptr
+	jumpargeq ARG_RET_ID, \value, \ptr
+	.endm
+	
+	.macro jumprettrue ptr
+	jumpreteq TRUE, \ptr
+	.endm
+	
+	.macro jumpretfalse ptr
+	jumpreteq FALSE, \ptr
+	.endm