rollback-netcode 0.0.4

package/dist/rollback/input-buffer.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Per-player input tracking with support for dynamic join/leave.
+ *
+ * Tracks received inputs, confirmed ticks, and used (predicted) inputs
+ * to enable misprediction detection during rollback.
+ */
+import type { PlayerId, Tick } from "../types.js";
+/**
+ * Buffer for tracking inputs from all players.
+ *
+ * Supports:
+ * - Dynamic player join/leave
+ * - Out-of-order input reception
+ * - Misprediction detection
+ * - Confirmed tick tracking
+ */
+export declare class InputBuffer {
+    private readonly players;
+    /** Index of players by their join tick for O(1) lookup */
+    private readonly joinsByTick;
+    /** Index of players by their leave tick for O(1) lookup */
+    private readonly leavesByTick;
+    /**
+     * Add a player to the buffer.
+     *
+     * @param playerId - The player's ID
+     * @param joinTick - The tick at which the player joins
+     */
+    addPlayer(playerId: PlayerId, joinTick: Tick): void;
+    /**
+     * Mark a player as having left.
+     *
+     * @param playerId - The player's ID
+     * @param leaveTick - The tick at which the player leaves
+     */
+    removePlayer(playerId: PlayerId, leaveTick: Tick): void;
+    /**
+     * Set the confirmed tick for all active players to a specific value.
+     * Used after a state sync to indicate that all inputs up to that tick
+     * are implicitly confirmed by the synced state.
+     *
+     * @param tick - The tick to set as confirmed for all active players
+     */
+    setConfirmedTickForSync(tick: Tick): void;
+    /**
+     * Check if a player is active at a given tick.
+     *
+     * @param playerId - The player's ID
+     * @param tick - The tick to check
+     * @returns true if the player is active at that tick
+     */
+    isPlayerActive(playerId: PlayerId, tick: Tick): boolean;
+    /**
+     * Get all players that are active at a given tick.
+     *
+     * @param tick - The tick to check
+     * @returns Array of active player IDs
+     */
+    getActivePlayers(tick: Tick): PlayerId[];
+    /**
+     * Get all player IDs (active or not).
+     *
+     * @returns Array of all player IDs
+     */
+    getAllPlayers(): PlayerId[];
+    /**
+     * Receive an input from a player.
+     * The input is copied to prevent external mutation.
+     *
+     * @param playerId - The player's ID
+     * @param tick - The tick the input is for
+     * @param input - The input data
+     */
+    receiveInput(playerId: PlayerId, tick: Tick, input: Uint8Array): void;
+    /**
+     * Update the confirmed tick for a player.
+     * Confirmed tick is the highest tick where all ticks from joinTick
+     * to that tick have received inputs.
+     */
+    private updateConfirmedTick;
+    /**
+     * Get the received input for a player at a specific tick.
+     *
+     * @param playerId - The player's ID
+     * @param tick - The tick to get input for
+     * @returns The input, or undefined if not received
+     */
+    getInput(playerId: PlayerId, tick: Tick): Uint8Array | undefined;
+    /**
+     * Get the confirmed tick for a player.
+     * This is the highest consecutive tick for which we have received input.
+     *
+     * @param playerId - The player's ID
+     * @returns The confirmed tick, or undefined if player not found
+     */
+    getConfirmedTick(playerId: PlayerId): Tick | undefined;
+    /**
+     * Get the join tick for a player.
+     *
+     * @param playerId - The player's ID
+     * @returns The join tick, or undefined if player not found
+     */
+    getJoinTick(playerId: PlayerId): Tick | undefined;
+    /**
+     * Get the leave tick for a player.
+     *
+     * @param playerId - The player's ID
+     * @returns The leave tick, or null/undefined if player hasn't left or not found
+     */
+    getLeaveTick(playerId: PlayerId): Tick | null | undefined;
+    /**
+     * Record the input that was actually used for a player at a tick.
+     * This may be the real input or a predicted input.
+     *
+     * @param playerId - The player's ID
+     * @param tick - The tick
+     * @param input - The input that was used
+     */
+    recordUsedInput(playerId: PlayerId, tick: Tick, input: Uint8Array): void;
+    /**
+     * Get the input that was used for a player at a tick.
+     *
+     * @param playerId - The player's ID
+     * @param tick - The tick
+     * @returns The used input, or undefined if not recorded
+     */
+    getUsedInput(playerId: PlayerId, tick: Tick): Uint8Array | undefined;
+    /**
+     * Find the first tick where a misprediction occurred for a player.
+     * A misprediction is when we used a predicted input that differs
+     * from the actual received input.
+     *
+     * @param playerId - The player's ID
+     * @param fromTick - Start searching from this tick
+     * @returns The tick of the first misprediction, or undefined if none found
+     */
+    findMisprediction(playerId: PlayerId, fromTick: Tick): Tick | undefined;
+    /**
+     * Check if there are any mispredictions for a player in a tick range.
+     *
+     * @param playerId - The player's ID
+     * @param fromTick - Start of range (inclusive)
+     * @param toTick - End of range (inclusive)
+     * @returns true if any misprediction found
+     */
+    hasMisprediction(playerId: PlayerId, fromTick: Tick, toTick: Tick): boolean;
+    /**
+     * Get the last confirmed input for a player.
+     * Useful for input prediction.
+     *
+     * @param playerId - The player's ID
+     * @returns The last confirmed input, or undefined if none
+     */
+    getLastConfirmedInput(playerId: PlayerId): Uint8Array | undefined;
+    /**
+     * Remove all data before a given tick.
+     * Used to clean up old inputs that are no longer needed.
+     *
+     * @param tick - Remove all data for ticks < this value
+     */
+    pruneBeforeTick(tick: Tick): void;
+    /**
+     * Clear used inputs for a player from a given tick onwards.
+     * Called during rollback to allow re-recording inputs.
+     *
+     * @param playerId - The player's ID
+     * @param fromTick - Clear from this tick onwards
+     */
+    clearUsedInputsFrom(playerId: PlayerId, fromTick: Tick): void;
+    /**
+     * Clear all used inputs from a given tick onwards for all players.
+     *
+     * @param fromTick - Clear from this tick onwards
+     */
+    clearAllUsedInputsFrom(fromTick: Tick): void;
+    /**
+     * Get the minimum confirmed tick across all active players at a given tick.
+     *
+     * @param tick - The reference tick for determining active players
+     * @returns The minimum confirmed tick, or undefined if no active players
+     */
+    getMinConfirmedTick(tick: Tick): Tick | undefined;
+    /**
+     * Check if we have all inputs for a given tick from all active players.
+     *
+     * @param tick - The tick to check
+     * @returns true if all inputs are available
+     */
+    hasAllInputsForTick(tick: Tick): boolean;
+    /**
+     * Clear all data for a player.
+     *
+     * @param playerId - The player's ID
+     */
+    clearPlayer(playerId: PlayerId): void;
+    /**
+     * Clear all players and data.
+     */
+    clear(): void;
+    /**
+     * Get all players that join at a specific tick.
+     * O(1) lookup using tick-indexed map.
+     *
+     * @param tick - The tick to check
+     * @returns Array of player IDs joining at this tick
+     */
+    getPlayersJoiningAtTick(tick: Tick): PlayerId[];
+    /**
+     * Get all players that leave at a specific tick.
+     * O(1) lookup using tick-indexed map.
+     *
+     * @param tick - The tick to check
+     * @returns Array of player IDs leaving at this tick
+     */
+    getPlayersLeavingAtTick(tick: Tick): PlayerId[];
+    /**
+     * Add a player to a tick index.
+     */
+    private addToTickIndex;
+    /**
+     * Remove a player from a tick index.
+     */
+    private removeFromTickIndex;
+}
+//# sourceMappingURL=input-buffer.d.ts.map

package/dist/rollback/input-buffer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"input-buffer.d.ts","sourceRoot":"","sources":["../../src/rollback/input-buffer.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAkClD;;;;;;;;GAQG;AACH,qBAAa,WAAW;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA8C;IAEtE,0DAA0D;IAC1D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAuC;IAEnE,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuC;IAEpE;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,GAAG,IAAI;IAsCnD;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,GAAG,IAAI;IAevD;;;;;;OAMG;IACH,uBAAuB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAiBzC;;;;;;OAMG;IACH,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO;IAUvD;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,EAAE;IAUxC;;;;OAIG;IACH,aAAa,IAAI,QAAQ,EAAE;IAI3B;;;;;;;OAOG;IACH,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;IAoBrE;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,UAAU,GAAG,SAAS;IAMhE;;;;;;OAMG;IACH,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,GAAG,SAAS;IAMtD;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,GAAG,SAAS;IAKjD;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS;IAKzD;;;;;;;OAOG;IACH,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;IAWxE;;;;;;OAMG;IACH,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,GAAG,UAAU,GAAG,SAAS;IAMpE;;;;;;;;OAQG;IACH,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS;IAoBvE;;;;;;;OAOG;IACH,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAG,OAAO;IAkB3E;;;;;;OAMG;IACH,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS;IAajE;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAkBjC;;;;;;OAMG;IACH,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,GAAG,IAAI;IAW7D;;;;OAIG;IACH,sBAAsB,CAAC,QAAQ,EAAE,IAAI,GAAG,IAAI;IAM5C;;;;;OAKG;IACH,mBAAmB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS;IAcjD;;;;;OAKG;IACH,mBAAmB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO;IAWxC;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAYrC;;OAEG;IACH,KAAK,IAAI,IAAI;IAMb;;;;;;OAMG;IACH,uBAAuB,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,EAAE;IAK/C;;;;;;OAMG;IACH,uBAAuB,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,EAAE;IAK/C;;OAEG;IACH,OAAO,CAAC,cAAc;IAatB;;OAEG;IACH,OAAO,CAAC,mBAAmB;CAa3B"}