Map

Map is uniquely identified by its GUID. It will differ even for each version of the same map.

Tiles

The map uses discrete tiles representation (similar to chess), as opposed to continuous space.

Two neighboring tiles are typically 10 meters apart, however, different neighboring pairs will have different distances.

Tiles are indexed 0 .. N-1.

Data available for each tile:

  • Position - 3D coordinates

  • Up - 3D vector - direction opposite of local gravity

  • Neighbors - array of indices of neighboring tiles

  • Cluster - index of the cluster this tile belongs to

  • Terrain - index of the terrain type at this tile

Clusters

Clusters are aggregations of tiles into smaller connected groups. It is intended primarily for performance optimizations. All tiles in one cluster have same terrain.

Clusters are indexed 0 .. M-1.

Data available for each cluster:

  • Neighbors - array of indices of neighboring clusters

  • Tile - index of the center-most tile in this cluster

Overview

Automatically updated ids of entities present on each tile. This is used for performance optimization.

Entities with larger radius will be present in all tiles that they cover, not just the center.

Additionally, bit-flags are available for each tile, with different bits denoting different types of entities present on the tile.

Area Queries

There are multiple functions for finding tiles within some distance.

Area Range

Area Connected

Area Neighborhood

Area Extended

Pathfinding

Finds fastest path for a specified type of unit from tile A to tile B.

  • maxIterations - maximum number of steps of the A* algorithm.

  • allowNearbyPosition - accept a path to the nearest available point, otherwise the search fails.

This will request a new asynchronous task. The result will be provided with the callback some time later. You may enqueue multiple tasks and they will be processed in parallel.

Clusters Distances

Finds approximate time required for a specified unit type to reach all other areas from specific starting cluster. The results are calculated for the clusters, not tiles.

  • allowImpassableTerrain - use large penalty for crossing unsuitable terrain type, otherwise mark the clusters as unreachable.

This will request a new asynchronous task. The result will be provided with the callback some time later. You may enqueue multiple tasks and they will be processed in parallel.