Awesome

ps2hq.com map API

This is a simple library to display a PlanetSide 2 Auraxis map with sectors, grid, and other ingame info.

The default tile hosting is on a limited bandwidth. If you use this library on your own site, please consider donating to cover bandwidth costs.

Install

This library uses NodeJS to build the necessary files. You need to install nodejs and npm in order to build.

Use npm to install required libraries:

npm install

If you don't have jake, install it using (may require use of sudo):

npm install -g jake

Use jake to build the library

jake

This produces a bundled script and stylesheet into the dist directory.

Usage

Creating a map

var map = new ps2hq.Map('myMapContainer');

Where 'myMapContainer' is the ID of your map container element. The container must have a height defined!

Configuring the map

You can pass additional options to the constructor.

Available options are:

• sectors: boolean, display sectors true/false
• sectorLabels: boolean, display sector labels true/false
• grid: boolean, display grid true/false

For example:

var map = new ps2hq.Map('myMapContainer', { sectorLabels: false });

Changing map settings after construction

map.showSectors(false);
map.showSectorLabels(false);
map.showGrid(false);

Listening to map events

The map emits some events on user interaction.

//mouse over a sector
map.on('sector-over', function(ev) {
    ev.target.setStyle({ fillColor: 'white' });
});

//mouse out of sector
map.on('sector-out', function(ev) {
    ev.target.setStyle({ fillColor: 'red' });
});

//sector click event
map.on('sector-click', function(ev) {
    console.log('Clicked on sector: ' + ev.sector.name);
});

//continent change
map.on('change-continent', function(ev) {
    console.log('Changed to continent: ' + ev.continent);
});

The event parameter ev contains a Leaflet event object, with one additional property: sector. As with any Leaflet event, the target contains the polygon the user clicked. As in the example above, you can change the style for the polygon easily. The sector property contains information on the sector, including the name and hex information.

Updating live sector ownership info from SOE API

You can use the SectorHelper object to create an auto-updater that will update the sector ownership info by changing sector fill color:

var timer = ps2hq.map.SectorHelper.autoUpdateSectors(map, {
    worldId: 10,
    serviceId: 'your-service-id',
    interval: 60
});

The map variable should be your map object.

The worldId parameter is the ID of the server, you can get a list of them from: http://census.soe.com/get/ps2-beta/world/

You can get a service ID from SOE, see: http://census.soe.com/#service-id

Interval is in seconds.