No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
images/ui
scripts
src
.gitignore
.jshintrc
LICENSE
model.md
package.json
readme.md
readme_scripts.md
settings.md

readme.md

Adventure Map Engine

The Adventure map class is used to display an overview of all levels in the game. The levels are displayed as nodes on a tiled background. The nodes can be connected with lines to form paths for players to follow through the map.

The map contains a model, your can read about the model here.

Node Tags

A node can be tagged. It's possible to define a view for a tag. When a node has a certain tag and the node is visible, then the view will be instantiated and will be shown on the node. This feature allows you to show custom items on the map at tagged nodes.

Settings objects

The map can be configured with settings objects. There are settings for the background, nodes, items and tags.

You can read more detailed information about the settings here.

AdventureMap class

The AdventureMap class wraps the adventure map model and view class instances.

Parameters

  • superview {View} ---The view which contains the adventure map view.
  • editMode {boolean} ---If true then the node id will be displayed on the tiles to aid in map editing.
  • gridSettings {object} ---General grid settings like width and height.
  • tileSettings {object} ---Settings for the tiles: images, tileWidth and tileHeight, etc.
  • pathSettings {object} ---Options for how the path will be displayed: dotted, dashed, etc.
  • nodeSettings {object} ---Display options for the nodes on the map.
  • inputLayerIndex {number} ---Which layer will handle inputs.
import adventuremap.AdventureMap as AdventureMap;

this._adventureMap = new AdventureMap({
	superview: this,
	x: 0,
	y: 0,
	width: this.baseWidth,
	height: this.baseHeight,
	editMode: (inputLayerIndex === 0),
	gridSettings: gridSettings,
	tileSettings: tileSettings,
	pathSettings: pathSettings,
	nodeSettings: nodeSettings,
	inputLayerIndex: inputLayerIndex
});

Methods

getModel()

Get an instance of the adventure map model, the model contains the map data, nodes and their state.

Returns {AdventureMapModel} ---AdventureMapModel instance.

getAdventureMapView()

Get an instance of the adventure map view, the view is the visual representation the the map.

Returns {AdventureMapView} ---AdventureMapView instance.

setScale(scale)

Set the scale of the map, the scale can be in the range of 0.5..2.

Parameters

  • scale {number} ---The scale.

load(data)

Load a map, you can make a map with the map editor.

Parameters

  • data {object} ---The map data.

refreshTile(tileX, tileY)

Refresh a tile, all images and views will be updated.

Parameters

  • tileX {number} ---The x position on the grid, must be an integer.
  • tileY {number} ---The y position on the grid, must be an integer.

Events

'ClickTag', callback(tag, tile, view)

Called when a tag on a tile is clicked.

Parameters

  • tag {string} ---The tag which is clicked.
  • tile {object} ---The tile on which the tag is placed, contains a tileX and tileY property.
  • view {View} ---The tag view.

'ClickNode', callback(tile)

Called when a node -which represents a level- is clicked.

Parameters

  • tile {object} ---The tile on which the tag is placed, contains a tileX and tileY property.