Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 1.92 KB

README.md

File metadata and controls

48 lines (27 loc) · 1.92 KB
Raw

dota-vision-simulation

Example

View demo in www/ folder and src/app.js for source code.

See dota-interactive-map for another application.

Usage

var VisionSimulation = require("dota-vision-simulation");
var worlddata = require("dota-vision-simulation/src/worlddata.json");
var options = {radius: 1600};

var vs = new VisionSimulation(worlddata, options);
vs.initialize(mapImageDataPath, onReadyCallback);

worlddata - world dimensions, {"worldMinX":-8288,"worldMaxX":8288,"worldMinY":-8288,"worldMaxY":8288}

options - Optional settings object.

  • radius - Initial radius in grid tiles. Default: 1600 / 64

Methods

initialize(mapImageDataPath, onReadyCallback) - Starts the vision simulation.

  • mapImageDataPath - path to map data image, "www/map_data.png"

  • onReadyCallback(err) - callback executed when map data is loaded and vision simulation is ready. Returns an error object if an exception occurred.

updateVisibility(gX, gY, radius) - Executes the FOV calculation and update the lights property on the VisionSimulation object. (gX, gY) is a grid coordinate representing a 64x64 tile in the 260x260 world grid. radius optional.

toggleTree(gX, gY) - Toggles tree cut down state at (gX, gY) in grid coordinates.

setRadius(r) - Sets default radius.

WorldXYtoGridXY, GridXYtoWorldXY, GridXYtoImageXY, ImageXYtoGridXY, WorldXYtoImageXY - Functions for converting between world, grid, and image coordinates.

key2pt, xy2key, xy2pt, pt2key - Functions for converting between (x, y), {x: x, y: y}, and "x,y" coordinate formats.

isValidXY(gX, gY, bCheckGridnav, bCheckToolsNoWards, bCheckTreeState) - Check whether grid coordinate is a valid position or not. bCheckGridnav, bCheckToolsNoWards, bCheckTreeState optional.

Data

worlddata.json and map_data.png come from dota-map-coordinates