eecs-448-pixelland 1.0.0

eecs-448-pixelland

1.0.0

Controls ▸
- Static members
- .movementKeys
- .zoomKeys
- .inventoryKeys
- .keyMapper
- .toggleKeys
- .Set
- .render
- .render
- .handleKeyPress
- .getMovementDirection
Grid ▸
- Static members
- .destructorCalled
- .cellSize
- .context
- .needRedraw
- .movementDirection
- .renderedFrameCount
- .paused
- .coordinates
- .cellCount
- .halfCellCount
- .centerCellCoordinates
- .render
- .drawCell
- .draw
- .handleCellResize
- .recalculateCenter
- .recalculateDecimalCoordinates
- .handleMovementChange
- .handleBlockChange
- .startMovement
- .pxToCoordinates
Inventory ▸
- Static members
- .overlay
- .currentToolbarBlock
- .currentInventoryBlock
- .isOpen
- .toolbar
- .render
- .toggleOverlay
- .deselectInventoryBlock
- .selectInventoryBlock
- .deselectToolbarBlock
- .selectToolbarBlock
- .setToolbarBlock
- .handleToolbarSelected
- .handleCellSelect
Map ▸
- Static members
- .seed
- .map
- .mapType
- .mapChanged
- .didMapChange
- .render
- .getDeterministicRandom
- .getCellAtCoordinate
- .generateCell
- .setBlockAtCoordinates
MinecraftMap ▸
- Static members
- .generateCell
MouseControls
PauseMenu ▸
- Static members
- .loadButton
- .render
- .person
Person ▸
- Static members
- .render
RainbowlandMap ▸
- Static members
- .generateCell
- .randomTeleport
SaveLoad ▸
- Static members
- .version
- .save
- .load
TestMap ▸
- Static members
- .render
- .handleInputChange
- .generateCell
TextureCache ▸
- Static members
- .render
- .handleCellResize
Component
getHash
Crypto
Utils
View ▸
- Static members
- .name
- .destructors
- .hasContainer
- .index
- .activeViews
- .viewTemplate
- .render
CanvasView ▸
- Static members
- .canvas
- .grid
- .cellSize
- .cellSizeUpdateListeners
- .player
- .controls
- .map
- .pauseMenu
- .saveLoad
- .render
- .handleResize
- .handlePauseMenuInteraction
GameOverView ▸
- Static members
- .render
MapSetupView ▸
- Static members
- .render
- .handleClick
- .handleClick
MenuView ▸
- Static members
- .saveLoad
- .render

Need help reading this?

Controls

Handle game control keys

new Controls(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ movementKeys

Sets movement keys

movementKeys

Type: Set

Parameters

up (String) key up

down (String) key down

left (String) key left

right (String) key right

▸ zoomKeys

Sets zoom keys

zoomKeys

Type: Set

Parameters

zoomReset (String) zoom reset key

zoomOut (String) zoom out key

zoomIn (String) zoom in key

▸ inventoryKeys

Sets inventory keys

inventoryKeys

Type: Set

Parameters

slotN (String) nth slot [0-9]

▸ keyMapper

Maps keys with the in-game function key equivalent

keyMapper

Parameters

keys (json)

Name	Description
keys.KeyW `String`	"up"
keys.KeyS `String`	"down"
keys.KeyA `String`	"left"
keys.KeyD `String`	"right"
keys.ArrowUp `String`	"up"
keys.ArrowDown `String`	"down"
keys.ArrowLeft `String`	"left"
keys.ArrowRight `String`	"right"
keys.KeyK `String`	"up"
keys.KeyJ `String`	"down"
keys.KeyH `String`	"left"
keys.KeyL `String`	"right"
keys.Escape `String`	"escape"

▸ toggleKeys

Maps keys toggle

toggleKeys

Parameters

toggleKey (json)

Name	Description
toggleKey.Escape `String`	"escape"

▸ Set

Set

Type: Set

▸ render()

Handle render-related functionality for controls

render()

▸ render()

Handle render-related functionality for controls

render()

▸ handleKeyPress()

handleKeyPress()

▸ getMovementDirection()

getMovementDirection()

Grid

Draw current player / NPC

new Grid(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ destructorCalled

destructorCalled

Type: Boolean

▸ cellSize

This gets overridden after render

cellSize

Type: Integer

▸ context

context

Type: Context

▸ needRedraw

needRedraw

Type: Boolean

▸ movementDirection

movementDirection

Type: Array

▸ renderedFrameCount

renderedFrameCount

Type: Integer

▸ paused

paused

Type: Boolean

▸ coordinates

Real player coordinates (1000 = 1 block)

coordinates

Type: Array

▸ cellCount

Cell count

cellCount

Type: object

▸ halfCellCount

Cell count / 2

halfCellCount

Type: object

▸ centerCellCoordinates

Coordinates of the center cell within the viewport

centerCellCoordinates

Type: object

▸ render(container)

render(container: any)

Parameters

container (any) Container to render the view within

▸ drawCell(columnIndex, rowIndex)

drawCell(columnIndex: any, rowIndex: any)

Parameters

columnIndex (any) relative column index

rowIndex (any) relative row index

▸ draw()

draw()

▸ handleCellResize(cellSize)

handleCellResize(cellSize: any)

Parameters

cellSize (any) size of game cell in viewport (relative size)

▸ recalculateCenter(dimensions)

recalculateCenter(dimensions: any)

Parameters

dimensions (any) width x height

▸ recalculateDecimalCoordinates()

recalculateDecimalCoordinates()

▸ handleMovementChange()

handleMovementChange()

▸ handleBlockChange()

handleBlockChange()

▸ startMovement()

startMovement()

▸ pxToCoordinates(x, y)

pxToCoordinates(x: any, y: any)

Parameters

x (any) X coordinate

y (any) Y coordinate

Inventory

Draw player inventory

new Inventory(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ overlay

overlay

Type: object

▸ currentToolbarBlock

currentToolbarBlock

Type: object

▸ currentInventoryBlock

currentInventoryBlock

Type: object

▸ isOpen

isOpen

Type: Boolean

▸ toolbar

toolbar

Type: object

▸ render(container)

render(container: any)

Parameters

container (any) Container to render the view within

▸ toggleOverlay()

toggleOverlay()

▸ deselectInventoryBlock()

deselectInventoryBlock()

▸ selectInventoryBlock(cell)

selectInventoryBlock(cell: any)

Parameters

cell (any)

▸ deselectToolbarBlock()

deselectToolbarBlock()

▸ selectToolbarBlock(cell)

selectToolbarBlock(cell: any)

Parameters

cell (any)

▸ setToolbarBlock(slot, cell)

setToolbarBlock(slot: any, cell: any)

Parameters

slot (any)

cell (any)

▸ handleToolbarSelected(index)

handleToolbarSelected(index: any)

Parameters

index (any)

▸ handleCellSelect()

handleCellSelect()

Map

Draw current player / NPC

new Map(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ seed

seed

Type: String

▸ map

map

Type: Array

▸ mapType

mapType

Type: String

▸ mapChanged

mapChanged

Type: Boolean

▸ didMapChange()

didMapChange(): Boolean

Returns

Boolean: mapChanged

▸ render()

render()

▸ getDeterministicRandom(salt, max)

getDeterministicRandom(salt: any, max: any)

Parameters

salt (any) salt based on position on map row, column

max (any) prevent huge seed

▸ getCellAtCoordinate(col, row)

getCellAtCoordinate(col: any, row: any)

Parameters

col (any) column of cell at coordinate

row (any) row of cell at coordinate

▸ generateCell(col, row)

generateCell(col: any, row: any)

Parameters

col (any) column for cell gen

row (any) row for cell gen

▸ setBlockAtCoordinates(x, y, block)

setBlockAtCoordinates(x: any, y: any, block: any)

Parameters

x (any) X coordinate

y (any) Y coordinate

block (any) block to be placed

MinecraftMap

Draw Minecraft-styled map

new MinecraftMap(options: any)

Extends Map

Parameters

options (any)

Static Members

▸ generateCell(col, row)

generateCell(col: any, row: any)

Parameters

col (any) column for cell gen

row (any) row for cell gen

MouseControls

Handle game control keys

new MouseControls(options: any)

Extends Component

Parameters

options (any)

PauseMenu

Handle game pause functions

new PauseMenu(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ loadButton

loadButton

Type: Button

▸ render(container)

render(container: any)

Parameters

container (any) Container to render the view within

▸ person

person

Type: Person

Person

Draw current player / NPC

new Person(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ render(container)

render(container: any)

Parameters

container (any) Container to render the view within

RainbowlandMap

Draw Rainbow-styled map

new RainbowlandMap(options: any)

Extends Map

Parameters

options (any)

Static Members

▸ generateCell(col, row)

generateCell(col: object, row: object)

Parameters

col (object)

row (object)

▸ randomTeleport(object)

randomTeleport(object: any)

Parameters

object (any)

SaveLoad

Handle context saving and loading

new SaveLoad(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ version

version

Type: String

▸ save(object)

save(object: any)

Parameters

object (any) JS object to be stored

▸ load()

load()

TestMap

Draw a test map environment

new TestMap(options: any)

Extends Map

Parameters

options (any)

Static Members

▸ render()

render()

▸ handleInputChange()

handleInputChange()

▸ generateCell(row, col)

generateCell(row: any, col: any)

Parameters

row (any) row for cell gen

col (any) column for cell gen

TextureCache

Resize the textures to correct size once after every screen resolution change, rather than on every render

new TextureCache(options: any)

Extends Component

Parameters

options (any)

Static Members

▸ render()

render()

▸ handleCellResize(cellSize)

handleCellResize(cellSize: any)

Parameters

cellSize (any) size of game cell in viewport (relative size)

Component

Base class for components

new Component(renderOptions: any)

Extends View

Parameters

renderOptions (any)

getHash

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

getHash(string: any, algorithm: any)

Parameters

string (any) String to encode

algorithm (any) Algorithm to use

Crypto

Crypt functions

Crypto

Utils

Utility functions

Utils

View

Base class for views

new View(options: options, templateDirectory: any)

Parameters

options (options)

templateDirectory (any)

Static Members

▸ name

View Name

name

Type: String

▸ destructors

Destructors

destructors

Type: Array

▸ hasContainer

hasContainer

Type: Boolean

▸ index

Total count of rendered views

index

Type: Number

▸ 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

CanvasView

Base CanvasView class

new CanvasView(options: any)

Extends View

Parameters

options (any)

Static Members

▸ canvas

canvas

Type: Object

▸ grid

grid

Type: Object

▸ cellSize

cellSize

Type: Object

▸ cellSizeUpdateListeners

cellSizeUpdateListeners

Type: Array

▸ player

player

Type: Object

▸ controls

controls

Type: Object

▸ map

map

Type: Object

▸ pauseMenu

pauseMenu

Type: Object

▸ saveLoad

saveLoad

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

▸ handleResize()

handleResize()

▸ handlePauseMenuInteraction(action)

handlePauseMenuInteraction(action: any)

Parameters

action (any) string description of action case

GameOverView

Base GameOverView class

new GameOverView(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

MapSetupView

Base MapSetupView class

new MapSetupView(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: json)

Parameters

target (json)

Name	Description
target.button `any`	button

▸ handleClick(target)

Click handling

handleClick(target: json)

Parameters

target (json)

Name	Description
target.button `any`	button

MenuView

Base MenuView class

new MenuView(options: any)

Extends View

Parameters

options (any)

Static Members

▸ saveLoad

saveLoad

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