eecs-448-battleship 1.0.0

eecs-448-battleship

1.0.0

Board ▸
- Static members
- .onClick
- .events
- .render
- .remove
Fleet ▸
- Static members
- .render
- .remove
Component
Utils ▸
- Static members
- .getNthLetter
- .getElementIndex
- .shipCellCount
- .getNeighbourCells
- .getAllNeighbourCells
View ▸
- Static members
- .name
- .index
- .activeViews
- .viewTemplate
- .render
GameBoardView ▸
- Static members
- .render
- .render
- .turn
- .handleBoardClick
- .promptUser
- .checkOffenceResult
- .findShip
- .addBorder
- .checkWin
- .remove
GameOverView ▸
- Static members
- .remove
MainView ▸
- Static members
- .render
- .handleClick
- .remove
ShipPlacementView ▸
- Static members
- .render
- .handleSelectedShipChange
- .handleRotateShip
- .handleBoardCellOver
- .handleBoardCellOut
- .handleBoardCellClick
- .handleFinishPlacement
- .remove

Need help reading this?

Board

Base board class

new Board(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ onClick

Relevant class event listeners

onClick

Type: object

Parameters

onMouseOver (any) mouse over event listener

onMouseOut (any) mouse over event listener

onClick (any) mouse over event listener

▸ events

Relevant class events

events

Type: object

▸ render(container)

Renders a defined view into a container. Passes in necessary, predefined render parameters.

render(container: any)

Parameters

container (any) Container to render the view within

▸ remove()

View remove function for ephemeral objects, ie. eventListeners

remove()

Fleet

Base fleet class

new Fleet(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ render(container)

Renders a defined view into a container. Passes in necessary, predefined render parameters.

render(container: any)

Parameters

container (any) Container to render the view within

▸ remove()

View remove function for ephemeral objects, ie. eventListeners

remove()

Component

Base class for components

new Component(renderOptions: any)

Parameters

renderOptions (any)

Utils

Utility functions

Utils

Static Members

▸ getNthLetter(index)

Gets indexed letter

getNthLetter(index: any)

Parameters

index (any)

▸ getElementIndex(element)

Gets element index from array

getElementIndex(element: any)

Parameters

element (any)

▸ shipCellCount(numberOfShip)

Gets ship length

shipCellCount(numberOfShip: any)

Parameters

numberOfShip (any)

▸ getNeighbourCells(row, col)

Gets surrounding neighbor cells of single cell

getNeighbourCells(row: any, col: any)

Parameters

row (any) row count

col (any) column count

▸ getAllNeighbourCells(row, col)

Gets all cells on request

getAllNeighbourCells(row: any, col: any)

Parameters

row (any) row count

col (any) column count

View

Base class for views

new View(options: options, templateDirectory: any)

Parameters

options (options)

templateDirectory (any)

Static Members

▸ name

View Name

name

▸ index

Total count of rendered views

index

▸ activeViews

Record<id, view> of currently visible views

activeViews

Type: object

▸ viewTemplate

Record<viewName, string|Promise> of view templates

viewTemplate

Type: object

▸ render(container)

Renders a defined view into a container. Passes in necessary, predefined render parameters.

render(container: any)

Parameters

container (any) Container to render the view within

GameBoardView

Base GameBoard class

new GameBoardView(options: any)

Extends View

Parameters

options (any)

Static Members

▸ render(container)

Renders a defined view into a container. Passes in necessary, predefined render parameters.

render(container: any)

Parameters

container (any) Container to render the view within

▸ render(container)

Renders a defined view into a container. Passes in necessary, predefined render parameters.

render(container: any)

Parameters

container (any) Container to render the view within

▸ turn(player)

Player turn message handling

turn(player: any)

Parameters

player (any) 'player'|'opponent' for message variations

▸ handleBoardClick(owner, event)

Board click event handler

handleBoardClick(owner: any, event: any)

Parameters

owner (any) 'player'|'opponent' - whose board was clicked

event (any) event to log

▸ promptUser(question, buttonLeftText, buttonRightText, callback)

User prompt handler for messaging.

promptUser(question: any, buttonLeftText: any, buttonRightText: any, callback: any)

Parameters

question (any) current question string

buttonLeftText (any) option one button text string

buttonRightText (any) option two button text string

callback (any) function, click handling

▸ checkOffenceResult(row, col, cell)

Function to check results of offensive player game.

checkOffenceResult(row: any, col: any, cell: any)

Parameters

row (any)

col (any)

cell (any)

▸ findShip(row, col)

Find ship on gameboard

findShip(row: any, col: any)

Parameters

row (any)

col (any)

▸ addBorder()

Add gameboard view border

addBorder()

▸ checkWin(owner)

Check if player is victorious

checkWin(owner: any)

Parameters

owner (any)

▸ remove()

View remove function for ephemeral objects, ie. eventListeners

remove()

GameOverView

Base GameOverView class

new GameOverView(options: any)

Extends View

Parameters

options (any)

Static Members

▸ remove()

View remove function for ephemeral objects, ie. eventListeners

remove()

MainView

Base MainView class

new MainView(options: any)

Extends View

Parameters

options (any)

Static Members

▸ render(container)

Renders a defined view into a container. Passes in necessary, predefined render parameters.

render(container: any)

Parameters

container (any) Container to render the view within

▸ handleClick(target)

Click handling

handleClick(target: any)

Parameters

target (any)

▸ remove()

View remove function for ephemeral objects, ie. eventListeners

remove()

ShipPlacementView

Base ShipPlacementView class

new ShipPlacementView(options: any)

Extends View

Parameters

options (any)

Static Members

▸ render(container)

Renders a defined view into a container. Passes in necessary, predefined render parameters.

render(container: any)

Parameters

container (any) Container to render the view within

▸ handleSelectedShipChange(target)

Handle changing a selected ship

handleSelectedShipChange(target: object)

Parameters

target (object)

▸ handleRotateShip()

Ship rotation handling for ship placement

handleRotateShip()

▸ handleBoardCellOver(options, row, column)

Handle mouse over cell

handleBoardCellOver(options: any, row: any, column: any)

Parameters

options (any)

row (any)

column (any)

▸ handleBoardCellOut()

Handle mouse leaving cell

handleBoardCellOut()

▸ handleBoardCellClick()

Click handling for cells / placement

handleBoardCellClick()

▸ handleFinishPlacement()

Render game board once finished

handleFinishPlacement()

▸ remove()

View remove function for ephemeral objects, ie. eventListeners

remove()