refactor: clean up player state interface

Author: CoolSpring8

src/player/Player.ts

@@ -20,7 +20,6 @@ import { StateMachine } from "./StateMachine";
 import { InputState, PlayerEffect, PlayerSnapshot, PlayerState } from "./types";
 
 type DashHorizontalCollisionResult = "none" | "corrected" | "ducked";
-type PlayerMachineState = "normal" | "climb" | "dash";
 
 const EPSILON = 0.0001;
 const EMPTY_INPUT: InputState = {
@@ -58,7 +57,7 @@ export class Player {
   private autoJump = false;
   private autoJumpTimer = 0;
 
-  private readonly stateMachine: StateMachine<PlayerMachineState>;
+  private readonly stateMachine: StateMachine<PlayerState>;
   private frameDt = 0;
   private input: InputState = EMPTY_INPUT;
 
@@ -115,7 +114,7 @@ export class Player {
     this.wallSlideTimer = toFloat(cfg.gravity.wallSlideTime);
     this.maxFall = toFloat(cfg.gravity.maxFall);
 
-    this.stateMachine = new StateMachine<PlayerMachineState>("normal");
+    this.stateMachine = new StateMachine<PlayerState>("normal");
     this.stateMachine.setCallbacks(
       "normal",
       () => this.normalUpdate(),
@@ -409,26 +408,11 @@ export class Player {
   }
 
   get state(): PlayerState {
-    const state = this.stateMachine.state;
-    if (state === "climb") {
-      return "grab";
-    }
-    if (state === "normal" && this.ducking) {
-      return "duck";
-    }
-    return state;
+    return this.stateMachine.state;
   }
 
-  set state(value: PlayerState) {
-    if (value === "grab") {
-      this.stateMachine.state = "climb";
-      return;
-    }
-    if (value === "dash" || value === "dashAttack") {
-      this.stateMachine.state = "dash";
-      return;
-    }
-    this.stateMachine.state = "normal";
+  forceState(state: PlayerState): void {
+    this.stateMachine.forceState(state);
   }
 
   private refreshEnvironment(): void {
@@ -450,7 +434,7 @@ export class Player {
     this.hopWaitXSpeed = 0;
   }
 
-  private normalUpdate(): PlayerMachineState {
+  private normalUpdate(): PlayerState {
     const dt = this.frameDt;
     const input = this.input;
 
@@ -599,7 +583,7 @@ export class Player {
     this.wallSpeedRetentionTimer = 0;
   }
 
-  private climbUpdate(): PlayerMachineState {
+  private climbUpdate(): PlayerState {
     const dt = this.frameDt;
     const input = this.input;
     this.climbNoMoveTimer = subFloat(this.climbNoMoveTimer, dt);
@@ -748,7 +732,7 @@ export class Player {
   private dashEnd(): void {
   }
 
-  private dashUpdate(): PlayerMachineState {
+  private dashUpdate(): PlayerState {
     if (this.dashDir.y === 0) {
       this.applyDashJumpThruNudge();
 
@@ -935,7 +919,7 @@ export class Player {
     return this.hasDashPress() && this.dashCooldownTimer <= 0 && this.dashesLeft > 0;
   }
 
-  private startDash(): PlayerMachineState {
+  private startDash(): PlayerState {
     this.consumeDashPress();
     this.dashesLeft = Math.max(0, this.dashesLeft - 1);
     return "dash";

src/player/types.ts

@@ -1,4 +1,4 @@
-export type PlayerState = "normal" | "duck" | "grab" | "dash" | "dashAttack";
+export type PlayerState = "normal" | "climb" | "dash";
 
 export interface InputState {
   x: number;

src/view/PlayerView.ts

@@ -397,8 +397,7 @@ export class PlayerView {
     const enteredDuck =
       !this.prevCrouched &&
       snapshot.isCrouched &&
-      snapshot.onGround &&
-      snapshot.state === "duck";
+      snapshot.onGround;
     if (enteredDuck) {
       this.squash(PLAYER_VISUALS.duckSquashX, PLAYER_VISUALS.duckSquashY);
       return;
@@ -408,7 +407,6 @@ export class PlayerView {
       this.prevCrouched &&
       !snapshot.isCrouched &&
       this.prevOnGround &&
-      this.prevState === "duck" &&
       snapshot.onGround;
     if (exitedDuck) {
       this.squash(PLAYER_VISUALS.unduckSquashX, PLAYER_VISUALS.unduckSquashY);
@@ -608,7 +606,7 @@ export class PlayerView {
   }
 
   private resolveSqrt11Pose(snapshot: PlayerSnapshot): Sqrt11Pose {
-    return snapshot.state === "duck" || snapshot.isCrouched ? "duck" : "idle";
+    return snapshot.isCrouched ? "duck" : "idle";
   }
 
   private applyGlyphSprite(

tests/tech/climb-tech.test.ts

@@ -27,7 +27,7 @@ describe("Climb and dashless tech", () => {
     let climbedOut = false;
     for (let frame = 0; frame < 400; frame++) {
       const result = stepOnce(player, makeInput({ grab: true, y: -1 }));
-      if (frame > 10 && result.snapshot.state !== "grab") {
+      if (frame > 10 && result.snapshot.state !== "climb") {
         climbedOut = true;
         expect(result.snapshot.vy).toBeCloseTo(-120, 5);
         break;
@@ -56,7 +56,7 @@ describe("Climb and dashless tech", () => {
       snapshot = stepOnce(player, makeInput({ grab: true, y: -1 })).snapshot;
     }
 
-    expect(snapshot.state).toBe("grab");
+    expect(snapshot.state).toBe("climb");
     expect(snapshot.vx).toBe(0);
     expect(snapshot.vy).toBeCloseTo(0, 5);
   });
@@ -94,7 +94,7 @@ describe("Climb and dashless tech", () => {
     );
 
     stepOnce(player, makeInput({ grab: true }));
-    expect(player.getSnapshot().state).toBe("grab");
+    expect(player.getSnapshot().state).toBe("climb");
 
     stepOnce(player, makeInput({ grab: true, jump: true, jumpPressed: true, x: 0 }));
     expect(player.getSnapshot().stamina).toBeCloseTo(82.5, 5);
@@ -175,12 +175,12 @@ describe("Climb and dashless tech", () => {
     );
 
     stepOnce(player, makeInput({ grab: true }));
-    expect(player.getSnapshot().state).toBe("grab");
+    expect(player.getSnapshot().state).toBe("climb");
 
     let exhausted: ReturnType<typeof player.getSnapshot> | null = null;
     for (let frame = 0; frame < 240; frame++) {
       const result = stepOnce(player, makeInput({ grab: true, y: -1 }));
-      if (result.snapshot.state !== "grab") {
+      if (result.snapshot.state !== "climb") {
         exhausted = result.snapshot;
         break;
       }
@@ -200,13 +200,13 @@ describe("Climb and dashless tech", () => {
     const wallBottom = 17 * WORLD.tile;
     const player = createPlayer(world, 20 * WORLD.tile - PLAYER_GEOMETRY.hitboxW, wallBottom);
     const internals = player as unknown as {
-      state: string;
+      forceState: (state: PlayerSnapshot["state"]) => void;
       facing: 1 | -1;
       refreshEnvironment: () => void;
       climbCheck: (dir: number, yAdd?: number) => boolean;
     };
 
-    internals.state = "grab";
+    internals.forceState("climb");
     internals.facing = 1;
     internals.refreshEnvironment();
 
@@ -227,12 +227,12 @@ describe("Climb and dashless tech", () => {
     const player = createPlayer(world, 20 * WORLD.tile - PLAYER_GEOMETRY.hitboxW, wallBottom - 1);
     const internals = player as unknown as {
       climbNoMoveTimer: number;
-      state: string;
+      forceState: (state: PlayerSnapshot["state"]) => void;
       facing: 1 | -1;
       refreshEnvironment: () => void;
     };
 
-    internals.state = "grab";
+    internals.forceState("climb");
     internals.facing = 1;
     internals.refreshEnvironment();
     internals.climbNoMoveTimer = 0;
@@ -243,7 +243,7 @@ describe("Climb and dashless tech", () => {
     stepOnce(player, makeInput({ x: 1, grab: true }));
     const secondTap = stepOnce(player, makeInput({ x: 1, y: 1, grab: true }));
 
-    expect(secondTap.snapshot.state).toBe("grab");
+    expect(secondTap.snapshot.state).toBe("climb");
     expect(secondTap.snapshot.y).toBe(wallBottom);
   });
 });