Class: exports

exports()

A component which represents a single, programmable game board.

Constructor

new exports()

Source:

Extends

  • Component

Members

bound_fns :Array.<function()>

Array of functions bound to event listeners. Used to remove event listeners on destroy.
Type:
  • Array.<function()>
Source:

bound_fns :Array.<function()>

Array of functions bound to event listeners. Used to remove event listeners on destroy.
Type:
  • Array.<function()>
Source:

column_labels :Array.<string>

The various column labels to display.
Type:
  • Array.<string>
Source:

column_labels :Array.<string>

The various column labels to display.
Type:
  • Array.<string>
Source:

current_opponent_display :string

The display name of the current opponent.
Type:
  • string
Source:

current_opponent_display :string

The display name of the current opponent.
Type:
  • string
Source:

current_placement :string

The ship currently being placed.
Type:
  • string
Source:

current_placement :string

The ship currently being placed.
Type:
  • string
Source:

current_player_display :string

The display name of the current player.
Type:
  • string
Source:

current_player_display :string

The display name of the current player.
Type:
  • string
Source:

current_state :GameState|undefined

The current game state.
Type:
Source:

current_state :GameState|undefined

The current game state.
Type:
Source:

GameState :object

Make the game state accessible w/in the template.
Type:
  • object
Source:

GameState :object

Make the game state accessible w/in the template.
Type:
  • object
Source:

GridCellState

Make the "GridCellState" enum available in the template.
Source:

GridCellState

Make the "GridCellState" enum available in the template.
Source:

instructions :string

The current instructions to be shown to the user.
Type:
  • string
Source:

instructions :string

The current instructions to be shown to the user.
Type:
  • string
Source:

opponent_rows :Array.<Array.<object>>

The opponent's grid data.
Type:
  • Array.<Array.<object>>
Source:

opponent_rows :Array.<Array.<object>>

The opponent's grid data.
Type:
  • Array.<Array.<object>>
Source:

player_is_firing_missiles :boolean

True if the player should be able to fire missiles at their opponent.
Type:
  • boolean
Source:

player_is_firing_missiles :boolean

True if the player should be able to fire missiles at their opponent.
Type:
  • boolean
Source:

player_is_placing_ships :boolean

True if the player should be able to place their ships.
Type:
  • boolean
Source:

player_is_placing_ships :boolean

True if the player should be able to place their ships.
Type:
  • boolean
Source:

player_rows :Array.<Array.<object>>

The player's grid data.
Type:
  • Array.<Array.<object>>
Source:

player_rows :Array.<Array.<object>>

The player's grid data.
Type:
  • Array.<Array.<object>>
Source:

ready :boolean

If true, the grid is ready to be rendered. If false, the grid will be hidden.
Type:
  • boolean
Source:

ready :boolean

If true, the grid is ready to be rendered. If false, the grid will be hidden.
Type:
  • boolean
Source:

shift_pressed :boolean

Set to true when the shift key is pressed.
Type:
  • boolean
Source:

shift_pressed :boolean

Set to true when the shift key is pressed.
Type:
  • boolean
Source:

ship_ghost_cells :Array.<number>

Array of coordinates as [row_index, column_index] of cells which should show a ghost ship overlay.
Type:
  • Array.<number>
Source:

ship_ghost_cells :Array.<number>

Array of coordinates as [row_index, column_index] of cells which should show a ghost ship overlay.
Type:
  • Array.<number>
Source:

ships_to_place :Array.<ShipType>

If in placement mode, the ships that are yet to be placed.
Type:
Source:

ships_to_place :Array.<ShipType>

If in placement mode, the ships that are yet to be placed.
Type:
Source:

exports()

A component which represents a single, programmable game board.

Constructor

new exports()

Source:

Extends

  • Component

Members

bound_fns :Array.<function()>

Array of functions bound to event listeners. Used to remove event listeners on destroy.
Type:
  • Array.<function()>
Source:

bound_fns :Array.<function()>

Array of functions bound to event listeners. Used to remove event listeners on destroy.
Type:
  • Array.<function()>
Source:

column_labels :Array.<string>

The various column labels to display.
Type:
  • Array.<string>
Source:

column_labels :Array.<string>

The various column labels to display.
Type:
  • Array.<string>
Source:

current_opponent_display :string

The display name of the current opponent.
Type:
  • string
Source:

current_opponent_display :string

The display name of the current opponent.
Type:
  • string
Source:

current_placement :string

The ship currently being placed.
Type:
  • string
Source:

current_placement :string

The ship currently being placed.
Type:
  • string
Source:

current_player_display :string

The display name of the current player.
Type:
  • string
Source:

current_player_display :string

The display name of the current player.
Type:
  • string
Source:

current_state :GameState|undefined

The current game state.
Type:
Source:

current_state :GameState|undefined

The current game state.
Type:
Source:

GameState :object

Make the game state accessible w/in the template.
Type:
  • object
Source:

GameState :object

Make the game state accessible w/in the template.
Type:
  • object
Source:

GridCellState

Make the "GridCellState" enum available in the template.
Source:

GridCellState

Make the "GridCellState" enum available in the template.
Source:

instructions :string

The current instructions to be shown to the user.
Type:
  • string
Source:

instructions :string

The current instructions to be shown to the user.
Type:
  • string
Source:

opponent_rows :Array.<Array.<object>>

The opponent's grid data.
Type:
  • Array.<Array.<object>>
Source:

opponent_rows :Array.<Array.<object>>

The opponent's grid data.
Type:
  • Array.<Array.<object>>
Source:

player_is_firing_missiles :boolean

True if the player should be able to fire missiles at their opponent.
Type:
  • boolean
Source:

player_is_firing_missiles :boolean

True if the player should be able to fire missiles at their opponent.
Type:
  • boolean
Source:

player_is_placing_ships :boolean

True if the player should be able to place their ships.
Type:
  • boolean
Source:

player_is_placing_ships :boolean

True if the player should be able to place their ships.
Type:
  • boolean
Source:

player_rows :Array.<Array.<object>>

The player's grid data.
Type:
  • Array.<Array.<object>>
Source:

player_rows :Array.<Array.<object>>

The player's grid data.
Type:
  • Array.<Array.<object>>
Source:

ready :boolean

If true, the grid is ready to be rendered. If false, the grid will be hidden.
Type:
  • boolean
Source:

ready :boolean

If true, the grid is ready to be rendered. If false, the grid will be hidden.
Type:
  • boolean
Source:

shift_pressed :boolean

Set to true when the shift key is pressed.
Type:
  • boolean
Source:

shift_pressed :boolean

Set to true when the shift key is pressed.
Type:
  • boolean
Source:

ship_ghost_cells :Array.<number>

Array of coordinates as [row_index, column_index] of cells which should show a ghost ship overlay.
Type:
  • Array.<number>
Source:

ship_ghost_cells :Array.<number>

Array of coordinates as [row_index, column_index] of cells which should show a ghost ship overlay.
Type:
  • Array.<number>
Source:

ships_to_place :Array.<ShipType>

If in placement mode, the ships that are yet to be placed.
Type:
Source:

ships_to_place :Array.<ShipType>

If in placement mode, the ships that are yet to be placed.
Type:
Source: