import type { ITiledMap, ITiledMapLayer, ITiledMapProperty } from "../Map/ITiledMap"; import { flattenGroupLayersMap } from "../Map/LayersFlattener"; import TilemapLayer = Phaser.Tilemaps.TilemapLayer; import { DEPTH_OVERLAY_INDEX } from "./DepthIndexes"; import { GameMapProperties } from "./GameMapProperties"; export type PropertyChangeCallback = ( newValue: string | number | boolean | undefined, oldValue: string | number | boolean | undefined, allProps: Map ) => void; export type layerChangeCallback = ( layersChangedByAction: Array, allLayersOnNewPosition: Array, ) => void; /** * A wrapper around a ITiledMap interface to provide additional capabilities. * It is used to handle layer properties. */ export class GameMap { // oldKey is the index of the previous tile. private oldKey: number | undefined; // key is the index of the current tile. private key: number | undefined; private lastProperties = new Map(); private propertiesChangeCallbacks = new Map>(); private enterLayerCallbacks = Array(); private leaveLayerCallbacks = Array(); private tileNameMap = new Map(); private tileSetPropertyMap: { [tile_index: number]: Array } = {}; public readonly flatLayers: ITiledMapLayer[]; public readonly phaserLayers: TilemapLayer[] = []; public exitUrls: Array = []; public hasStartTile = false; public constructor( private map: ITiledMap, phaserMap: Phaser.Tilemaps.Tilemap, terrains: Array ) { this.flatLayers = flattenGroupLayersMap(map); let depth = -2; for (const layer of this.flatLayers) { if (layer.type === "tilelayer") { this.phaserLayers.push(phaserMap.createLayer(layer.name, terrains, 0, 0).setDepth(depth)); } if (layer.type === "objectgroup" && layer.name === "floorLayer") { depth = DEPTH_OVERLAY_INDEX; } } for (const tileset of map.tilesets) { tileset?.tiles?.forEach((tile) => { if (tile.properties) { this.tileSetPropertyMap[tileset.firstgid + tile.id] = tile.properties; tile.properties.forEach((prop) => { if (prop.name == GameMapProperties.NAME && typeof prop.value == "string") { this.tileNameMap.set(prop.value, tileset.firstgid + tile.id); } if (prop.name == GameMapProperties.EXIT_URL && typeof prop.value == "string") { this.exitUrls.push(prop.value); } else if (prop.name == GameMapProperties.START) { this.hasStartTile = true; } }); } }); } } public getPropertiesForIndex(index: number): Array { if (this.tileSetPropertyMap[index]) { return this.tileSetPropertyMap[index]; } return []; } private getLayersByKey(key: number): Array { return this.flatLayers.filter(flatLayer => flatLayer.type === 'tilelayer' && flatLayer.data[key] !== 0); } /** * Sets the position of the current player (in pixels) * This will trigger events if properties are changing. */ public setPosition(x: number, y: number) { this.oldKey = this.key; const xMap = Math.floor(x / this.map.tilewidth); const yMap = Math.floor(y / this.map.tileheight); const key = xMap + yMap * this.map.width; if (key === this.key) { return; } this.key = key; this.triggerAllProperties(); this.triggerLayersChange(); } private triggerAllProperties(): void { const newProps = this.getProperties(this.key ?? 0); const oldProps = this.lastProperties; this.lastProperties = newProps; // Let's compare the 2 maps: // First new properties vs oldProperties for (const [newPropName, newPropValue] of newProps.entries()) { const oldPropValue = oldProps.get(newPropName); if (oldPropValue !== newPropValue) { this.trigger(newPropName, oldPropValue, newPropValue, newProps); } } for (const [oldPropName, oldPropValue] of oldProps.entries()) { if (!newProps.has(oldPropName)) { // We found a property that disappeared this.trigger(oldPropName, oldPropValue, undefined, newProps); } } } private triggerLayersChange() { const layersByOldKey = this.oldKey ? this.getLayersByKey(this.oldKey) : []; const layersByNewKey = this.key ? this.getLayersByKey(this.key) : []; const enterLayers = new Set(layersByNewKey); const leaveLayers = new Set(layersByOldKey); enterLayers.forEach(layer => { if (leaveLayers.has(layer)) { leaveLayers.delete(layer); enterLayers.delete(layer); } }); if (enterLayers.size > 0) { const layerArray = Array.from(enterLayers); for (const callback of this.enterLayerCallbacks) { callback(layerArray, layersByNewKey); } } if (leaveLayers.size > 0) { const layerArray = Array.from(leaveLayers); for (const callback of this.leaveLayerCallbacks) { callback(layerArray, layersByNewKey); } } } public getCurrentProperties(): Map { return this.lastProperties; } private getProperties(key: number): Map { const properties = new Map(); for (const layer of this.flatLayers) { if (layer.type !== "tilelayer") { continue; } let tileIndex: number | undefined = undefined; if (layer.data) { const tiles = layer.data as number[]; if (tiles[key] == 0) { continue; } tileIndex = tiles[key]; } // There is a tile in this layer, let's embed the properties if (layer.properties !== undefined) { for (const layerProperty of layer.properties) { if (layerProperty.value === undefined) { continue; } properties.set(layerProperty.name, layerProperty.value); } } if (tileIndex) { this.tileSetPropertyMap[tileIndex]?.forEach((property) => { if (property.value) { properties.set(property.name, property.value); } else if (properties.has(property.name)) { properties.delete(property.name); } }); } } return properties; } public getMap(): ITiledMap { return this.map; } private getTileProperty(index: number): Array { if (this.tileSetPropertyMap[index]) { return this.tileSetPropertyMap[index]; } return []; } private trigger( propName: string, oldValue: string | number | boolean | undefined, newValue: string | number | boolean | undefined, allProps: Map ) { const callbacksArray = this.propertiesChangeCallbacks.get(propName); if (callbacksArray !== undefined) { for (const callback of callbacksArray) { callback(newValue, oldValue, allProps); } } } /** * Registers a callback called when the user moves to a tile where the property propName is different from the last tile the user was on. */ public onPropertyChange(propName: string, callback: PropertyChangeCallback) { let callbacksArray = this.propertiesChangeCallbacks.get(propName); if (callbacksArray === undefined) { callbacksArray = new Array(); this.propertiesChangeCallbacks.set(propName, callbacksArray); } callbacksArray.push(callback); } /** * Registers a callback called when the user moves inside another layer. */ public onEnterLayer(callback: layerChangeCallback) { this.enterLayerCallbacks.push(callback); } /** * Registers a callback called when the user moves outside another layer. */ public onLeaveLayer(callback: layerChangeCallback) { this.leaveLayerCallbacks.push(callback); } public findLayer(layerName: string): ITiledMapLayer | undefined { return this.flatLayers.find((layer) => layer.name === layerName); } public findPhaserLayer(layerName: string): TilemapLayer | undefined { return this.phaserLayers.find((layer) => layer.layer.name === layerName); } public findPhaserLayers(groupName: string): TilemapLayer[] { return this.phaserLayers.filter((l) => l.layer.name.includes(groupName)); } public addTerrain(terrain: Phaser.Tilemaps.Tileset): void { for (const phaserLayer of this.phaserLayers) { phaserLayer.tileset.push(terrain); } } private putTileInFlatLayer(index: number, x: number, y: number, layer: string): void { const fLayer = this.findLayer(layer); if (fLayer == undefined) { console.error("The layer '" + layer + "' that you want to change doesn't exist."); return; } if (fLayer.type !== "tilelayer") { console.error( "The layer '" + layer + "' that you want to change is not a tilelayer. Tile can only be put in tilelayer." ); return; } if (typeof fLayer.data === "string") { console.error("Data of the layer '" + layer + "' that you want to change is only readable."); return; } fLayer.data[x + y * fLayer.width] = index; } public putTile(tile: string | number | null, x: number, y: number, layer: string): void { const phaserLayer = this.findPhaserLayer(layer); if (phaserLayer) { if (tile === null) { phaserLayer.putTileAt(-1, x, y); return; } const tileIndex = this.getIndexForTileType(tile); if (tileIndex !== undefined) { this.putTileInFlatLayer(tileIndex, x, y, layer); const phaserTile = phaserLayer.putTileAt(tileIndex, x, y); for (const property of this.getTileProperty(tileIndex)) { if (property.name === GameMapProperties.COLLIDES && property.value) { phaserTile.setCollision(true); } } } else { console.error("The tile '" + tile + "' that you want to place doesn't exist."); } } else { console.error("The layer '" + layer + "' does not exist (or is not a tilelaye)."); } } private getIndexForTileType(tile: string | number): number | undefined { if (typeof tile == "number") { return tile; } return this.tileNameMap.get(tile); } public setLayerProperty( layerName: string, propertyName: string, propertyValue: string | number | undefined | boolean ) { const layer = this.findLayer(layerName); if (layer === undefined) { console.warn('Could not find layer "' + layerName + '" when calling setProperty'); return; } if (layer.properties === undefined) { layer.properties = []; } const property = layer.properties.find((property) => property.name === propertyName); if (property === undefined) { if (propertyValue === undefined) { return; } layer.properties.push({ name: propertyName, type: typeof propertyValue, value: propertyValue }); return; } if (propertyValue === undefined) { const index = layer.properties.indexOf(property); layer.properties.splice(index, 1); } property.value = propertyValue; this.triggerAllProperties(); this.triggerLayersChange(); } /** * Trigger all the callbacks (used when exiting a map) */ public triggerExitCallbacks(): void { const emptyProps = new Map(); for (const [oldPropName, oldPropValue] of this.lastProperties.entries()) { // We found a property that disappeared this.trigger(oldPropName, oldPropValue, undefined, emptyProps); } } }