Skip to main content

Map

The world map interface

Functions​

clear​

</>
Map.clear(
options: table--

settings

) → ()

Clears the map data

Options

Name Type Default Description
region string - Clear a specific region by id

discover​

</>
Map.discover(
options: table--

settings

) → ()

Discovers map data automatically

Options

Name Type Default Description
radius number 64 Scanning radius
Show raw api
{
    "functions": [
        {
            "name": "clear",
            "desc": "Clears the map data\n\n### Options\n| Name            | Type        | Default | Description                    |\n|-----------------|-------------|---------|--------------------------------|\n| region          | string      |       - | Clear a specific region by id  |",
            "params": [
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 16,
                "path": "../../res/data/script/lib/system/map.lua"
            }
        },
        {
            "name": "discover",
            "desc": "Discovers map data automatically\n\n### Options\n| Name            | Type        | Default | Description                    |\n|-----------------|-------------|---------|--------------------------------|\n| radius          | number      |      64 | Scanning radius                |",
            "params": [
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 29,
                "path": "../../res/data/script/lib/system/map.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Map",
    "desc": "The world map interface",
    "source": {
        "line": 5,
        "path": "../../res/data/script/lib/system/map.lua"
    }
}