Map

The Map object represents the current map. Provides access to entities such as mobs, NPCs, drops, portals, and map terrain data.

#Functions

#Validation & Basic Info

#map:is_valid() -> boolean

Validates the object exists in the game world. Always call this first.

#map:get_id() -> number

Returns the map ID.

#map:is_town() -> boolean

Returns true if the map is a town (safe zone).

#map:get_burning_stage() -> number | nil

Returns the burning XP stage (0-10) or nil if unavailable.

#Drops & Portals

#Drop Object Structure

#map:get_drops() -> table<drop>

Returns all drops available to the player (shared and personal).

#Portal Object Structure

#map:get_portals() -> table<portal>

Returns all portals on the map.

#Entities

#map:get_mobs() -> table<Mob>

Returns all mobs on the map. See Mob.

#map:get_bosses() -> table<Mob>

Returns all boss mobs on the map. See Mob.

#map:get_mob_count() -> number

Returns the number of alive mobs. More efficient than iterating get_mobs().

#map:get_npcs() -> table<NPC>

Returns all NPCs on the map. See NPC.

#Reactor Object Structure

Reactors (interactive map objects — switches, boxes, gathering nodes) currently in the field. Each entry is a plain table — not a bound object, so it has no methods.

#map:get_reactors() -> table<reactor>

Returns all reactors currently in the field.

#Rune Object Structure

The active runestone on the field. Maps only ever have one rune at a time, so this is a single plain table (or nil) rather than a list — not a bound object, so it has no methods.

#map:get_rune() -> rune?

Returns the active rune on the map, or nil if there is none.

#Player Object Structure

Other players (remote characters) currently in the field. Each entry is a plain table — not a bound object, so it has no methods.

#map:get_players() -> table<player>

Returns all other players currently in the field. Excludes your own character — see Local Player.

#Terrain Data

#Foothold Object Structure

#map:get_footholds() -> table<foothold>

Returns all footholds (platforms) on the map.

#Ladder Object Structure

#map:get_ladders() -> table<ladder>

Returns all ladders and ropes on the map.

#Example

-- Map and mob monitoring
function on_tick()
    local map = core.object_manager.get_current_map()
    if not map or not map:is_valid() then return end

    -- Check map type
    if map:is_town() then
        core.log("In town - safe zone")
        return
    end

    -- Check burning field
    local burning = map:get_burning_stage()
    if burning and burning > 0 then
        core.log("Burning field stage: " .. burning)
    end

    -- Monitor mob count
    local mob_count = map:get_mob_count()
    if mob_count < 5 then
        core.log_warning("Low mob count: " .. mob_count)
    end

    -- List reactors in the field
    for _, reactor in ipairs(map:get_reactors()) do
        core.log(string.format(
            "reactor %d (%s) state=%d at (%d, %d)",
            reactor.template_id, reactor.name, reactor.state,
            reactor.position.x, reactor.position.y))
    end

    -- Check for a solvable rune
    local rune = map:get_rune()
    if rune and rune.solvable then
        core.log(string.format(
            "solvable rune at (%d, %d)",
            rune.position.x, rune.position.y))
    end
end