Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 6.2 KB

custom-game.md

File metadata and controls

100 lines (75 loc) · 6.2 KB
Raw

Custom games

The game object

We can define a custom game by creating an object with the following possible keys:

  • gameOptions: An object with possible keys:
    • winConditionFnName: The function name in WinCondition.js. Specifies the win condition of a game.
    • loseConditionFnName: The function name in LoseCondition.js. Specifies the lose condition of a game.
  • gridOptions: An object with possible keys:
    • newTileFnName: The function name in NewTile.js. Specifies how to add new tiles after each move, supporting the addition of multiple tiles.
    • mergeResultFnName: The function name in MergeResult.js. Specifies the new tile value obtained from merging all tiles in a cell.
    • mergeScoreFnName: The function name in MergeScore.js. Specifies the extra score obtained from merging all tiles in a cell.
    • mergeConditionFnName: The function name in MergeCondition.js. Specifies when two or more tiles can merge. The first parameter corresponds to the tile closest to the edge in the slide direction.
    • gridBooleanFnName: The function name in GridBoolean.js. Specifies a two-dimensional rectangular boolean array that represents the rows of the board. A value of 1 indicates that the corresponding cell is enabled and can accept tiles, while a value of 0 indicates a disabled cell where tiles cannot occupy or slide through. Disabled cells will display as squares with black background and a white border.
    • minMergeLength: The minimum number of tiles that can be merged into one. Defaults to 2 if not defined.
    • maxMergeLength: The maximum number of tiles that can be merged into one. Needs to be >=minMergeLength and defaults to the maximum row or column length if not defined.
    • mergeStrategy: Accepts two possible values: shortest-match and longest-match. When set to shortest-match, the algorithm will merge the shortest sequence of tiles that meet the merge condition. When set to longest-match, it will merge the longest sequence of tiles that meet the merge condition, even if there are shorter sequences that also match the condition. Defaults to shortest-match if not defined.
  • initialTiles: An array of initial tiles. Each tile should be an object with the following required keys:
    • row: Row of the tile.
    • column: Column of the tile.
    • value: The tile value.

If a key isn't defined, the values will default to those of the classic 2048 game. The corresponding functions are listed in the files mentioned above under the original2048 name.

Merging

The algorithm starts by forming sequences of consecutive tiles (tiles that are only separated by empty cells) from the edge closest to the slide direction. The sequences must include the first tile and meet the minMergeLength and maxMergeLength conditions. If mergeStrategy is set to shortest-match, the first sequence that satisfies the criteria specified by the function mergeConditionFnName will be merged into one. If mergeStrategy is set to longest-match, the longest sequence will be merged into one. If such a sequence is found and merged, the algorithm repeats the procedure with the remaining tiles. If no such sequences are found, the algorithm discards the first tile from the search process and repeats the procedure with the remaining tiles.

Board

We can customize the appearance and behavior of the board by defining the following custom properties in the root element of board.css.

  • --cell-size: Size of each cell. Default is 4.5rem.
  • --cell-gap: Gap size between cells. Default is 0.25rem.
  • --tile-font-scale-factor: Adjust this to control the font size of all tiles. Default is 0.39.
  • --cell-border-radius: Border radius of cells and board. Default is 0.25rem.
  • --horizontal-slide-duration: Duration of a slide across the horizontal axis. Default is 125ms.
  • --vertical-slide-duration: Duration of a slide across the vertical axis. Default is 125ms.
  • --zoomin-duration: Duration of the animation for merging and adding new tiles. Default is 125ms.

Tile fonts

The font size of each tile is handled automatically based on the length of the tile value, with a maximum supported length of 10. This setting can be modified by adding extra classes in board.css and modifying the function _initializeTile in BoardView.js.

Tile colors

Tile colors are handled automatically. Instead of always assigning the same color to a specific value, the app only ensures that all tiles with the same value share the same color. As a result, the board's coloring works properly in custom-defined games that use different tile values than those in the classic 2048 game.

All colors are defined in BoardViewColorModel.js as an array. The last value in the array corresponds to a tile with a white background and black font color. This entry is used for a tile in a board that is already using all previous colors.

Custom game - Example

We would like to create a game with the following options:

  • The win condition is reaching tile 32.
  • The board size is 3 x 3, with the center cell missing.
  • The top left corner has a tile with a value of 2.

To accomplish this, we define in WinCondition.js:

static hasTile32(grid) {
  return grid.hasTile(32)
}

and in GridBoolean.js:

static threeByThreeNoCenter() {
  return [[1, 1, 1],
          [1, 0, 1],
          [1, 1, 1]]
}

We can now define the custom game as:

game = {
  gameOptions: {
    winConditionFnName: 'hasTile32'
  },
  gridOptions: {
    gridBooleanFnName: 'threeByThreeNoCenter'
  },
  initialTiles: [
    {row: 0, column: 0, value: 2}
  ]
}

and pass it as an argument to the startGame function in script.js like so:

view.bindStartNewGame(() => {
  startGame({game})
})