Document TossCoin, other documentation improvements

Author: ElectroDeoxys

src/constants/animation_constants.asm

@@ -237,103 +237,103 @@ DEF NUM_SPRITE_ANIMS EQU const_value
 
 	const_def
 	; Normal animations
-	const DUEL_ANIM_NONE               ; $00
-	const DUEL_ANIM_GLOW               ; $01
-	const DUEL_ANIM_PARALYSIS          ; $02
-	const DUEL_ANIM_SLEEP              ; $03
-	const DUEL_ANIM_CONFUSION          ; $04
-	const DUEL_ANIM_POISON             ; $05
-	const DUEL_ANIM_SINGLE_HIT         ; $06
-	const DUEL_ANIM_HIT                ; $07
-	const DUEL_ANIM_BIG_HIT            ; $08
-	const DUEL_ANIM_SHOW_DAMAGE        ; $09
-	const DUEL_ANIM_THUNDER_SHOCK      ; $0a
-	const DUEL_ANIM_LIGHTNING          ; $0b
-	const DUEL_ANIM_BORDER_SPARK       ; $0c
-	const DUEL_ANIM_BIG_LIGHTNING      ; $0d
-	const DUEL_ANIM_SMALL_FLAME        ; $0e
-	const DUEL_ANIM_BIG_FLAME          ; $0f
-	const DUEL_ANIM_FIRE_SPIN          ; $10
-	const DUEL_ANIM_DIVE_BOMB          ; $11
-	const DUEL_ANIM_WATER_JETS         ; $12
-	const DUEL_ANIM_WATER_GUN          ; $13
-	const DUEL_ANIM_WHIRLPOOL          ; $14
-	const DUEL_ANIM_HYDRO_PUMP         ; $15
-	const DUEL_ANIM_BLIZZARD           ; $16
-	const DUEL_ANIM_PSYCHIC            ; $17
-	const DUEL_ANIM_LEER               ; $18
-	const DUEL_ANIM_BEAM               ; $19
-	const DUEL_ANIM_HYPER_BEAM         ; $1a
-	const DUEL_ANIM_ROCK_THROW         ; $1b
-	const DUEL_ANIM_STONE_BARRAGE      ; $1c
-	const DUEL_ANIM_PUNCH              ; $1d
-	const DUEL_ANIM_THUNDERPUNCH       ; $1e
-	const DUEL_ANIM_FIRE_PUNCH         ; $1f
-	const DUEL_ANIM_STRETCH_KICK       ; $20
-	const DUEL_ANIM_SLASH              ; $21
-	const DUEL_ANIM_WHIP               ; $22
-	const DUEL_ANIM_SONICBOOM          ; $23
-	const DUEL_ANIM_FURY_SWIPES        ; $24
-	const DUEL_ANIM_DRILL              ; $25
-	const DUEL_ANIM_POT_SMASH          ; $26
-	const DUEL_ANIM_BONEMERANG         ; $27
-	const DUEL_ANIM_SEISMIC_TOSS       ; $28
-	const DUEL_ANIM_NEEDLES            ; $29
-	const DUEL_ANIM_WHITE_GAS          ; $2a
-	const DUEL_ANIM_POWDER             ; $2b
-	const DUEL_ANIM_GOO                ; $2c
-	const DUEL_ANIM_BUBBLES            ; $2d
-	const DUEL_ANIM_STRING_SHOT        ; $2e
-	const DUEL_ANIM_BOYFRIENDS         ; $2f
-	const DUEL_ANIM_LURE               ; $30
-	const DUEL_ANIM_TOXIC              ; $31
-	const DUEL_ANIM_CONFUSE_RAY        ; $32
-	const DUEL_ANIM_SING               ; $33
-	const DUEL_ANIM_SUPERSONIC         ; $34
-	const DUEL_ANIM_PETAL_DANCE        ; $35
-	const DUEL_ANIM_PROTECT            ; $36
-	const DUEL_ANIM_BARRIER            ; $37
-	const DUEL_ANIM_SPEED              ; $38
-	const DUEL_ANIM_WHIRLWIND          ; $39
-	const DUEL_ANIM_CRY                ; $3a
-	const DUEL_ANIM_QUESTION_MARK      ; $3b
-	const DUEL_ANIM_SELFDESTRUCT       ; $3c
-	const DUEL_ANIM_BIG_SELFDESTRUCT_1 ; $3d
-	const DUEL_ANIM_HEAL               ; $3e
-	const DUEL_ANIM_DRAIN              ; $3f
-	const DUEL_ANIM_DARK_GAS           ; $40
-	const DUEL_ANIM_BIG_SELFDESTRUCT_2 ; $41
-	const DUEL_ANIM_UNUSED_42          ; $42
-	const DUEL_ANIM_UNUSED_43          ; $43
-	const DUEL_ANIM_BENCH_THUNDER      ; $44
-	const DUEL_ANIM_QUICKFREEZE        ; $45
-	const DUEL_ANIM_BENCH_GLOW         ; $46
-	const DUEL_ANIM_FIREGIVER_START    ; $47
-	const DUEL_ANIM_UNUSED_48          ; $48
-	const DUEL_ANIM_HEALING_WIND       ; $49
-	const DUEL_ANIM_BENCH_WHIRLWIND    ; $4a
-	const DUEL_ANIM_EXPAND             ; $4b
-	const DUEL_ANIM_CAT_PUNCH          ; $4c
-	const DUEL_ANIM_THUNDER_WAVE       ; $4d
-	const DUEL_ANIM_FIREGIVER_PLAYER   ; $4e
-	const DUEL_ANIM_FIREGIVER_OPP      ; $4f
-	const DUEL_ANIM_UNUSED_50          ; $50
-	const DUEL_ANIM_PLAYER_SHUFFLE     ; $51
-	const DUEL_ANIM_OPP_SHUFFLE        ; $52
-	const DUEL_ANIM_BOTH_SHUFFLE       ; $53
-	const DUEL_ANIM_UNUSED_54          ; $54
-	const DUEL_ANIM_BOTH_DRAW          ; $55
-	const DUEL_ANIM_PLAYER_DRAW        ; $56
-	const DUEL_ANIM_OPP_DRAW           ; $57
-	const DUEL_ANIM_COIN_SPIN          ; $58
-	const DUEL_ANIM_COIN_TOSS1         ; $59
-	const DUEL_ANIM_COIN_TOSS2         ; $5a
-	const DUEL_ANIM_COIN_TAILS         ; $5b
-	const DUEL_ANIM_COIN_HEADS         ; $5c
-	const DUEL_ANIM_DUEL_WIN           ; $5d
-	const DUEL_ANIM_DUEL_LOSS          ; $5e
-	const DUEL_ANIM_DUEL_DRAW          ; $5f
-	const DUEL_ANIM_UNUSED_60          ; $60
+	const DUEL_ANIM_NONE                  ; $00
+	const DUEL_ANIM_GLOW                  ; $01
+	const DUEL_ANIM_PARALYSIS             ; $02
+	const DUEL_ANIM_SLEEP                 ; $03
+	const DUEL_ANIM_CONFUSION             ; $04
+	const DUEL_ANIM_POISON                ; $05
+	const DUEL_ANIM_SINGLE_HIT            ; $06
+	const DUEL_ANIM_HIT                   ; $07
+	const DUEL_ANIM_BIG_HIT               ; $08
+	const DUEL_ANIM_SHOW_DAMAGE           ; $09
+	const DUEL_ANIM_THUNDER_SHOCK         ; $0a
+	const DUEL_ANIM_LIGHTNING             ; $0b
+	const DUEL_ANIM_BORDER_SPARK          ; $0c
+	const DUEL_ANIM_BIG_LIGHTNING         ; $0d
+	const DUEL_ANIM_SMALL_FLAME           ; $0e
+	const DUEL_ANIM_BIG_FLAME             ; $0f
+	const DUEL_ANIM_FIRE_SPIN             ; $10
+	const DUEL_ANIM_DIVE_BOMB             ; $11
+	const DUEL_ANIM_WATER_JETS            ; $12
+	const DUEL_ANIM_WATER_GUN             ; $13
+	const DUEL_ANIM_WHIRLPOOL             ; $14
+	const DUEL_ANIM_HYDRO_PUMP            ; $15
+	const DUEL_ANIM_BLIZZARD              ; $16
+	const DUEL_ANIM_PSYCHIC               ; $17
+	const DUEL_ANIM_LEER                  ; $18
+	const DUEL_ANIM_BEAM                  ; $19
+	const DUEL_ANIM_HYPER_BEAM            ; $1a
+	const DUEL_ANIM_ROCK_THROW            ; $1b
+	const DUEL_ANIM_STONE_BARRAGE         ; $1c
+	const DUEL_ANIM_PUNCH                 ; $1d
+	const DUEL_ANIM_THUNDERPUNCH          ; $1e
+	const DUEL_ANIM_FIRE_PUNCH            ; $1f
+	const DUEL_ANIM_STRETCH_KICK          ; $20
+	const DUEL_ANIM_SLASH                 ; $21
+	const DUEL_ANIM_WHIP                  ; $22
+	const DUEL_ANIM_SONICBOOM             ; $23
+	const DUEL_ANIM_FURY_SWIPES           ; $24
+	const DUEL_ANIM_DRILL                 ; $25
+	const DUEL_ANIM_POT_SMASH             ; $26
+	const DUEL_ANIM_BONEMERANG            ; $27
+	const DUEL_ANIM_SEISMIC_TOSS          ; $28
+	const DUEL_ANIM_NEEDLES               ; $29
+	const DUEL_ANIM_WHITE_GAS             ; $2a
+	const DUEL_ANIM_POWDER                ; $2b
+	const DUEL_ANIM_GOO                   ; $2c
+	const DUEL_ANIM_BUBBLES               ; $2d
+	const DUEL_ANIM_STRING_SHOT           ; $2e
+	const DUEL_ANIM_BOYFRIENDS            ; $2f
+	const DUEL_ANIM_LURE                  ; $30
+	const DUEL_ANIM_TOXIC                 ; $31
+	const DUEL_ANIM_CONFUSE_RAY           ; $32
+	const DUEL_ANIM_SING                  ; $33
+	const DUEL_ANIM_SUPERSONIC            ; $34
+	const DUEL_ANIM_PETAL_DANCE           ; $35
+	const DUEL_ANIM_PROTECT               ; $36
+	const DUEL_ANIM_BARRIER               ; $37
+	const DUEL_ANIM_SPEED                 ; $38
+	const DUEL_ANIM_WHIRLWIND             ; $39
+	const DUEL_ANIM_CRY                   ; $3a
+	const DUEL_ANIM_QUESTION_MARK         ; $3b
+	const DUEL_ANIM_SELFDESTRUCT          ; $3c
+	const DUEL_ANIM_BIG_SELFDESTRUCT_1    ; $3d
+	const DUEL_ANIM_HEAL                  ; $3e
+	const DUEL_ANIM_DRAIN                 ; $3f
+	const DUEL_ANIM_DARK_GAS              ; $40
+	const DUEL_ANIM_BIG_SELFDESTRUCT_2    ; $41
+	const DUEL_ANIM_UNUSED_42             ; $42
+	const DUEL_ANIM_UNUSED_43             ; $43
+	const DUEL_ANIM_BENCH_THUNDER         ; $44
+	const DUEL_ANIM_QUICKFREEZE           ; $45
+	const DUEL_ANIM_BENCH_GLOW            ; $46
+	const DUEL_ANIM_FIREGIVER_START       ; $47
+	const DUEL_ANIM_UNUSED_48             ; $48
+	const DUEL_ANIM_HEALING_WIND          ; $49
+	const DUEL_ANIM_BENCH_WHIRLWIND       ; $4a
+	const DUEL_ANIM_EXPAND                ; $4b
+	const DUEL_ANIM_CAT_PUNCH             ; $4c
+	const DUEL_ANIM_THUNDER_WAVE          ; $4d
+	const DUEL_ANIM_FIREGIVER_PLAYER      ; $4e
+	const DUEL_ANIM_FIREGIVER_OPP         ; $4f
+	const DUEL_ANIM_UNUSED_50             ; $50
+	const DUEL_ANIM_PLAYER_SHUFFLE        ; $51
+	const DUEL_ANIM_OPP_SHUFFLE           ; $52
+	const DUEL_ANIM_BOTH_SHUFFLE          ; $53
+	const DUEL_ANIM_UNUSED_54             ; $54
+	const DUEL_ANIM_BOTH_DRAW             ; $55
+	const DUEL_ANIM_PLAYER_DRAW           ; $56
+	const DUEL_ANIM_OPP_DRAW              ; $57
+	const DUEL_ANIM_COIN_SPIN             ; $58
+	const DUEL_ANIM_COIN_TOSS_GOING_HEADS ; $59
+	const DUEL_ANIM_COIN_TOSS_GOING_TAILS ; $5a
+	const DUEL_ANIM_COIN_TAILS            ; $5b
+	const DUEL_ANIM_COIN_HEADS            ; $5c
+	const DUEL_ANIM_DUEL_WIN              ; $5d
+	const DUEL_ANIM_DUEL_LOSS             ; $5e
+	const DUEL_ANIM_DUEL_DRAW             ; $5f
+	const DUEL_ANIM_UNUSED_60             ; $60
 
 DEF NUM_REGULAR_DUEL_ANIMS EQU const_value
 

src/constants/duel_constants.asm

@@ -5,6 +5,10 @@ DEF HP_BAR_LENGTH         EQU MAX_HP / 10
 
 DEF STARTING_HAND_SIZE EQU 7
 
+; coin result constants
+DEF TAILS EQU 0
+DEF HEADS EQU 1
+
 ; hWhoseTurn constants
 DEF PLAYER_TURN   EQUS "HIGH(wPlayerDuelVariables)"
 DEF OPPONENT_TURN EQUS "HIGH(wOpponentDuelVariables)"

src/data/duel/animations/duel_animations.asm

@@ -713,15 +713,15 @@ Animations:
 	db SFX_STOP ; sfx id
 	db NONE ; handler function
 
-	; DUEL_ANIM_COIN_TOSS1
+	; DUEL_ANIM_COIN_TOSS_GOING_HEADS
 	db SPRITE_DUEL_COIN ; sprite ID
 	db PALETTE_92 ; palette ID
 	db SPRITE_ANIM_168 ; anim ID
 	db SPRITE_ANIM_FLAG_UNSKIPPABLE | SPRITE_ANIM_FLAG_3 | SPRITE_ANIM_FLAG_CENTERED ; anim flags
 	db SFX_COIN_TOSS ; sfx id
 	db NONE ; handler function
 
-	; DUEL_ANIM_COIN_TOSS2
+	; DUEL_ANIM_COIN_TOSS_GOING_TAILS
 	db SPRITE_DUEL_COIN ; sprite ID
 	db PALETTE_92 ; palette ID
 	db SPRITE_ANIM_169 ; anim ID