doc strings

Author: ecrax

app/lib/zustand/clipboard.ts

@@ -1,6 +1,9 @@
 import type { Node } from "@xyflow/react";
 import { create } from "zustand";
 
+/**
+ * Clipboard state interface for managing copied nodes and their last paste position.
+ */
 interface ClipboardState {
   copiedNodes: Node[];
   lastPastePosition: { x: number; y: number } | null;
@@ -9,6 +12,11 @@ interface ClipboardState {
   hasCopiedNodes: () => boolean;
 }
 
+/**
+ * Clipboard state management using Zustand.
+ * This store manages copied nodes and their last paste position.
+ * It provides methods to set copied nodes, clear the clipboard, and check if there are copied
+ */
 export const useClipboardStore = create<ClipboardState>((set, get) => ({
   copiedNodes: [],
   lastPastePosition: null,

app/lib/zustand/game.ts

@@ -14,6 +14,11 @@ interface GameState {
   init: (level: LevelId) => void;
 }
 
+/**
+ * Game state management using Zustand.
+ * This store manages the game state, including pause/play status,
+ * current level, level completion status, and dialog visibility.
+ */
 export const useGameStore = create<GameState>((set, get) => ({
   isPaused: false,
   pause: () => set({ isPaused: true }),

app/lib/zustand/key.ts

@@ -9,6 +9,10 @@ interface KeyState {
   setKeyReleasedFunction: (keyFunction: (key: string) => boolean) => void;
 }
 
+/**
+ * This store allows us the make key events more flexible.
+ * It allows us to set custom functions for key down, pressed, and released events.
+ */
 export const useKeyStore = create<KeyState>((set) => ({
   isKeyDown: () => false,
   setKeyDownFunction: (keyFunction) => set({ isKeyDown: keyFunction }),

app/lib/zustand/mouse.ts

@@ -6,6 +6,10 @@ interface MouseState {
   setMousePosFunction: (mouseFunction: () => Vec2) => void;
 }
 
+/**
+ * Unified mouse position management using Zustand.
+ * This store allows us to set a custom function to retrieve the mouse position,
+ */
 export const useMouseStore = create<MouseState>((set) => ({
   getMousePos: () => ({ x: 0, y: 0 }) as Vec2,
   setMousePosFunction: (mouseFunction) => set({ getMousePos: mouseFunction }),

app/lib/zustand/time.ts

@@ -7,6 +7,9 @@ interface TimeState {
   setDeltaTimeFunction: (timeFunction: () => number) => void;
 }
 
+/**
+ * This store allows re-exports of the time functions from the game engine.
+ */
 export const useTimeStore = create<TimeState>((set) => ({
   getTime: () => 0,
   setTimeFunction: (timeFunction) => set({ getTime: timeFunction }),