AREA.md

Area event

• Properties
• Area information structure
• Usage example

Properties

The properties listed below are stored in an object emitted by the area event.

• name
  • The name of the area that has been entered
• type
  • The type of the area
    • area - Regular areas, such as act areas or hideouts
    • vaal - Vaal side areas
    • map - Map areas (currently unused)
    • master - Master mission areas (currently unused)
    • labyrinth - Labyrinth areas
    • unknown - Areas of this type are currently unknown by the script
• info

  • An array of objects containing additional information about the area and their variants, if data is available. The emitted object has a different structure based on the type. See Area information structure.

    ⚠ In the current version 1.2.4 some areas might still be missing. I'll add them as soon as possible. If you encounter an area that's not supported, feel free to contribute or open an issue.

Area information structure

The info object always contains an array of objects, because some areas have different properties, but the same name (this is usually only the case for story areas). Currently, it is not possible to get the exact area the player is in based on the Path of Exile log file, so the script just gives you every possible variant.

The info object has different structures based on the area type. Below, you can find a list of those structures of each area type.

⚠ These structures are subject to change. Please make sure to come back to this file if you plan on updating this module, in case there have been any changes.

area

• act - Act the area is in
• level - Zone/monster level of the area
• town - true if the area is a town
• waypoint - true if the area has a waypoint
• bosses - An array of objects containing the name of the boss
  • name - Name of the boss

vaal

• bosses - An array of objects containing additional information for each boss in the area
  • name - Name of the boss

labyrinth

• trial - true if the area is a trial of ascendancy

  ⚠ In the current version 1.2.4, only the Aspirants' Plaza and the trial areas are supported.

master

• There's no data for this area type yet, I'll add the data as soon as possible.

map

• level - Zone/monster level of the area
• tier - Tier of the map
• bosses - An array of objects containing additional information for each boss in the area
  • name - Name of the boss

unknown

• Areas of this type are currently unknown by the script. They will emit no additional data in the info object.

In case all this doesn't make any sense to you, simply print out the info object you receive when the event triggers and see what it contains. Alternatively, you can take a look at the areas.json.

Usage example

Below, you can find an example that prints additional information of areas with the area type to the console, once you enter it in game (area.js)

var PathOfExileLog = require("poe-log-monitor");

var poeLog = new PathOfExileLog({
    logfile: "C:/Program Files (x86)/Steam/steamapps/common/Path of Exile/logs/Client.txt",
    interval: 500
});

// Listener for area events
poeLog.on("area", (area) => {
    // Display the area name
    process.stdout.write("Entered \'" + area.name + "\'");

    // If the area is a normal area...
    if(area.type === "area") {
        // If the area has additional information objects
        if (area.info.length > 0) {
            console.log(", this area has " + area.info.length + " variant/s:");

            // Iterate through every area variant
            area.info.forEach(function (area) {
                // Display area information
                process.stdout.write("\t- Act " + area.act + " (Zone level: " + area.level + ")");
                process.stdout.write(area.town ? " [Town]" : "");
                process.stdout.write(area.waypoint ? " [Waypoint]" : "");
                process.stdout.write(area.bosses.length ? " Has " + area.bosses.length + " unique monsters: " : "");

                // Display bosses, if there are any
                if (area.bosses.length > 0) {
                    area.bosses.forEach(function (boss) {
                        process.stdout.write("\'" + boss.name + "\' ");
                    });
                }

                process.stdout.write("\n");
            });
        } else {
            process.stdout.write("\n");
        }
    } else {
        process.stdout.write("\n");
    }
});