Skip to content
This repository has been archived by the owner on Dec 12, 2022. It is now read-only.

Latest commit

 

History

History
207 lines (153 loc) · 6.48 KB

README.md

File metadata and controls

207 lines (153 loc) · 6.48 KB
Raw

ARCHIVED / DEPRECATED

TetrisJS

The TetrisJS framework abstracts the controller logic of Tetris without touching the view layer (DOM). It adheres to Classical Tetris rules which do not include things such as gravity or score combos. There is an extensive example on how to use the framework in the examples folder.

Usage

Include the tetris.min.js file into the head of your document. Then the window.tetris object will then be available for use.

<script type="text/javascript" src="scripts/tetris.min.js"></script>

Terminology

  • Tetrimino - There are seven types of tetriminos I, T, O, S, Z, J, L and they represent the shape they create.
  • Mino - Single square on the board.
  • Hard Drop - When the currently falling tetrimino instantly drops to its lowest point.
  • Block Out - When a mino of the tetrimino is outside the board when it lands, signaling the end of a game.

Example

There is a full working example using the TetrisJS framework under examples/basicExample.html. However here is a small snippet to see what the pattern is.

//Bind to the event listeners
tetris.onMove(function(tetrimino){
	//Render the tetrimino the board
}).onMatrix(function(boardMatrix){
	//Rerender the entire board
});

//Bind tetris actions to key strokes - (example uses jQuery)
$(document).keydown(function(e){
	switch(e.keyCode){
		case 37:	tetris.moveLeft();		break;
		case 38:	tetris.rotateRight();	break;
		case 39:	tetris.moveRight();		break;
	}
});

Event Listeners

All event listeners return the tetris object so that they can be chained. For example tetris.onLevelUp().onBlockOut();

  • onMove(tetrimino, oldTetrimino)

    • Description - Binds to move event of the falling tetrimino. This event is fired when the tetrimino rotates, moves horizontally, or drops.
    • Parameters
      • tetrimino - {type:"Z",minos:[{row:1,col:5},...]}
      • oldTetrimino - {type:"Z",minos:[{row:1,col:5},...]}

  • onMatrix(boardMatrix)

    • Description - Binds to full matrix changes. These occur when a tetrimino is added to the board or the board is cleared.
    • Parameters
      • boardMatrix - [["Z","I","","",...],...] - This is a 2D array ([rows][cols]) showing which mino is in every space of the board.

  • onClearLines(lines,totalLines,boardMatrix)

    • Description - Binds to the clear lines event. This occurs after a tetrimino is placed on the board, and if a row is complete.
    • Parameters
      • lines - The number of lines currently cleared in this event (Range: 1-4).
      • totalLines - The total number of lines cleared throughout the game.
      • boardMatrix - Same parameter as onMatrix

  • onLevelUp(level)

    • Description - Binds to the "level up" event. This event occurs after a certain number of lines have been cleared.
    • Parameters
      • level - The new level (Range: 0-n)

  • onBlockOut()

    • Description - Binds to the block off the board event. When this event fires, the game is over.
    • Parameters
      • None

  • onGhost(ghost, oldGhost)

    • Description - Binds to the ghost change event. This event fires when a new tetrimino begins to drop, is rotated, or moves horizontally.
    • Parameters
      • ghost - {type:"Z",minos:[{row:1,col:5},...]}
      • oldGhost - {type:"Z",minos:[{row:1,col:5},...]}

  • onPause()

    • Description - Binds the pause event. This event is fired when togglePause method is called.
    • Parameters
      • None

  • onPlay()

    • Description - Binds the play event. This event is fired when togglePause method is called.
    • Parameters
      • None

  • onQueue(nextTetrimino)

    • Description - Binds to the queue updated event. This event is fired when the piece from the queue now becomes the active one.
    • Parameters
      • nextTetrimino - {type:"Z",matrix:[[true,false,false,...],...]} - The matrix return parameter represents a square (2x2, 3x3, or 4x4) of the shape of the tetrimino.

  • onScore(score, oldScore)

    • Description - Binds to the score changed event. This event is fired when the score gets updated by completing lines or dropping pieces.
    • Parameters
      • score - The total new score.
      • oldScore - The previous total score - used to determine the difference.

Actions

All of the action methods will return the tetris object so that they can be chained as well.

  • newGame(level)

    • Description - Resets the board, timer, lines, score, and starts a new game
    • Parameters
      • level - Specifies which level to start at. Range: 0-n

  • moveLeft()

    • Description - Moves the currently falling tetrimino one block to the left if possible.
    • Parameters
      • None

  • moveRight()

    • Description - Moves the currently falling tetrimino one block to the right if possible.
    • Parameters
      • None

  • hardDrop()

    • Description - Drops the currently falling tetrimino as far as it can go. This is also the same position as the ghost.
    • Parameters
      • None

  • softDrop()

    • Description - Drops the currently falling tetrimino one space down.
    • Parameters
      • None

  • rotateRight()

    • Description - Rotates the currently falling tetrimino in a clockwise direction.
    • Parameters
      • None

  • rotateLeft()

    • Description - Rotates the currently falling tetrimino in a counter-clockwise direction.
    • Parameters
      • None

  • togglePause()

    • Description - Pauses and un-pauses the game.
    • Parameters
      • None

  • toggleHold()

    • Description - Toggles placing a hold on the queue so that the next falling tetrimino will be a random new one and the queue will remain the same.
    • Parameters
      • None

Helpers

These helper methods are optional and do not necessarily need to be used since everything can be accomplished using the event listeners. See the example for further details.

  • getScore()

    • Description - Returns the current total score of the game.
    • Parameters
      • None

  • getLevel()

    • Description - Returns the current level of the game.
    • Parameters
      • None

  • getLines()

    • Description - Returns the total number of cleared lines from the current game.
    • Parameters
      • None

  • getBoard()

    • Description - Returns the full boardMatrix object.
    • Parameters
      • None

  • getTetriminoType()

    • Description - Returns the currently falling tetrimino type.
    • Parameters
      • None

  • isOnHold()

    • Description - Returns a boolean indicating if the queue is on hold.
    • Parameters
      • None

  • getTimer()

    • Description - Returns the timer object.
    • Parameters
      • None