@pkmn/engine 0.1.0-dev.04c4d944 → 0.1.0-dev.1336408

package/src/lib/gen1/mechanics.zig

@@ -7,8 +7,6 @@ const DEBUG = @import("../common/debug.zig").print;
 const protocol = @import("../common/protocol.zig");
 const rng = @import("../common/rng.zig");
 
-const Action = @import("chance.zig").Action;
-
 const data = @import("data.zig");
 
 const assert = std.debug.assert;
@@ -59,23 +57,15 @@ const BOOSTS = &[_][2]u8{
 
 const MAX_STAT_VALUE = 999;
 
-const DISTRIBUTION = [_]u3{ 2, 2, 2, 3, 3, 3, 4, 5 };
-
 pub fn update(battle: anytype, c1: Choice, c2: Choice, options: anytype) !Result {
-    // FIXME
-    // std.debug.print("\n", .{});
-    // DEBUG(battle.turn);
-    // std.debug.print("// ", .{});
     assert(c1.type != .Pass or c2.type != .Pass or battle.turn == 0);
     if (battle.turn == 0) return start(battle, options);
 
     var s1 = false;
     var s2 = false;
-    var f1: ?Move = null;
-    var f2: ?Move = null;
 
-    if (selectMove(battle, .P1, c1, c2, &s1, &f1)) |r| return r;
-    if (selectMove(battle, .P2, c2, c1, &s2, &f2)) |r| return r;
+    if (selectMove(battle, .P1, c1, c2, &s1)) |r| return r;
+    if (selectMove(battle, .P2, c2, c1, &s2)) |r| return r;
 
     var p1 = battle.side(.P1);
     var p2 = battle.side(.P2);
@@ -84,9 +74,9 @@ pub fn update(battle: anytype, c1: Choice, c2: Choice, options: anytype) !Result
     var r2 = showdown and p2.active.volatiles.Binding and c1.type == .Switch;
 
     if (try turnOrder(battle, c1, c2, options) == .P1) {
-        if (try doTurn(battle, .P1, c1, r1, s1, f1, .P2, c2, r2, s2, f2, options)) |r| return r;
+        if (try doTurn(battle, .P1, c1, r1, s1, .P2, c2, r2, s2, options)) |r| return r;
     } else {
-        if (try doTurn(battle, .P2, c2, r2, s2, f2, .P1, c1, r1, s1, f1, options)) |r| return r;
+        if (try doTurn(battle, .P2, c2, r2, s2, .P1, c1, r1, s1, options)) |r| return r;
     }
 
     if (p1.active.volatiles.attacks == 0) p1.active.volatiles.Binding = false;
@@ -124,7 +114,6 @@ fn selectMove(
     choice: Choice,
     foe_choice: Choice,
     skip_turn: *bool,
-    from: *?Move,
 ) ?Result {
     if (choice.type == .Pass) return null;
 
@@ -141,7 +130,6 @@ fn selectMove(
         return null;
     }
     if (volatiles.Rage) {
-        from.* = side.last_used_move;
         if (showdown) {
             if (battle.foe(player).active.volatiles.Binding) skip_turn.* = true;
             saveMove(battle, player, null);
@@ -151,7 +139,6 @@ fn selectMove(
     // Pokémon Showdown removes Flinch at the end-of-turn in its residual handler
     if (!showdown) volatiles.Flinch = false;
     if (volatiles.Thrashing or volatiles.Charging) {
-        from.* = side.last_selected_move;
         if (showdown) {
             if (battle.foe(player).active.volatiles.Binding) skip_turn.* = true;
             saveMove(battle, player, null);
@@ -172,9 +159,7 @@ fn selectMove(
         return null;
     }
     if (volatiles.Binding) {
-        from.* = side.last_used_move;
         if (showdown) {
-            if (foe_choice.type == .Switch) from.* = null;
             // Pokémon Showdown overwrites Mirror Move with whatever was selected - really this
             // should set side.last_selected_move = last.id to reuse Mirror Move and fail in order
             // to satisfy the conditions of the Desync Clause Mod. However, because Binding is still
@@ -214,12 +199,9 @@ fn selectMove(
             }
             break :ok true;
         };
-
         assert(struggle);
-        saveMove(battle, player, choice);
-    } else {
-        saveMove(battle, player, choice);
     }
+    saveMove(battle, player, choice);
 
     return null;
 }
@@ -343,12 +325,10 @@ fn doTurn(
     player_choice: Choice,
     player_rewrap: bool,
     player_skip: bool,
-    player_from: ?Move,
     foe_player: Player,
     foe_choice: Choice,
     foe_rewrap: bool,
     foe_skip: bool,
-    foe_from: ?Move,
     options: anytype,
 ) !?Result {
     assert(player_choice.type != .Pass);
@@ -361,7 +341,6 @@ fn doTurn(
         player_choice,
         player_rewrap,
         player_skip,
-        player_from,
         &residual,
         options,
     )) |r| return r;
@@ -384,7 +363,6 @@ fn doTurn(
         foe_choice,
         foe_rewrap,
         foe_skip,
-        foe_from,
         &residual,
         options,
     )) |r| return r;
@@ -412,7 +390,6 @@ fn executeMove(
     choice: Choice,
     rewrap: bool,
     skip: bool,
-    from: ?Move,
     residual: *bool,
     options: anytype,
 ) !?Result {
@@ -447,8 +424,10 @@ fn executeMove(
         mslot = @intCast(battle.lastMove(player).index);
         const stored = side.stored();
         // GLITCH: Struggle bypass PP underflow via Hyper Beam / Trapping-switch auto selection
-        auto = side.last_selected_move == .HyperBeam or side.active.volatiles.Bide or
-            from != null or Status.is(stored.status, .FRZ) or Status.is(stored.status, .SLP);
+        auto = isForced(&side.active) or
+            side.active.volatiles.Binding or side.active.volatiles.Bide or
+            side.last_selected_move == .HyperBeam or
+            Status.is(stored.status, .FRZ) or Status.is(stored.status, .SLP);
         // If it wasn't Hyper Beam or the continuation of a move effect then we must have just
         // thawed, in which case we will desync unless the last_selected_move happened to be at
         // index 1 and the current Pokémon has the same move in its first slot.
@@ -470,7 +449,7 @@ fn executeMove(
 
     var skip_can = false;
     var skip_pp = false;
-    switch (try beforeMove(battle, player, skip, from, residual, options)) {
+    switch (try beforeMove(battle, player, skip, residual, options)) {
         .done => return null,
         .skip_can => skip_can = true,
         .skip_pp => skip_pp = true,
@@ -478,9 +457,9 @@ fn executeMove(
         .err => return @as(?Result, Result.Error),
     }
 
-    if (!skip_can and !try canMove(battle, player, mslot, auto, skip_pp, from, residual, options)) {
-        return null;
-    }
+    const can = skip_can or
+        try canMove(battle, player, mslot, auto, skip_pp, .None, residual, options);
+    if (!can) return null;
 
     return doMove(battle, player, mslot, rewrap, auto, residual, options);
 }
@@ -491,7 +470,6 @@ fn beforeMove(
     battle: anytype,
     player: Player,
     skip: bool,
-    from: ?Move,
     residual: *bool,
     options: anytype,
 ) !BeforeMove {
@@ -698,7 +676,6 @@ fn beforeMove(
 
     if (volatiles.Thrashing) {
         assert(volatiles.attacks > 0);
-        assert(from != null);
 
         if (options.calc.modify(player, .attacking)) |extend| {
             if (!extend) volatiles.attacks = 0;
@@ -710,7 +687,7 @@ fn beforeMove(
         if (!showdown and handleThrashing(battle, active, player, options)) {
             try log.start(battle.active(player), .ConfusionSilent);
         }
-        try log.move(ident, side.last_selected_move, battle.active(player.foe()), from);
+        try log.move(ident, side.last_selected_move, battle.active(player.foe()));
         if (showdown) {
             // This shouldn't actually set last_used_move, but Pokémon Showdown sets last
             // used in useMove and doesn't have the notion of skipping canMove semantics
@@ -732,12 +709,7 @@ fn beforeMove(
         }
         try options.chance.binding(player, volatiles.attacks);
 
-        try log.move(
-            battle.active(player),
-            side.last_selected_move,
-            battle.active(player.foe()),
-            side.last_selected_move,
-        );
+        try log.move(battle.active(player), side.last_selected_move, battle.active(player.foe()));
         if (showdown or battle.last_damage != 0) {
             const sub = showdown and foe.active.volatiles.Substitute;
             _ = try applyDamage(battle, player.foe(), player.foe(), .None, options);
@@ -757,7 +729,7 @@ fn canMove(
     mslot: u4,
     auto: bool,
     skip_pp: bool,
-    from: ?Move,
+    from: Move,
     residual: *bool,
     options: anytype,
 ) !bool {
@@ -765,33 +737,22 @@ fn canMove(
     const player_ident = battle.active(player);
     const move = Move.get(side.last_selected_move);
 
-    const foe_last = battle.foe(player).last_used_move;
-    const special = from != null and (from.? == .Metronome and
-        (from.? == .MirrorMove and !(foe_last == .None or foe_last == .MirrorMove)));
-
     var skip = skip_pp;
     if (side.active.volatiles.Charging) {
         side.active.volatiles.Charging = false;
         side.active.volatiles.Invulnerable = false;
     } else if (move.effect == .Charge) {
-        try options.log.move(player_ident, side.last_selected_move, .{}, from);
+        try options.log.moveFrom(player_ident, side.last_selected_move, .{}, from);
         setCounterable(battle, player, side, move);
         try Effects.charge(battle, player, options);
         return false;
     }
 
-    if (!showdown or !special) side.last_used_move = side.last_selected_move;
+    side.last_used_move = side.last_selected_move;
     if (!skip) decrementPP(side, mslot, auto);
 
     const target = if (move.target == .Self) player else player.foe();
-    // Pokémon Showdown's protocol for Rage and Binding moves should come with a [from], though we
-    // don't have space to be able to track it in all circumstances and thus usually try to infer it
-    // from side.last_used_move. However, this gets reset by the opponent switching or fainting,
-    // meaning sometimes we lose this information. from is still set because it not being null is
-    // relevant for control flow, but we don't have anything useful to put in the log. This is
-    // regrettable, but this information is more "nice to have" than required
-    const f = if (from != null and from.? == .None) null else from;
-    try options.log.move(player_ident, side.last_selected_move, battle.active(target), f);
+    try options.log.moveFrom(player_ident, side.last_selected_move, battle.active(target), from);
     setCounterable(battle, player, side, move);
 
     if (move.effect.onBegin()) {
@@ -1438,7 +1399,7 @@ fn moveHit(
         const overwritten = overwrite and state > 0;
         assert(!overwritten or (0 < state and state <= 255 and !side.active.volatiles.Bide));
 
-        var accuracy = if (overwritten) state else @as(u16, Gen12.percent(move.accuracy));
+        var accuracy = if (overwritten) state else @as(u16, move.accuracy);
         var boost = BOOSTS[@as(u4, @intCast(@as(i8, side.active.boosts.accuracy) + 6))];
         accuracy = accuracy * boost[0] / boost[1];
         boost = BOOSTS[@as(u4, @intCast(@as(i8, -foe.active.boosts.evasion) + 6))];
@@ -1499,8 +1460,8 @@ fn checkFaint(
     }
 
     const foe_choice: Choice.Type = if (foe_fainted) .Switch else .Pass;
-    if (player == .P1) return Result{ .p1 = .Switch, .p2 = foe_choice };
-    return Result{ .p1 = foe_choice, .p2 = .Switch };
+    if (player == .P1) return .{ .p1 = .Switch, .p2 = foe_choice };
+    return .{ .p1 = foe_choice, .p2 = .Switch };
 }
 
 fn faint(battle: anytype, player: Player, done: bool, options: anytype) !?Result {
@@ -1548,21 +1509,19 @@ fn handleResidual(battle: anytype, player: Player, options: anytype) !void {
     var volatiles = &side.active.volatiles;
 
     const brn = Status.is(stored.status, .BRN);
-    if (brn or Status.is(stored.status, .PSN)) blk: {
+    if (brn or Status.is(stored.status, .PSN)) {
         var damage = @max(stored.stats.hp / 16, 1);
-
         if (volatiles.Toxic) {
             volatiles.toxic += 1;
             damage *= volatiles.toxic;
         }
+        damage = @min(damage, stored.hp);
 
-        const amount = @min(damage, stored.hp);
-        if (showdown and amount == 0) break :blk;
-
-        stored.hp -= amount;
-
-        // Pokémon Showdown uses damageOf here but its not relevant in Generation I
-        try options.log.damage(ident, stored, if (brn) Damage.Burn else Damage.Poison);
+        if (!showdown or damage > 0) {
+            stored.hp -= damage;
+            // Pokémon Showdown uses damageOf here but its not relevant in Generation I
+            try options.log.damage(ident, stored, if (brn) Damage.Burn else Damage.Poison);
+        }
     }
 
     if (volatiles.LeechSeed) {
@@ -2395,12 +2354,17 @@ pub const Effects = struct {
     }
 
     fn switchAndTeleport(battle: anytype, player: Player, move: Move.Data, options: anytype) !void {
-        if (!showdown or battle.side(player).last_selected_move == .Teleport) return;
-
         // Whirlwind/Roar should not roll to hit/reset damage but Pokémon Showdown does anyway
-        if (try checkHit(battle, player, move, options)) try options.chance.commit(player, .hit);
-
-        battle.last_damage = 0;
+        if (showdown) {
+            if (battle.side(player).last_selected_move == .Teleport) return;
+            if (try checkHit(battle, player, move, options)) {
+                try options.chance.commit(player, .hit);
+            }
+            battle.last_damage = 0;
+        } else {
+            try options.log.fail(battle.active(player), .None);
+            try options.log.laststill();
+        }
     }
 
     fn thrashing(battle: anytype, player: Player, options: anytype) void {
@@ -2705,15 +2669,15 @@ fn clearVolatiles(battle: anytype, who: Player, clear: bool, options: anytype) !
     }
     if (volatiles.Mist) {
         volatiles.Mist = false;
-        try log.end(ident, .Mist);
+        try log.end(ident, .MistSilent);
     }
     if (volatiles.FocusEnergy) {
         volatiles.FocusEnergy = false;
-        try log.end(ident, .FocusEnergy);
+        try log.end(ident, .FocusEnergySilent);
     }
     if (volatiles.LeechSeed) {
         volatiles.LeechSeed = false;
-        try log.end(ident, .LeechSeed);
+        try log.end(ident, .LeechSeedSilent);
     }
     if (!showdown and volatiles.Toxic) {
         volatiles.Toxic = false;
@@ -2721,17 +2685,17 @@ fn clearVolatiles(battle: anytype, who: Player, clear: bool, options: anytype) !
     }
     if (volatiles.LightScreen) {
         volatiles.LightScreen = false;
-        try log.end(ident, .LightScreen);
+        try log.end(ident, .LightScreenSilent);
     }
     if (volatiles.Reflect) {
         volatiles.Reflect = false;
-        try log.end(ident, .Reflect);
+        try log.end(ident, .ReflectSilent);
     }
     if (showdown and volatiles.Toxic) {
         volatiles.Toxic = false;
         // Pokémon Showdown erroneously clears the toxic counter
         volatiles.toxic = 0;
-        try log.end(ident, .Toxic);
+        try log.end(ident, .ToxicSilent);
     }
 }
 
@@ -2867,11 +2831,9 @@ pub const Rolls = struct {
     inline fn metronome(battle: anytype, player: Player, options: anytype) !Move {
         const move: Move = if (options.calc.overridden(player, .metronome)) |val|
             val
-        else if (showdown) move: {
-            const r = battle.rng.range(u8, 0, @intFromEnum(Move.Struggle) - 2);
-            const mod = @as(u2, (if (r < @intFromEnum(Move.Metronome) - 1) 1 else 2));
-            break :move @enumFromInt(r + mod);
-        } else move: {
+        else if (showdown)
+            Move.METRONOME[battle.rng.range(u8, 0, Move.METRONOME.len)]
+        else move: {
             while (true) {
                 const r = battle.rng.next();
                 if (r == 0 or r == @intFromEnum(Move.Metronome)) continue;
@@ -2905,7 +2867,7 @@ pub const Rolls = struct {
         const duration: u3 = if (options.calc.overridden(player, .duration)) |val|
             @intCast(val)
         else if (showdown)
-            @intCast(battle.rng.range(u8, 1, 8))
+            battle.rng.range(u3, 1, 8)
         else duration: {
             while (true) {
                 const r = battle.rng.next() & 7;
@@ -2922,7 +2884,7 @@ pub const Rolls = struct {
         const duration: u4 = if (options.calc.overridden(player, .duration)) |val|
             val
         else if (showdown)
-            @intCast(battle.rng.range(u8, 1, 9))
+            battle.rng.range(u4, 1, 9)
         else
             @intCast((battle.rng.next() & 7) + 1);
 
@@ -2935,7 +2897,7 @@ pub const Rolls = struct {
         const duration: u3 = if (options.calc.overridden(player, .duration)) |val|
             @intCast(val)
         else if (showdown)
-            @intCast(battle.rng.range(u8, 2, 6))
+            battle.rng.range(u3, 2, 6)
         else
             @intCast((battle.rng.next() & 3) + 2);
 
@@ -2948,7 +2910,7 @@ pub const Rolls = struct {
         const duration: u3 = if (options.calc.overridden(player, .duration)) |val|
             @intCast(val)
         else if (showdown)
-            @intCast(battle.rng.range(u4, 2, 4))
+            battle.rng.range(u3, 2, 4)
         else
             @intCast((battle.rng.next() & 1) + 2);
 
@@ -2957,6 +2919,8 @@ pub const Rolls = struct {
         return duration;
     }
 
+    const DISTRIBUTION = [_]u3{ 2, 2, 2, 3, 3, 3, 4, 5 };
+
     inline fn distribution(
         battle: anytype,
         comptime effect: Move.Effect,
@@ -2967,7 +2931,7 @@ pub const Rolls = struct {
         const n: u3 = if (options.calc.overridden(player, roll)) |val|
             @intCast(val)
         else if (showdown)
-            DISTRIBUTION[battle.rng.range(u8, 0, DISTRIBUTION.len)]
+            DISTRIBUTION[battle.rng.range(u3, 0, DISTRIBUTION.len)]
         else n: {
             const r = (battle.rng.next() & 3);
             break :n @intCast((if (r < 2) r else battle.rng.next() & 3) + 2);
@@ -3014,10 +2978,9 @@ pub const Rolls = struct {
                     while (i < moves.len and r > 0) : (i += 1) {
                         if (moves[i].pp > 0) {
                             r -= 1;
-                            if (r == 0) break;
+                            if (r == 0) break :slot @intCast(i + 1);
                         }
                     }
-                    break :slot @intCast(i + 1);
                 }
             }
 
@@ -3039,11 +3002,11 @@ test "RNG agreement" {
         expected[i] = @intCast(i * 0x1000000);
     }
 
-    var spe = rng.FixedRNG(1, expected.len){ .rolls = expected };
-    var cfz = rng.FixedRNG(1, expected.len){ .rolls = expected };
-    var par = rng.FixedRNG(1, expected.len){ .rolls = expected };
-    var brn = rng.FixedRNG(1, expected.len){ .rolls = expected };
-    var eff = rng.FixedRNG(1, expected.len){ .rolls = expected };
+    var spe: rng.FixedRNG(1, expected.len) = .{ .rolls = expected };
+    var cfz: rng.FixedRNG(1, expected.len) = .{ .rolls = expected };
+    var par: rng.FixedRNG(1, expected.len) = .{ .rolls = expected };
+    var brn: rng.FixedRNG(1, expected.len) = .{ .rolls = expected };
+    var eff: rng.FixedRNG(1, expected.len) = .{ .rolls = expected };
 
     for (0..expected.len) |i| {
         try expectEqual(spe.range(u8, 0, 2) == 0, i < Gen12.percent(50) + 1);

package/src/lib/gen2/README.md

@@ -32,25 +32,27 @@ The following information is required to simulate a Generation II Pokémon battl
 | `pokemon.species`              | `party_struct.Species`            | `pokemon.baseSpecies`                 |
 | `active.species`               | `battle_struct.Species`           | `pokemon.species`                     |
 | `active.stats`                 | `TODO modified`                   | `pokemon.storedStats`                 |
-| `active.trapped FIXME`         | `PlayerTrappingMove`              | `pokemon.trapped`                     |
-| `active.switching`             | `PlayerIsSwitching`               | `pokemon.switchFlag`                  |
 | `active.boosts`                | `PlayerStatLevels`                | `pokemon.boosts`                      |
 | `active.volatiles`             | `PlayerBattleStatus{1,2,3}`       | `pokemon.volatiles`                   |
-| `volatiles.data.bide`          | `PlayerDamageTaken`               | `volatiles.bide.totalDamage`          |
-| `volatiles.data.substitute`    | `PlayerSubstituteHP`              | `volatiles.substitute.hp`             |
-| `volatiles.data.rollout`       | `PlayerRolloutCount`              | `volatiles.rollout.hitCount`          |
-| `volatiles.data.confusion`     | `PlayerConfuseCount`              | `volatiles.confusion.duration`        |
-| `volatiles.data.toxic`         | `PlayerToxicCount`                | `volatiles.residualdmg.counter`       |
-| `volatiles.data.disabled`      | `PlayerDisableCount`              | `moveSlots.disabled`                  |
-| `volatiles.data.encore`        | `PlayerEncoreCount`               | `volatiles.encore.duration`           |
-| `volatiles.data.perish_song`   | `PlayerPerishCount`               | `volatiles.perishsong.duration`       |
-| `volatiles.data.fury_cutter`   | `PlayerFuryCutterCount`           | `volatiles.furycutter.multiplier`     |
-| `volatiles.data.protect`       | `PlayerProtectCount`              | `volatiles.stall.counter`             |
-| `volatiles.data.future_sight`  | `PlayerFutureSight{Damage,Count}` | `slotConditions[i].futuremove`        |
-| `volatiles.data.rage`          | `PlayerRageCounter`               | **BUG**                               |
-| `volatiles.data.bind`          | `PlayerWrapCount`                 | `volatiles.partiallytrapped.duration` |
+| `volatiles.bide`               | `PlayerDamageTaken`               | `volatiles.bide.totalDamage`          |
+| `volatiles.substitute`         | `PlayerSubstituteHP`              | `volatiles.substitute.hp`             |
+| `volatiles.rollout`            | `PlayerRolloutCount`              | `volatiles.rollout.hitCount`          |
+| `volatiles.confusion`          | `PlayerConfuseCount`              | `volatiles.confusion.duration`        |
+| `volatiles.toxic`              | `PlayerToxicCount`                | `volatiles.residualdmg.counter`       |
+| `volatiles.disabled`           | `PlayerDisableCount`              | `moveSlots.disabled`                  |
+| `volatiles.encore`             | `PlayerEncoreCount`               | `volatiles.encore.duration`           |
+| `volatiles.perish_song`        | `PlayerPerishCount`               | `volatiles.perishsong.duration`       |
+| `volatiles.fury_cutter`        | `PlayerFuryCutterCount`           | `volatiles.furycutter.multiplier`     |
+| `volatiles.protect`            | `PlayerProtectCount`              | `volatiles.stall.counter`             |
+| `volatiles.future_sight`       | `PlayerFutureSight{Damage,Count}` | `slotConditions[i].futuremove`        |
+| `volatiles.rage`               | `PlayerRageCounter`               | **BUG**                               |
+| `volatiles.bind`               | `PlayerWrapCount`                 | `volatiles.partiallytrapped.duration` |
+| `volatiles.bind_reason`        | `PlayerTrappingMove`              | `volatiles.effectState.sourceEffect`  |
 |                                | `PlayerCharging`                  |                                       |
-|                                | `PlayerJustGotFrozen`             |                                       |
+| `volatiles.trapped FIXME`      | `FIXME`                           | `pokemon.trapped`                     |
+| `volatiles.switched`           | `TODO`                            | `pokemon.switchFlag`                  |
+| `volatiles.switching`          | `PlayerIsSwitching`               | `pokemon.switchFlag`                  |
+| `volatiles.frozen`             | `PlayerJustGotFrozen`             | `volatiles.frozen`                    |
 |                                |                                   |                                       |
 | `active.last_used_move`        | `PlayerUsedMove`                  | `side.lastMove`                       |
 
@@ -219,6 +221,81 @@ much overhead the preceding representations have after taking into consideration
 padding](https://en.wikipedia.org/wiki/Data_structure_alignment) and
 [denormalization](https://en.wikipedia.org/wiki/Denormalization):
 
+## Details
+
+| pkmn                      | Pokémon Crystal (pret)                            |
+| ------------------------- | ------------------------------------------------- |
+| `start`                   | `DoBattle`                                        |
+| `update`                  | `BattleTurn`                                      |
+| `selectMove` / `saveMove` | `CheckPlayerLockedIn` / `ParsePlayerAction`       |
+| `switchIn`                | `SwitchPlayerMon` / `SendOutPlayerMon`            |
+| `turnOrder`               | `DetermineMoveOrder`                              |
+| `doTurn`                  | `DoTurn`                                          |
+| `executeMove`             | `DoMove`                                          |
+| `beforeMove`              | `CheckTurn`                                       |
+| `canMove`                 |                                                   |
+| `decrementPP`             |                                                   |
+| `doMove`                  |                                                   |
+| `checkCriticalHit`        | `BattleCommand_Critical`                          |
+| `calcDamage`              | `BattleCommand_DamageCalc` / `PlayerAttackDamage` |
+| `adjustDamage`            | `BattleCommand_Stab`                              |
+| `randomizeDamage`         | `BattleCommand_DamageVariation`                   |
+| `specialDamage`           | `BattleCommand_ConstantDamage`                    |
+| `applyDamage`             | `BattleCommand_ApplyDamage`                       |
+| `checkHit`                | `BattleCommand_CheckHit`                          |
+| `checkFaint`              | `CheckFaint`                                      |
+| `handleResidual`          | `ResidualDamage`                                  |
+| `endTurn`                 | `EndTurn`                                         |
+
+DoBattle
+BattleTurn
+- HandleBerserkGene
+- CheckPlayerLockedIn
+- BattleMenu
+- ParsePlayerAction
+- DetermineMoveOrder
+  - CompareMovePriority
+  - GetMovePriority
+- Battle_*
+  - Handle*Switch
+    - SwitchPlayerMon
+      - BreakAttraction
+      - SendOutPlayerMon
+    - SpikesDamage
+  - *Turn_EndOpponentProtectEndureDestinyBond
+    - EndUserDestinyBond
+    - Do*Turn
+    - EndOpponentProtectEndureDestinyBond
+  - ResidualDamage
+  - CheckFaint_*
+  - HandleBetweenTurnEffects
+    - HandleFutureSight
+    - HandleWeather
+    - HandleWrap
+    - HandlePerishSong
+    - HandleLeftovers
+    - HandleMysteryBerry
+    - HandleDefrost
+    - HandleSafeguard
+    - HandleScreens
+    - HandleStatBoostingHeldItems
+    - HandleHealingItems
+    - HandleEncore
+
+DoTurn
+DoMove = executeMove
+CheckTurn = beforeMove
+BattleCommand_Critical = checkCriticalHit
+BattleCommand_Stab = adjustDamage
+BattleCommand_DamageVariation = randomizeDamage
+BattleCommand_CheckHit = checkHit
+BattleCommand_ApplyDamage = applyDamage
+BattleCommand_CheckFaint
+BattleCommand_BuildOpponentRage = buildRage
+BattleCommand_DamageCalc (PlayerAttackDamage / EnemyAttackDamage) = calcDamage
+BattleCommand_ConstantDamage = specialDamage
+DoEnemyDamage / DoPlayerDamage / DoSubstituteDamage
+
 ==**TODO**==
 
 ## Protocol
@@ -226,62 +303,7 @@ padding](https://en.wikipedia.org/wiki/Data_structure_alignment) and
 TODO
 
 ```txt
--activate: _, damage, move, name, number, of
--anim: _
--block: _
--boost: _, from, silent
--clearallboost: _
--copyboost: from
--crit: _
--curestatus: msg
--cureteam: from
--damage: _, from, of, partiallytrapped
--end: _, from, of, partiallytrapped, silent
--enditem: _, eat
--fail: _, block, weak
--fieldactivate: _
--heal: _, from, of, silent
--hint: _
--hitcount: _
--immune: _, ohko
--item: from, of
--miss: _
--mustrecharge: _
--ohko: _
--prepare: _
--resisted: _
--setboost: from
--sethp: from, silent
--sideend: _, from, of
--sidestart: _
--singlemove: _
--singleturn: _
--start: _, of, silent
--status: _, from, silent
--supereffective: _
--transform: _
--unboost: _
--weather: _, upkeep
-cant: _
-debug: _
-done: _
-drag: _
-faint: _
-gametype: _
-gen: _
-move: _, from, miss, still
-player: _
-request: _
-rule: _
-start: _
-switch: _, from
-t:: _
-teamsize: _
-tie: _
-tier: _
-turn: _
-upkeep: _
-win: _
+-activate: _,  move, name, number
 ```
 
 ## Bugs