net.stemkoski.bagel

Class TileMap

java.lang.Object

net.stemkoski.bagel.Entity

net.stemkoski.bagel.TileMap

public class TileMap
extends Entity

A selection and arrangement of Tiles that corresponds to an image of the game world environment and data that corresponds to placement of game world entities. TileMaps may be used as a background image or as a collection of solid obstacles (using the preventSpriteOverlap(Sprite) method).

Field Summary

Fields

Modifier and Type	Field and Description
int	mapCols number of columns of tiles in this TileMap
java.lang.String[][]	mapDataGrid a two-dimensional array storing all the text characters used to specify this TileMap
int	mapRows number of rows of tiles in this TileMap
Tile[][]	mapTileGrid a two-dimensional array storing only the Tile objects specified by this TileMap.
java.util.ArrayList<Tile>	mapTileList a list containing all the Tile objects specified by this TileMap.
int	tileHeight height of each tile (in pixels)
java.util.ArrayList<Texture>	tileTextureList a list containing all the available Tile textures loaded by the loadTilesetImage(String) method
int	tileWidth width of each tile (in pixels)

Fields inherited from class net.stemkoski.bagel.Entity

container

Constructor Summary

Constructors

Constructor and Description
TileMap(int mapRows, int mapCols, int tileWidth, int tileHeight) Specify basic data for this TileMap; additional data loaded by loadTilesetImage(String) and loadMapData(String[], String[], int[]) methods.

Method Summary

Modifier and Type	Method and Description
boolean	checkSpriteOverlap(Sprite sprite) Check if a sprite overlaps any Tile in this TileMap.
void	draw(javafx.scene.canvas.GraphicsContext context) Render this Entity to a canvas.
java.util.ArrayList<Vector2>	getSymbolPositionList(java.lang.String symbol) Return the game world coordinates (in pixels) of every occurrence of symbol in map data.
Tile	getTileAt(int mapRow, int mapCol) Get the tile at the corresponding map position (if one exists).
void	loadMapData(java.lang.String[] mapData, java.lang.String[] mapTileSymbolArray, int[] tileTextureIndexArray) Load text data that indicates placement of Tiles and game world entities.
void	loadTilesetImage(java.lang.String imageFileName) Load a tileset - an image consisting of smaller rectangular images that represent possible features of the game world environment.
void	preventSpriteOverlap(Sprite sprite) Prevent sprite from overlapping with any Tile in this TileMap.

Methods inherited from class net.stemkoski.bagel.Entity

act, remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mapRows

public int mapRows

number of rows of tiles in this TileMap

mapCols

public int mapCols

number of columns of tiles in this TileMap

tileWidth

public int tileWidth

width of each tile (in pixels)

tileHeight

public int tileHeight

height of each tile (in pixels)

mapDataGrid

public java.lang.String[][] mapDataGrid

a two-dimensional array storing all the text characters used to specify this TileMap

mapTileGrid

public Tile[][] mapTileGrid

a two-dimensional array storing only the Tile objects specified by this TileMap. used primarily to determine whether a tile is adjacent to other tiles, and thereby which tile edges should be ignored when calculating collision resolution.

mapTileList

public java.util.ArrayList<Tile> mapTileList

a list containing all the Tile objects specified by this TileMap.

tileTextureList

public java.util.ArrayList<Texture> tileTextureList

a list containing all the available Tile textures loaded by the loadTilesetImage(String) method

Constructor Detail

TileMap

public TileMap(int mapRows,
               int mapCols,
               int tileWidth,
               int tileHeight)

Specify basic data for this TileMap; additional data loaded by loadTilesetImage(String) and loadMapData(String[], String[], int[]) methods.

Parameters:

mapRows - number of rows of tiles in this TileMap

mapCols - number of columns of tiles in this TileMap

tileWidth - width of each tile (in pixels)

tileHeight - height of each tile (in pixels)

Method Detail

loadTilesetImage

public void loadTilesetImage(java.lang.String imageFileName)

Load a tileset - an image consisting of smaller rectangular images that represent possible features of the game world environment.

Parameters:

imageFileName - file name of the image containing tile images

loadMapData

public void loadMapData(java.lang.String[] mapData,
                        java.lang.String[] mapTileSymbolArray,
                        int[] tileTextureIndexArray)

Load text data that indicates placement of Tiles and game world entities. Map data is stored as an array of Strings, one String per row of the map. Text characters indicating tiles are listed in mapTileSymbolArray, and the corresponding tileset index values are listed in tileTextureIndexArray. Entity placement data can be retrieved later from the method getSymbolPositionList(String).

For example, consider a map where "W" represents a wall tile whose texture has index 3 in the tileset, and "D" represents a door tile whose texture has index 7 in the tileset. In addition, "P" represents the starting location of the player sprite, and each "E" represents the location of an enemy sprite. The parameters for this method could be specified as follows:

 mapData = {"WWWWDWWWW",
            "W.......W",
            "W.E...E.W",
            "W.......W",
            "W...P...W",
            "WWWWWWWWW"};
            
 mapTileSymbolArray = {"W", "D"};
 tileTextureIndexArray = {3, 7};
 

This method also determines if each Tile is adjacent to other tiles, and sets tile edge data for use in collision resolution: edges that occur between two adjacent tiles ("interior edges") are ignored.

Parameters:

mapData - an array of Strings, one String per row of the map, each character representing a Tile or other game world entity

mapTileSymbolArray - text characters indicating Tile objects

tileTextureIndexArray - index for Tile textures corresponding to characters in mapTileSymbolArray

getTileAt

public Tile getTileAt(int mapRow,
                      int mapCol)

Get the tile at the corresponding map position (if one exists).

Parameters:

mapRow - map row index

mapCol - map column index

Returns:

tile at the given position, if one exists; null otherwise

getSymbolPositionList

public java.util.ArrayList<Vector2> getSymbolPositionList(java.lang.String symbol)

Return the game world coordinates (in pixels) of every occurrence of symbol in map data.

Parameters:

symbol - text character to locate in map data

Returns:

list of positions where symbol occurs in map data

draw

public void draw(javafx.scene.canvas.GraphicsContext context)

Description copied from class: Entity

Render this Entity to a canvas.

Overrides:

draw in class Entity

Parameters:

context - GraphicsContext object that handles drawing to the canvas

checkSpriteOverlap

public boolean checkSpriteOverlap(Sprite sprite)

Check if a sprite overlaps any Tile in this TileMap.

Parameters:

sprite - the sprite to check for overlap

Returns:

true if sprite overlaps any Tile in this TileMap

preventSpriteOverlap

public void preventSpriteOverlap(Sprite sprite)

Prevent sprite from overlapping with any Tile in this TileMap. Tile edges are used when calculating collision resolution to avoid "corner snag" or "internal edge" issues that interfere with Sprite movement; edges that occur between two adjacent tiles are ignored.

Parameters:

sprite - the sprite to prevent from overlapping with tiles