Have opinions about JavaScript? We want to hear them. Take the 2018 JavaScript Ecosystem Survey »

tris3d-canvas

0.12.0 • Public • Published

tris3d-canvas

is a canvas to play tic tac toe in 3d

Installation | API | License

NPM version JavaScript Style Guide

Installation

With npm do

npm install three tris3d-canvas

Note that three.js is required as a peer dependency.

API

See online example or do the following to run example.js

npm install
npm start

const tris3dCanvas = new Tris3dCanvas(canvasId, opts)

Constructor to create an instance of Tris3dCanvas.

Create a canvas with attribute id, inside a div container with display: block style

<div style="display: block">
  <canvas id="demo"></canvas>
</div>

Then create a Tris3dCanvas object

const tris3dCanvas = new Tris3dCanvas('demo')

Optional parameters are accepted after canvasId, constructor signature is the following:

  • @param {String} id of canvas element
  • @param {Object} [opt] optional parameters
  • @param {Array} [opt.playerColors] are three colors, like 0xff0000
  • @param {Array} [opt.backgroundColor] defaults to 0xffffff

tris3dCanvas.localPlayerIndex

Can be 0, 1, 2. Defaults to 0, which means the local player moves first.

tris3dCanvas.on('localPlayerTurnEnds', () => {})

Listen to localPlayerTurnEnds event.

tris3dCanvas.on('localPlayerTurnStarts', () => {})

Listen to localPlayerTurnStarts event.

tris3dCanvas.on('nextPlayer', (playerIndex) => {})

Listen to nextPlayer event.

tris3dCanvas.on('nobodyWins', () => {})

Listen to nobodyWins event.

tris3dCanvas.on('setChoice', (cubeIndex) => {})

Listen to setChoice event.

tris3dCanvas.on('tris3d!', (winnerPlayerIndex, winningCombinations) => {})

Listen to tris3d! event.

tris3dCanvas.render()

Start rendering the 3d scene.

tris3dCanvas.setChoice(playerIndex, cubeIndex)

Set player choice.

tris3dCanvas.resetPlayground()

Reset playground without start playing a new match.

tris3dCanvas.startNewMatch()

Start a brand new match

License

MIT

Keywords

install

npm i tris3d-canvas

Downloadsweekly downloads

73

version

0.12.0

license

MIT

homepage

g14n.info

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability