Phaser API Documentation

  Version: 
<static> HexagonalWorldToTileXY(worldX, worldY, snapToFloor, point, camera, layer)

Description:

Converts from world XY coordinates (pixels) to hexagonal tile XY coordinates (tile units), factoring in the layer's position, scale and scroll. This will return a new Vector2 object or update the given point object.

Parameters:

name type description
worldX number

The x coordinate to be converted, in pixels, not tiles.

worldY number

The y coordinate to be converted, in pixels, not tiles.

snapToFloor boolean

Whether or not to round the tile coordinates down to the nearest integer.

point Phaser.Math.Vector2

A Vector2 to store the coordinates in. If not given a new Vector2 is created.

camera Phaser.Cameras.Scene2D.Camera

The Camera to use when calculating the tile index from the world values.

layer Phaser.Tilemaps.LayerData

The Tilemap Layer to act upon.

Returns:
Description:

The XY location in tile units.