brick-engine-js 1.0.9 → 1.0.11

package/docs/reference/interfaces/modules/Grid.adoc

@@ -1,411 +0,0 @@
-= Grid Reference
-:description: Interface defining the behaviors of a 2D grid of cells.
-:keywords: grid, cells, matrix, collision-detection
-:toc: left
-:toclevels: 3
-:sectnums:
-:sectlinks:
-:icons: font
-:source-highlighter: highlight.js
-:reproducible:
-:experimental:
-:idprefix:
-:idseparator: -
-
-Interface defining the behaviors of a 2D grid of cells.
-
-== Properties
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`width` |`number` |The number of columns in the grid.
-|`height` |`number` |The number of rows in the grid.
-|===
-
-== Methods
-
-=== `getGrid(): xref:../../types/Cell.adoc[Cell][][]`
-
-Returns the raw 2D array of `xref:../../types/Cell.adoc[Cell]` objects representing the grid state.
-
-**Returns**
-
-`xref:../../types/Cell.adoc[Cell][][]` - The matrix representing the grid state.
-
-
-'''
-
-=== `resetGrid(): void`
-
-Clears all cell values and resets colors to `xref:../../enums/Color.adoc[DEFAULT]`.
-
-
-'''
-
-=== `forEach(callback: (cell: xref:../../types/Cell.adoc[Cell]) => void): void`
-
-Iterates over every cell in the grid, executing the provided callback.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`callback` |`(cell: xref:../../types/Cell.adoc[Cell]) => void` |Function to execute for each cell.
-|===
-
-
-'''
-
-=== `isValidCoordinate(coordinate: xref:../../types/Coordinate.adoc[Coordinate]): boolean`
-
-Returns `true` if the given coordinate falls within the grid boundaries.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`coordinate` |`xref:../../types/Coordinate.adoc[Coordinate]` |The `{x, y}` point to validate.
-|===
-
-**Returns**
-
-`boolean` - `true` if valid, `false` otherwise.
-
-
-'''
-
-=== `getCell(coordinate: xref:../../types/Coordinate.adoc[Coordinate]): xref:../../types/Cell.adoc[Cell] | null`
-
-Retrieves the `xref:../../types/Cell.adoc[Cell]` object at the specified coordinate.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`coordinate` |`xref:../../types/Coordinate.adoc[Coordinate]` |The `{x, y}` position to query.
-|===
-
-**Returns**
-
-`xref:../../types/Cell.adoc[Cell] | null` - The cell object, or `null` if the coordinate is out of bounds.
-
-
-'''
-
-=== `setCellValue(coordinate: xref:../../types/Coordinate.adoc[Coordinate], value: number): void`
-
-Updates the numeric value of the cell at the given coordinate.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`coordinate` |`xref:../../types/Coordinate.adoc[Coordinate]` |Target position.
-|`value` |`number` |New status value (0 for inactive, >0 for active).
-|===
-
-
-'''
-
-=== `setCellColor(coordinate: xref:../../types/Coordinate.adoc[Coordinate], color: xref:../../enums/Color.adoc[Color]): void`
-
-Updates the visual color of the cell at the given coordinate.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`coordinate` |`xref:../../types/Coordinate.adoc[Coordinate]` |Target position.
-|`color` |`xref:../../enums/Color.adoc[Color]` |Enum value representing the new color.
-|===
-
-
-'''
-
-=== `isCellActive(coordinate: xref:../../types/Coordinate.adoc[Coordinate]): boolean`
-
-Returns `true` if the cell's value is greater than `0`.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`coordinate` |`xref:../../types/Coordinate.adoc[Coordinate]` |Point to check.
-|===
-
-**Returns**
-
-`boolean` - `true` if the cell value is greater than 0.
-
-
-'''
-
-=== `isCellInactive(coordinate: xref:../../types/Coordinate.adoc[Coordinate]): boolean`
-
-Returns `true` if the cell's value is `0`.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`coordinate` |`xref:../../types/Coordinate.adoc[Coordinate]` |Point to check.
-|===
-
-**Returns**
-
-`boolean` - `true` if the cell value is exactly 0.
-
-
-'''
-
-=== `isRowFull(y: number): boolean`
-
-Returns `true` if every cell in the specified row `y` is active.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`y` |`number` |Row index to check.
-|===
-
-**Returns**
-
-`boolean` - `true` if full.
-
-
-'''
-
-=== `isRowEmpty(y: number): boolean`
-
-Returns `true` if every cell in the specified row `y` is inactive.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`y` |`number` |Row index to check.
-|===
-
-**Returns**
-
-`boolean` - `true` if empty.
-
-
-'''
-
-=== `clearRow(y: number): void`
-
-Resets all cells in row `y` to their inactive state.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`y` |`number` |Row index to clear.
-|===
-
-
-'''
-
-=== `shiftRowsDown(fromY: number): void`
-
-Moves all rows above (and including) `fromY` down by one position.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`fromY` |`number` |The row index to start shifting from.
-|===
-
-
-'''
-
-=== `shiftRowsUp(fromY: number): void`
-
-Moves all rows below (and including) `fromY` up by one position.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`fromY` |`number` |The row index to start shifting from.
-|===
-
-
-'''
-
-=== `clearFullRows(): number`
-
-Detects, clears, and shifts rows for all full rows in the grid.
-
-**Returns**
-
-`number` - The total count of cleared rows.
-
-
-'''
-
-=== `isColumnFull(x: number): boolean`
-
-Returns `true` if every cell in column `x` is active.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`x` |`number` |Column index to check.
-|===
-
-**Returns**
-
-`boolean` - `true` if full.
-
-
-'''
-
-=== `isColumnEmpty(x: number): boolean`
-
-Returns `true` if every cell in column `x` is inactive.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`x` |`number` |Column index to check.
-|===
-
-**Returns**
-
-`boolean` - `true` if empty.
-
-
-'''
-
-=== `clearColumn(x: number): void`
-
-Resets all cells in column `x` to their inactive state.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`x` |`number` |Column index to clear.
-|===
-
-
-'''
-
-=== `shiftColumnsRight(fromX: number): void`
-
-Moves all columns to the left of `fromX` one position to the right.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`fromX` |`number` |The column index to start shifting from.
-|===
-
-
-'''
-
-=== `shiftColumnsLeft(fromX: number): void`
-
-Moves all columns to the right of `fromX` one position to the left.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`fromX` |`number` |The column index to start shifting from.
-|===
-
-
-'''
-
-=== `clearFullColumns(): number`
-
-Detects and clears all full columns.
-
-**Returns**
-
-`number` - The total count of cleared columns.
-
-
-'''
-
-=== `isAreaOccupied(coordinates: xref:../../types/Coordinate.adoc[Coordinate][]): boolean`
-
-Returns `true` if any of the provided coordinates are already active in the grid. Used for collision detection.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`coordinates` |`xref:../../types/Coordinate.adoc[Coordinate][]` |Array of `{x, y}` points representing a shape or piece.
-|===
-
-**Returns**
-
-`boolean` - `true` if occupied.
-
-
-'''
-
-=== `fillArea(start: xref:../../types/Coordinate.adoc[Coordinate], end: xref:../../types/Coordinate.adoc[Coordinate], value: number, color: xref:../../enums/Color.adoc[Color]): void`
-
-Batch updates a rectangular area defined by `start` and `end` with the given value and color.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`start` |`xref:../../types/Coordinate.adoc[Coordinate]` |Top-left corner of the rectangle.
-|`end` |`xref:../../types/Coordinate.adoc[Coordinate]` |Bottom-right corner of the rectangle.
-|`value` |`number` |Value to apply to all cells in the area.
-|`color` |`xref:../../enums/Color.adoc[Color]` |Color to apply to all cells in the area.
-|===
-
-
-'''
-
-=== `stampPiece(coordinates: xref:../../types/Coordinate.adoc[Coordinate][], value: number, color: xref:../../enums/Color.adoc[Color]): void`
-
-Applies the specified value and color to multiple discrete coordinates simultaneously.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`coordinates` |`xref:../../types/Coordinate.adoc[Coordinate][]` |Points to update.
-|`value` |`number` |New cell value.
-|`color` |`xref:../../enums/Color.adoc[Color]` |New cell color.
-|===
-
-
-== General Usage
-
-The `Grid` interface is implemented by both the main `xref:../../modules/GameGrid.adoc[GameGrid]` and the `xref:../../modules/GameHudGrid.adoc[GameHudGrid]`.

package/docs/reference/interfaces/modules/Renderer.adoc

@@ -1,34 +0,0 @@
-= Renderer Reference
-:description: Defines the core drawing contract for engine visual layers.
-:keywords: rendering, drawing, graphics, canvas
-:toc: left
-:toclevels: 3
-:sectnums:
-:sectlinks:
-:icons: font
-:source-highlighter: highlight.js
-:reproducible:
-:experimental:
-:idprefix:
-:idseparator: -
-
-Defines the core drawing contract for engine visual layers.
-
-== Methods
-
-=== `render(grid: xref:../../types/Cell.adoc[Cell][][], modules: xref:../GameModules.adoc[GameModules]): void`
-
-Executes the drawing logic for a single frame.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`grid` |`xref:../../types/Cell.adoc[Cell][][]` |The current state of the game grid.
-|`modules` |`xref:../GameModules.adoc[GameModules]` |Registry of all game modules.
-|===
-
-== General Usage
-
-Implemented by `xref:../../modules/DisplayRenderer.adoc[DisplayRenderer]` and `xref:../../modules/HudRenderer.adoc[HudRenderer]`. The engine's composite renderer iterates through all registered `Renderer` implementations and calls their `render` method 60 times per second.

package/docs/reference/interfaces/modules/RendererComposite.adoc

@@ -1,57 +0,0 @@
-= RendererComposite Reference
-:description: An advanced renderer that manages a collection of individual layers.
-:keywords: renderer, composite, layers, graphics, canvas
-:toc: left
-:toclevels: 3
-:sectnums:
-:sectlinks:
-:icons: font
-:source-highlighter: highlight.js
-:reproducible:
-:experimental:
-:idprefix:
-:idseparator: -
-
-An advanced renderer that manages a collection of individual layers.
-
-== Properties
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`rendererMetrics` |xref:../../types/RendererMetrics.adoc[RendererMetrics] |The geometric source of truth.
-|===
-
-== Methods
-
-=== `addRenderer(renderer: xref:Renderer.adoc[Renderer]): void`
-
-Attaches a new visual layer.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`renderer` |`xref:Renderer.adoc[Renderer]` |The renderer instance to add (e.g., Grid, HUD).
-|===
-
-
-'''
-
-=== `render(grid: xref:../../types/Cell.adoc[Cell][][], modules: xref:../GameModules.adoc[GameModules]): void`
-
-Orchestrates the rendering call for all layers.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`grid` |`xref:../../types/Cell.adoc[Cell][][]` |The current state of the game grid.
-|`modules` |`xref:../GameModules.adoc[GameModules]` |Registry of all game modules.
-|===
-
-== General Usage
-
-This interface is the entry point for the visual system. It ensures that the background, the game grid, and the HUD are drawn in the correct order and with synchronized metrics.

package/docs/reference/interfaces/modules/Score.adoc

@@ -1,107 +0,0 @@
-= Score Reference
-:description: Interface for tracking session performance, multipliers, and levels.
-:keywords: score, tracking, levels, metrics, multipliers
-:toc: left
-:toclevels: 3
-:sectnums:
-:sectlinks:
-:icons: font
-:source-highlighter: highlight.js
-:reproducible:
-:experimental:
-:idprefix:
-:idseparator: -
-
-Interface for tracking session performance, multipliers, and levels.
-
-== Properties
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`score` |`number` |The current total score for the session.
-|`multiplier` |`number` |The current points multiplier.
-|`level` |`number` |The current game difficulty level.
-|`maxLevel` |`number` |The maximum level achievable.
-|===
-
-== Methods
-
-=== `increaseScore(amount: number): void`
-
-Adds points to the total, automatically applying any active multipliers.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`amount` |`number` |The base points to add before multiplier.
-|===
-
-
-'''
-
-=== `resetScore(): void`
-
-Resets the session score to `0`.
-
-
-'''
-
-=== `getFormattedScore(digits?: number): string`
-
-Returns a string representation of the score padded with leading zeros (defaulting to 6 digits).
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`digits` |`number` |(Optional) The total length of the string. Defaults to 6.
-|===
-
-**Returns**
-
-`string` - The formatted score (e.g., "001500").
-
-
-'''
-
-=== `increaseLevel(amount: number): void`
-
-Increments the current game level up to `maxLevel`.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`amount` |`number` |Levels to increase by.
-|===
-
-
-'''
-
-=== `resetLevel(): void`
-
-Resets the game difficulty level to its initial value.
-
-
-'''
-
-=== `setState(state: xref:State.adoc[State]): void`
-
-Internal setup method to link the score module with high-score persistence logic.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`state` |`xref:State.adoc[State]` |The global state manager.
-|===
-
-== General Usage
-
-Implemented by `xref:../../modules/GameScore.adoc[GameScore]`. It handles the numeric progression of the game and formats the data for display on the HUD.

package/docs/reference/interfaces/modules/Session.adoc

@@ -1,66 +0,0 @@
-= Session Interface Reference
-:description: Defines the contract for the module responsible for managing game sessions and restoring serializable data.
-:keywords: interface, session, storage, save, serialization
-:toc: left
-:toclevels: 3
-:sectnums:
-:sectlinks:
-:icons: font
-
-The `Session` interface defines the core contract for the game's session orchestration. It handles restoring persistent `xref:../Serializable.adoc[Serializable]` data (such as progressive scores or active level states) and presenting UI mechanisms to the user when playing an existing session.
-
-This module is a core part of the `xref:GameModules.adoc[GameModules]` composite.
-
-== Attributes / Properties / Values
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`gameId` |`string` |The unique identifier of the game, provided by `xref:../../modules/Game.adoc[Game.gameId]`, used to prefix the LocalStorage entries.
-|===
-
-== API Reference
-
-'''
-
-=== `register(serializable: Serializable): void`
-
-Appends a module or instance that implements `Serializable` to the session's watch list.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`serializable` |`xref:../Serializable.adoc[Serializable]` |The instance implementing serialization capability.
-|===
-
-'''
-
-=== `saveSession(): void`
-
-Persists the current state of all registered `xref:../Serializable.adoc[Serializable]` instances to `localStorage`.
-
-'''
-
-=== `clearSession(): void`
-
-Clears out the active session data from `localStorage`, functionally resetting the user's progress for the given `gameId`.
-
-'''
-
-=== `setShowModalFunction(showModal: (onConfirm: () => void, onCancel: () => void) => void): void`
-
-Registers the callback that triggers the session recovery UI element.
-
-**Parameters**
-
-[cols="1,1,3"]
-|===
-|Name |Type |Description
-|`showModal` |`Function` |The callback that is executed, receiving the internal `onConfirm` and `onCancel` closure functions as arguments.
-|===
-
-== General Usage
-
-The `Session` module subscribes to the `GameState` lifecycle. Upon detecting a transition to the `PLAYING` state, if previous active records exist in `localStorage`, it invokes the modal logic set via `setShowModalFunction`. The engine's `Game` orchestrates this by default.