diff options
| author | mekolat <mekolat@users.noreply.github.com> | 2017-10-20 15:32:50 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-20 15:32:50 -0400 |
| commit | 04f10f3b61044a78e9b3741cecbbdb8cf3a21236 (patch) | |
| tree | f168dcd28250b6e4823bf833637057932661b07a /doc/script_commands.txt | |
| parent | 018f1ffc77c8f690a6a5643365f64794451c9aa9 (diff) | |
| parent | 81bcd28716c28b326c4e41dca7228413f9afb472 (diff) | |
| download | hercules-04f10f3b61044a78e9b3741cecbbdb8cf3a21236.tar.gz hercules-04f10f3b61044a78e9b3741cecbbdb8cf3a21236.tar.bz2 hercules-04f10f3b61044a78e9b3741cecbbdb8cf3a21236.tar.xz hercules-04f10f3b61044a78e9b3741cecbbdb8cf3a21236.zip | |
Merge pull request #1852 from mekolat/getmapinfo2
Diffstat (limited to 'doc/script_commands.txt')
| -rw-r--r-- | doc/script_commands.txt | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 92fb53445..5c730106b 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -3305,6 +3305,27 @@ Notice that NPC objects disabled with disablenpc() will still be located. --------------------------------------- +*getmapinfo(<info>{, "<map name>"}) +*getmapinfo(<info>{, <map id>}) + +This command returns various information about a specific map. If the second +argument is omitted, it will try to use the map of the attached NPC, or the +map of the attached player if the NPC can't be found. + +Valid <info> are: + MAPINFO_NAME name of the map + MAPINFO_ID numeric ID of the map + MAPINFO_ZONE name of the zone used by the map + MAPINFO_SIZE_X width of the map (cells on the x axis) + MAPINFO_SIZE_Y height of the map (cells on the y axis) + +Examples: + getmapinfo(MAPINFO_ID, "map name"); // ID from name + getmapinfo(MAPINFO_NAME, 3); // name from ID + getmapinfo(MAPINFO_ZONE); // zone, ie Normal, PvP, Jail, ... + +--------------------------------------- + *getunits(<type>, <variable>, <limit>, "<map>"{, <x1>, <y1>, <x2>, <y2>}) This function searches a whole map or area for units and adds their GID to |