@pkmn/engine 0.1.0-dev.b9fb6eab → 0.1.0-dev.cf6f5d2c

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,7 +7,7 @@ const options = @import("./options.zig");
7
7
  const assert = std.debug.assert;
8
8
  const print = std.debug.print;
9
9
 
10
- const trace = options.trace;
10
+ const enabled = options.log;
11
11
 
12
12
  const Player = data.Player;
13
13
  const ID = data.ID;
@@ -230,7 +230,7 @@ pub fn Log(comptime Writer: type) type {
230
230
  pub const Error = Writer.Error;
231
231
 
232
232
  pub fn move(self: Self, source: ID, m: anytype, target: ID, from: anytype) Error!void {
233
- if (!trace) return;
233
+ if (!enabled) return;
234
234
  assert(m != .None);
235
235
  try self.writer.writeAll(&.{
236
236
  @enumToInt(ArgType.Move),
@@ -253,7 +253,7 @@ pub fn Log(comptime Writer: type) type {
253
253
  }
254
254
 
255
255
  pub fn switched(self: Self, ident: ID, pokemon: anytype) Error!void {
256
- if (!trace) return;
256
+ if (!enabled) return;
257
257
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Switch), @bitCast(u8, ident) });
258
258
  try self.writer.writeAll(&.{ @enumToInt(pokemon.species), pokemon.level });
259
259
  try self.writer.writeIntNative(u16, pokemon.hp);
@@ -262,7 +262,7 @@ pub fn Log(comptime Writer: type) type {
262
262
  }
263
263
 
264
264
  pub fn cant(self: Self, ident: ID, reason: Cant) Error!void {
265
- if (!trace) return;
265
+ if (!enabled) return;
266
266
  assert(reason != .Disable);
267
267
  try self.writer.writeAll(&.{
268
268
  @enumToInt(ArgType.Cant),
@@ -272,7 +272,7 @@ pub fn Log(comptime Writer: type) type {
272
272
  }
273
273
 
274
274
  pub fn disabled(self: Self, ident: ID, m: anytype) Error!void {
275
- if (!trace) return;
275
+ if (!enabled) return;
276
276
  try self.writer.writeAll(&.{
277
277
  @enumToInt(ArgType.Cant),
278
278
  @bitCast(u8, ident),
@@ -282,20 +282,20 @@ pub fn Log(comptime Writer: type) type {
282
282
  }
283
283
 
284
284
  pub fn faint(self: Self, ident: ID, done: bool) Error!void {
285
- if (!trace) return;
285
+ if (!enabled) return;
286
286
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Faint), @bitCast(u8, ident) });
287
287
  if (done) try self.writer.writeByte(@enumToInt(ArgType.None));
288
288
  }
289
289
 
290
290
  pub fn turn(self: Self, num: u16) Error!void {
291
- if (!trace) return;
291
+ if (!enabled) return;
292
292
  try self.writer.writeByte(@enumToInt(ArgType.Turn));
293
293
  try self.writer.writeIntNative(u16, num);
294
294
  try self.writer.writeByte(@enumToInt(ArgType.None));
295
295
  }
296
296
 
297
297
  pub fn win(self: Self, player: Player) Error!void {
298
- if (!trace) return;
298
+ if (!enabled) return;
299
299
  try self.writer.writeAll(&.{
300
300
  @enumToInt(ArgType.Win),
301
301
  @enumToInt(player),
@@ -304,12 +304,12 @@ pub fn Log(comptime Writer: type) type {
304
304
  }
305
305
 
306
306
  pub fn tie(self: Self) Error!void {
307
- if (!trace) return;
307
+ if (!enabled) return;
308
308
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Tie), @enumToInt(ArgType.None) });
309
309
  }
310
310
 
311
311
  pub fn damage(self: Self, ident: ID, pokemon: anytype, reason: Damage) Error!void {
312
- if (!trace) return;
312
+ if (!enabled) return;
313
313
  assert(@enumToInt(reason) <= @enumToInt(Damage.LeechSeed));
314
314
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Damage), @bitCast(u8, ident) });
315
315
  try self.writer.writeIntNative(u16, pokemon.hp);
@@ -324,7 +324,7 @@ pub fn Log(comptime Writer: type) type {
324
324
  reason: Damage,
325
325
  source: ID,
326
326
  ) Error!void {
327
- if (!trace) return;
327
+ if (!enabled) return;
328
328
  assert(@enumToInt(reason) == @enumToInt(Damage.RecoilOf));
329
329
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Damage), @bitCast(u8, ident) });
330
330
  try self.writer.writeIntNative(u16, pokemon.hp);
@@ -337,7 +337,7 @@ pub fn Log(comptime Writer: type) type {
337
337
  }
338
338
 
339
339
  pub fn heal(self: Self, ident: ID, pokemon: anytype, reason: Heal) Error!void {
340
- if (!trace) return;
340
+ if (!enabled) return;
341
341
  assert(reason != .Drain);
342
342
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Heal), @bitCast(u8, ident) });
343
343
  try self.writer.writeIntNative(u16, pokemon.hp);
@@ -346,7 +346,7 @@ pub fn Log(comptime Writer: type) type {
346
346
  }
347
347
 
348
348
  pub fn drain(self: Self, source: ID, pokemon: anytype, target: ID) Error!void {
349
- if (!trace) return;
349
+ if (!enabled) return;
350
350
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Heal), @bitCast(u8, source) });
351
351
  try self.writer.writeIntNative(u16, pokemon.hp);
352
352
  try self.writer.writeIntNative(u16, pokemon.stats.hp);
@@ -358,7 +358,7 @@ pub fn Log(comptime Writer: type) type {
358
358
  }
359
359
 
360
360
  pub fn status(self: Self, ident: ID, value: u8, reason: Status) Error!void {
361
- if (!trace) return;
361
+ if (!enabled) return;
362
362
  assert(reason != .From);
363
363
  try self.writer.writeAll(&.{
364
364
  @enumToInt(ArgType.Status),
@@ -369,7 +369,7 @@ pub fn Log(comptime Writer: type) type {
369
369
  }
370
370
 
371
371
  pub fn statusFrom(self: Self, ident: ID, value: u8, m: anytype) Error!void {
372
- if (!trace) return;
372
+ if (!enabled) return;
373
373
  try self.writer.writeAll(&.{
374
374
  @enumToInt(ArgType.Status),
375
375
  @bitCast(u8, ident),
@@ -380,7 +380,7 @@ pub fn Log(comptime Writer: type) type {
380
380
  }
381
381
 
382
382
  pub fn curestatus(self: Self, ident: ID, value: u8, reason: CureStatus) Error!void {
383
- if (!trace) return;
383
+ if (!enabled) return;
384
384
  try self.writer.writeAll(&.{
385
385
  @enumToInt(ArgType.CureStatus),
386
386
  @bitCast(u8, ident),
@@ -390,7 +390,7 @@ pub fn Log(comptime Writer: type) type {
390
390
  }
391
391
 
392
392
  pub fn boost(self: Self, ident: ID, reason: Boost, num: i8) Error!void {
393
- if (!trace) return;
393
+ if (!enabled) return;
394
394
  assert(num != 0 and (reason != .Rage or num > 0));
395
395
  try self.writer.writeAll(&.{
396
396
  @enumToInt(ArgType.Boost),
@@ -401,12 +401,12 @@ pub fn Log(comptime Writer: type) type {
401
401
  }
402
402
 
403
403
  pub fn clearallboost(self: Self) Error!void {
404
- if (!trace) return;
404
+ if (!enabled) return;
405
405
  try self.writer.writeAll(&.{@enumToInt(ArgType.ClearAllBoost)});
406
406
  }
407
407
 
408
408
  pub fn fail(self: Self, ident: ID, reason: Fail) Error!void {
409
- if (!trace) return;
409
+ if (!enabled) return;
410
410
  try self.writer.writeAll(&.{
411
411
  @enumToInt(ArgType.Fail),
412
412
  @bitCast(u8, ident),
@@ -415,17 +415,17 @@ pub fn Log(comptime Writer: type) type {
415
415
  }
416
416
 
417
417
  pub fn miss(self: Self, source: ID) Error!void {
418
- if (!trace) return;
418
+ if (!enabled) return;
419
419
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Miss), @bitCast(u8, source) });
420
420
  }
421
421
 
422
422
  pub fn hitcount(self: Self, ident: ID, num: u8) Error!void {
423
- if (!trace) return;
423
+ if (!enabled) return;
424
424
  try self.writer.writeAll(&.{ @enumToInt(ArgType.HitCount), @bitCast(u8, ident), num });
425
425
  }
426
426
 
427
427
  pub fn prepare(self: Self, source: ID, m: anytype) Error!void {
428
- if (!trace) return;
428
+ if (!enabled) return;
429
429
  try self.writer.writeAll(&.{
430
430
  @enumToInt(ArgType.Prepare),
431
431
  @bitCast(u8, source),
@@ -434,12 +434,12 @@ pub fn Log(comptime Writer: type) type {
434
434
  }
435
435
 
436
436
  pub fn mustrecharge(self: Self, ident: ID) Error!void {
437
- if (!trace) return;
437
+ if (!enabled) return;
438
438
  try self.writer.writeAll(&.{ @enumToInt(ArgType.MustRecharge), @bitCast(u8, ident) });
439
439
  }
440
440
 
441
441
  pub fn activate(self: Self, ident: ID, reason: Activate) Error!void {
442
- if (!trace) return;
442
+ if (!enabled) return;
443
443
  try self.writer.writeAll(&.{
444
444
  @enumToInt(ArgType.Activate),
445
445
  @bitCast(u8, ident),
@@ -448,12 +448,12 @@ pub fn Log(comptime Writer: type) type {
448
448
  }
449
449
 
450
450
  pub fn fieldactivate(self: Self) Error!void {
451
- if (!trace) return;
451
+ if (!enabled) return;
452
452
  try self.writer.writeAll(&.{@enumToInt(ArgType.FieldActivate)});
453
453
  }
454
454
 
455
455
  pub fn start(self: Self, ident: ID, reason: Start) Error!void {
456
- if (!trace) return;
456
+ if (!enabled) return;
457
457
  assert(@enumToInt(reason) < @enumToInt(Start.TypeChange));
458
458
  try self.writer.writeAll(&.{
459
459
  @enumToInt(ArgType.Start),
@@ -463,7 +463,7 @@ pub fn Log(comptime Writer: type) type {
463
463
  }
464
464
 
465
465
  pub fn typechange(self: Self, source: ID, types: anytype, target: ID) Error!void {
466
- if (!trace) return;
466
+ if (!enabled) return;
467
467
  try self.writer.writeAll(&.{
468
468
  @enumToInt(ArgType.Start),
469
469
  @bitCast(u8, source),
@@ -474,7 +474,7 @@ pub fn Log(comptime Writer: type) type {
474
474
  }
475
475
 
476
476
  pub fn startEffect(self: Self, ident: ID, reason: Start, m: anytype) Error!void {
477
- if (!trace) return;
477
+ if (!enabled) return;
478
478
  assert(@enumToInt(reason) > @enumToInt(Start.TypeChange));
479
479
  try self.writer.writeAll(&.{
480
480
  @enumToInt(ArgType.Start),
@@ -485,7 +485,7 @@ pub fn Log(comptime Writer: type) type {
485
485
  }
486
486
 
487
487
  pub fn end(self: Self, ident: ID, reason: End) Error!void {
488
- if (!trace) return;
488
+ if (!enabled) return;
489
489
  try self.writer.writeAll(&.{
490
490
  @enumToInt(ArgType.End),
491
491
  @bitCast(u8, ident),
@@ -494,27 +494,27 @@ pub fn Log(comptime Writer: type) type {
494
494
  }
495
495
 
496
496
  pub fn ohko(self: Self) Error!void {
497
- if (!trace) return;
497
+ if (!enabled) return;
498
498
  try self.writer.writeAll(&.{@enumToInt(ArgType.OHKO)});
499
499
  }
500
500
 
501
501
  pub fn crit(self: Self, ident: ID) Error!void {
502
- if (!trace) return;
502
+ if (!enabled) return;
503
503
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Crit), @bitCast(u8, ident) });
504
504
  }
505
505
 
506
506
  pub fn supereffective(self: Self, ident: ID) Error!void {
507
- if (!trace) return;
507
+ if (!enabled) return;
508
508
  try self.writer.writeAll(&.{ @enumToInt(ArgType.SuperEffective), @bitCast(u8, ident) });
509
509
  }
510
510
 
511
511
  pub fn resisted(self: Self, ident: ID) Error!void {
512
- if (!trace) return;
512
+ if (!enabled) return;
513
513
  try self.writer.writeAll(&.{ @enumToInt(ArgType.Resisted), @bitCast(u8, ident) });
514
514
  }
515
515
 
516
516
  pub fn immune(self: Self, ident: ID, reason: Immune) Error!void {
517
- if (!trace) return;
517
+ if (!enabled) return;
518
518
  try self.writer.writeAll(&.{
519
519
  @enumToInt(ArgType.Immune),
520
520
  @bitCast(u8, ident),
@@ -523,7 +523,7 @@ pub fn Log(comptime Writer: type) type {
523
523
  }
524
524
 
525
525
  pub fn transform(self: Self, source: ID, target: ID) Error!void {
526
- if (!trace) return;
526
+ if (!enabled) return;
527
527
  try self.writer.writeAll(&.{
528
528
  @enumToInt(ArgType.Transform),
529
529
  @bitCast(u8, source),
@@ -532,12 +532,12 @@ pub fn Log(comptime Writer: type) type {
532
532
  }
533
533
 
534
534
  pub fn laststill(self: Self) Error!void {
535
- if (!trace) return;
535
+ if (!enabled) return;
536
536
  try self.writer.writeAll(&.{@enumToInt(ArgType.LastStill)});
537
537
  }
538
538
 
539
539
  pub fn lastmiss(self: Self) Error!void {
540
- if (!trace) return;
540
+ if (!enabled) return;
541
541
  try self.writer.writeAll(&.{@enumToInt(ArgType.LastMiss)});
542
542
  }
543
543
  };
@@ -838,7 +838,7 @@ pub fn expectLog(
838
838
  actual: []const u8,
839
839
  offset: usize,
840
840
  ) !void {
841
- if (!trace) return;
841
+ if (!enabled) return;
842
842
  const color = color: {
843
843
  if (std.process.hasEnvVarConstant("ZIG_DEBUG_COLOR")) {
844
844
  break :color true;
@@ -198,7 +198,7 @@ above, PP information isn't strictly necessary in Generation I so is dropped. `M
198
198
  a special sentinel value to indicate `null`. Move PP data is only included for testing and is not
199
199
  necessary for the actual engine implementation.
200
200
 
201
- In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in traces,
201
+ In order to workaround various [Pokémon Showdown bugs](#bugs) and to support its protocol in logs,
202
202
  additional information is stored in `Move.Data` (`targets`) about what Pokémon Showdown believes the
203
203
  `Move.Target` to be (despite the concept of targeting not existing until Generation III when Double
204
204
  battles were introduced). More specifically, a move's "targeting" status is required in various
@@ -331,8 +331,10 @@ does not produce an equivalent to Pokémon Showdown's `|request|` protocol messa
331
331
  must be gleaned through the `Battle` state). Useful size and offset information can be found in
332
332
  the [`layout.json`](../../data/layout.json) which exists to simplify writing driver code.
333
333
 
334
- Documentation of the wire protocol used for logging traces when `-Dtrace` is enabled can be found in
335
- [PROTOCOL.md](../../../docs/PROTOCOL.md).
334
+ Documentation of the wire protocol used for protocol message logging when `-Dlog` is enabled can be
335
+ found in [PROTOCOL.md](../../../docs/PROTOCOL.md). Note that the
336
+ [`pkmn-debug`](../../../README.md#pkmn-debug) tool exists to display the binary protocol and battle
337
+ data in the browser for ease of debugging.
336
338
 
337
339
  ### `Battle`
338
340
 
@@ -476,17 +478,17 @@ Smogon](https://www.smogon.com/forums/posts/5933177/show):
476
478
  - Confusion self-hits use the wrong damage formula resulting in off-by-one errors (and also fail to
477
479
  account for an opponent's Reflect). Furthermore, the confusion self-hit damage will erroneously be
478
480
  inflicted to the confused user's substitute if the confused user had been attempting to use a
479
- self-targeting move.
481
+ self-targeting move. Finally, Pokémon Showdown erroneously considers the *uncapped* self-hit
482
+ damage for the purposes of tracking the battle's last damage.
480
483
 
481
484
  Beyond the general bugs listed above, several move effects are implemented incorrectly by Pokémon
482
485
  Showdown. Some of these moves are [too fundamentally broken to be implemented](#unimplementable) by
483
486
  the pkmn engine, but the following moves have their broken behavior preserved in `-Dshowdown` mode:
484
487
 
485
- - **Bide**: If the opponent faints after Bide inflicts damage on Pokémon Showdown residual damage
486
- incorrectly still gets applied to Bide's user.
488
+ - **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
489
+ registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
487
490
  - **Leech Seed**: Leech Seed fails to heal its source side if a seeded target faints due to
488
- recoil/crash damage on Pokémon Showdown. Pokémon Showdown also updates the battle's last damage
489
- field with the uncapped Leech Seed damage which has consequences for Bide and Counter.
491
+ recoil/crash damage on Pokémon Showdown.
490
492
  - **Pay Day**: Pay Day should still scatter coins if it hits (but doesn't break) and opponent's
491
493
  Substitute but doesn't on Pokémon Showdown.
492
494
  - **Flinch**: Flinching does not get cleared during move selection on Pokémon Showdown and is
@@ -495,9 +497,15 @@ the pkmn engine, but the following moves have their broken behavior preserved in
495
497
  skips end-of-turn residuals).
496
498
  - **Rage**: Rage boosts should still result in burn/paralysis [stat modification
497
499
  errors](https://pkmn.cc/bulba-glitch-1#Stat_modification_errors) but don't on Pokémon Showdown.
500
+ Furthermore, Pokémon Showdown only builds Rage for Disable/Explosion (hit/miss) when attacking
501
+ into a Substitute instead of all moves. Pokémon Showdown also implements the [Rage and Thrash /
502
+ Petal Dance accuracy bug]( https://www.youtube.com/watch?v=NC5gbJeExbs) incorrectly, as the
503
+ accuracy only gets written when the volatile is present which can lead to incorrect accuracy
504
+ values on turns where Rage is used on the same turn as a move which modifies accuracy or evasion.
498
505
  - **Thrash** / **Petal Dance**: once a Pokémon is locked into a thrashing move they will lose all
499
506
  speed ties on Pokémon Showdown (due to the fact that if they win the speed tie their action will
500
- then get "changed" and inserted back into the queue after their opponent's action).
507
+ then get "changed" and inserted back into the queue after their opponent's action). Pokémon
508
+ Showdown also implements accuracy incorrectly, as covered above.
501
509
  - **Freeze** / **Sleep**: Pokémon Showdown requires a move to be selected when a Pokémon is frozen
502
510
  or sleeping and uses that in the event that the status is removed while on the cartridge no
503
511
  selection is possible and no turn exists for the thawed/woken Pokémon to act except in the case of
@@ -521,8 +529,13 @@ the pkmn engine, but the following moves have their broken behavior preserved in
521
529
  glitch](https://glitchcity.wiki/Substitute_%C2%BC_HP_glitch) also fails in many cases due to
522
530
  Pokémon Showdown implementing the health check based on floating point division instead of integer
523
531
  divison like on the cartridge (meaning the Substitute 1/4 glitch will only occur if the Pokémon's
524
- maximum HP is evenly divisible by 4). Finally, Substitute also incorrectly blocks Dream Eater on
525
- Pokémon Showdown.
532
+ maximum HP is evenly divisible by 4). Substitute also incorrectly blocks Dream Eater on
533
+ Pokémon Showdown and will incorrectly still heal 1 HP for any draining moves if the attack does 0
534
+ damage. Finally, Pokémon Showdown uses a `subFainted` field to track whether a Substitute was
535
+ broken in order to know when to nullify a move's effect, only it doesn't get cleared at the end of
536
+ the turn and can result in incorrect behavior on subsequent turns with the moves Mirror Move and
537
+ Metronome that invoke `runMove` (which is where `subFainted` gets cleared) on the user but skips
538
+ calling it for the eventual true target.
526
539
 
527
540
  In addition to numerous cases where Pokémon Showdown uses the wrong type of message (e.g. `|-fail`
528
541
  vs. `|-miss|` vs. `|-immune|`, e.g. in the case of Leech Seed) which are not documented here, Pokémon
@@ -584,6 +597,10 @@ Showdown's behavior for the following moves (the pkmn engine attempts to reprodu
584
597
  behavior that can be reproduced without making data structure changes or dramatically deviating from
585
598
  the correct control flow):
586
599
 
600
+ - **Bide**: Bide's damage can overflow if OHKO moves are involved because OHKO moves work by setting
601
+ the damage to 65535 - Pokémon Showdown doesn't implement this overflow and instead lets Bide's
602
+ damage grow unbounded. Additionally, if the opponent faints after Bide inflicts damage on Pokémon
603
+ Showdown residual damage incorrectly still gets applied to Bide's user.
587
604
  - **Wrap**: Binding moves like Wrap are implemented on Pokémon Showdown with an artificial
588
605
  `partialtrappinglock` volatile as opposed to how it works on the cartridge which simply relies on
589
606
  the `Binding` volatile of the opponent. This mistake results in choice locking not being reported
@@ -592,9 +609,9 @@ the correct control flow):
592
609
  still gets a turn under the [trapping sleep
593
610
  glitch](https://glitchcity.wiki/Trapping_move_and_sleep_glitch), Wrap does 0 damage against
594
611
  Ghost-type Pokémon instead of properly respecting immunity, and binding effects are handled in the
595
- wrong order in the code.
596
- - **Counter**: On Pokémon Showdown choices made while sleeping (which should not have been
597
- registered) can erroneously cause Counter to trigger Desync Clause Mod behavior.
612
+ wrong order in the code which results in either out of order messaging or, more consequentially,
613
+ Pokémon using Rage/Bide or Thrashing/Charging moves being incorrectly forced to skip a turn when
614
+ the Pokémon using the Binding move switches.
598
615
  - **Mimic**: Pokémon Showdown checks that the user of Mimic has Mimic in one of their move slots,
599
616
  which means Mimic legally called via Metronome or Mirror Move will only work if the user also has
600
617
  Mimic (and the moved mimicked by Mimic called via Metronome / Mirror Move will erroneously
@@ -603,18 +620,25 @@ the correct control flow):
603
620
  the Pokémon already knows, PP deduction for using either the original move of the mimicked move
604
621
  will instead deduct PP for whichever appears at the lower move slot index and the PP will be
605
622
  allowed to go negative (effectively allowing for infinite PP use).
606
- - **Mirror Move**: Binding moves misbehave when used via Mirror Move (though Pokémon Showdown has
607
- its own weird behavior and does not implement the [partial trapping move Mirror Move
623
+ - **Mirror Move**: As covered above, both Substitute and Binding moves misbehave when used via
624
+ Mirror Move (though Pokémon Showdown has its own weird behavior and does not implement the
625
+ [partial trapping move Mirror Move
608
626
  glitch](https://glitchcity.wiki/Partial_trapping_move_Mirror_Move_link_battle_glitch) that exists
609
- on the cartridge).
610
- - **Metronome**: In addition to the issues with binding moves, Metronome and Mirror Move cannot
611
- mutually call each other more than 3 times in a row without causing the Pokémon Showdown simulator
612
- to crash due to defensive safety checks that do not exist on the cartridge.
613
- - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
627
+ on the cartridge). Additionally, Pokémon Showdown sets the last used move every turn a Pokémon is
628
+ Thrashing instead of just on the turn it is actually selected meaning Mirror Move will sometimes
629
+ successfully mirror a Thrashing move when it should fail. Finally, if Mirror Move copies
630
+ Struggle it should not deduct PP but on Pokémon Showdown it does.
631
+ - **Metronome**: In addition to the issues with binding moves and Substitute, Metronome and Mirror
632
+ Move cannot mutually call each other more than 3 times in a row without causing the Pokémon
633
+ Showdown simulator to crash due to defensive safety checks that do not exist on the cartridge.
634
+ - **Transform**: Transform screws up the effect of Disable, because on Pokémon Showdown, Disable
614
635
  prevents moves of a given *name* from being used (e.g. "Water Gun") as opposed to moves in a
615
636
  specific *slot* (e.g. the 2nd move slot), and a Pokémon's moves can change after Transform (this
616
- is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Furthermore,
617
- transforming and then using Mirror Move / Metronome can result in [glitchy behavior and
637
+ is not an issue with Disable + Mimic because Mimic happens to replace the same slot). Transform
638
+ also has a bad interaction with Pokémon Showdown's buggy Haze implementation, as Haze on Pokémon
639
+ Showdown does not copy unmodified stats, leaving the Transformed Pokémon with inccorect stats.
640
+ Furthermore, transforming and then using Mirror Move / Metronome can result in [glitchy behavior
641
+ and
618
642
  softlocks](https://pkmn.cc/bulba/Transform_glitches#Transform_.2B_Mirror_Move.2FMetronome_PP_error)
619
643
  which Pokémon Showdown does not implement.
620
644
 
@@ -17,16 +17,16 @@ const expectEqual = std.testing.expectEqual;
17
17
  const expect = std.testing.expect;
18
18
 
19
19
  /// The minimum size in bytes required to hold all Generation I choice options.
20
- pub const MAX_OPTIONS: usize = 9; // move 1..4, switch 2..6
20
+ pub const MAX_CHOICES: usize = 9; // move 1..4, switch 2..6
21
21
  /// The optimal size in bytes required to hold all Generation I choice options.
22
- /// At least as large as MAX_OPTIONS.
22
+ /// At least as large as MAX_CHOICES.
23
23
  pub const MAX_LOGS: usize = 180;
24
24
 
25
25
  /// The maximum number of bytes possibly logged by a single Generation I update.
26
- pub const OPTIONS_SIZE = if (builtin.mode == .ReleaseSmall)
27
- MAX_OPTIONS
26
+ pub const CHOICES_SIZE = if (builtin.mode == .ReleaseSmall)
27
+ MAX_CHOICES
28
28
  else
29
- std.math.ceilPowerOfTwo(usize, MAX_OPTIONS) catch unreachable;
29
+ std.math.ceilPowerOfTwo(usize, MAX_CHOICES) catch unreachable;
30
30
  /// The optimal size in bytes required to hold the largest amount of log data possible from a
31
31
  /// single Generation I update. At least as large as MAX_LOGS.
32
32
  pub const LOGS_SIZE = if (builtin.mode == .ReleaseSmall)
@@ -76,7 +76,7 @@ pub fn Battle(comptime RNG: anytype) type {
76
76
  }
77
77
 
78
78
  /// Returns the result of applying Player 1's choice `c1` and Player 2's choice `c2` to the
79
- /// battle, optionally writing protocol logs to `log` if `options.trace` is enabled.
79
+ /// battle, optionally writing protocol message logs to `log` if `options.log` is enabled.
80
80
  pub fn update(self: *Self, c1: Choice, c2: Choice, log: anytype) !Result {
81
81
  return mechanics.update(self, c1, c2, log);
82
82
  }
@@ -211,16 +211,19 @@ pub const Pokemon = struct {
211
211
  }
212
212
  };
213
213
 
214
- // cat src/test/showdown/blocklist.json | jq '."1".moves'
214
+ // TODO: uncomment once integration tests pass
215
+ // fn blocked(m: Move) bool {
216
+ // // Binding moves are borked but only via Mirror Move / Metronome which are already blocked
217
+ // return switch (m) {
218
+ // .Mimic, .Metronome, .MirrorMove, .Transform => true,
219
+ // else => false,
220
+ // };
221
+ // }
222
+
215
223
  fn blocked(m: Move) bool {
216
224
  if (Move.get(m).effect == .Binding) return true;
217
225
  return switch (m) {
218
- .Counter,
219
- .Mimic,
220
- .Metronome,
221
- .MirrorMove,
222
- .Transform,
223
- => true,
226
+ .Counter, .Mimic, .Bide, .Metronome, .MirrorMove, .Transform => true,
224
227
  else => false,
225
228
  };
226
229
  }