JSDoc: Class: Room

Constructor

new Room(cols, rows, globalPos)

Constructor for the room class.

Parameters:

Name	Type	Default	Description
`cols`	number	4	Positive integer showing how many tiles there are in the x direction
`rows`	number	4	Positive integer showing how many tiles there are in the y direction
`globalPos`	p5.Vector		The global position of the room

Source:

room.js, line 45

See:

World.Tile
World.Tile.proxy

Methods

createEmptyRoom()

creates a 2d grid of World.Tile.blankLine.

Source:

room.js, line 92

draw()

Draws the room at the global position set in the constructor.

Source:

room.js, line 489

fillRoomWithLoopPattern()

Fills the room with horizontal lines and then adds 90 degree corners to create the back and forth pattern that is connected in a loop.

Source:

room.js, line 166

fillRoomWithSnakePattern()

Fills the room with horizontal lines and then adds 90 degree corners to create the back and forth pattern.

Source:

room.js, line 112

generatePG(showGrid)

create a portable graphics image of all the tiles in the room.

Parameters:

Name	Type	Default	Description
`showGrid`	boolean	true	Flag to show or hide the tile grid pattern.

Source:

room.js, line 290

getAllTiles() → {Array.<Array.<World.Tile>>}

Returns a copy of the tile grid

Source:

room.js, line 361

Returns:

- a 2d array of tiles.

Type: Array.<Array.<World.Tile>>

getJSON(name) → {String}

Serializes the parameters of the room as a JSON object.

Parameters:

Name	Type	Description
`name`	string	The name to give the room. If undefined the date and time in ISO8901 format used as the room name.

Source:

room.js, line 528

Returns:

- JSON String with tab delimited spaces

Type: String

getPosOfGrid(x, y) → {p5.Vector}

Calculates the position of a tile at the given indexes.

Parameters:

Name	Type	Description
`x`	number	X Index
`y`	number	Y Index

Source:

room.js, line 381

Returns:

- global position of the tile in the grid

Type: p5.Vector

getTileAtPos(pos) → {World.Tile}

Calculates which tile is at a given global position

Parameters:

Name	Type	Description
`pos`	p5.Vector	The global position

Source:

room.js, line 421

Throws:

- pos needs to be an instance of p5.Vector
Type Error

Returns:

- The tile at the given position

Type: World.Tile

setAllTiles(tile)

Set all of the tiles in the room to be the same type. This will ensure that the position of all the tiles are in the correct position.

Parameters:

Name	Type	Description
`tile`	World.Tile	The type of tile to fill the room with.

Source:

room.js, line 337

Throws:

- tile needs to be an instance of World.Tile
Type Error

setGlobalPos(pos)

Sets the global position of the room.

Parameters:

Name	Type	Description
`pos`	p5.Vector	The position of the room

Source:

room.js, line 503

Throws:

- "pos needs to be an instance of p5.Vector"
Type Error

setTileAtPos(tilePattern)

sets the tiles in the grid to a new pattern

Parameters:

Name	Type	Description
`tilePattern`	Array.<Array.<World.Tile>>	a 2d array of tiles.

Source:

room.js, line 450

setTiles(tilePattern)

sets the tiles in the grid to a new pattern

Parameters:

Name	Type	Description
`tilePattern`	Array.<Array.<World.Tile>>	a 2d array of tiles.

Source:

room.js, line 393

(static) validateJSON(jsonData) → {Object}

Validates a JSON string as a valid room

Parameters:

Name	Type	Description
`jsonData`	string	JSON room data

Source:

room.js, line 598

Returns:

- With valid bool and and error string message members

Type: Object