diff options
| author | gumi <mekolat@users.noreply.github.com> | 2017-10-05 14:34:43 -0400 |
|---|---|---|
| committer | gumi <mekolat@users.noreply.github.com> | 2017-10-05 15:20:01 -0400 |
| commit | 81bcd28716c28b326c4e41dca7228413f9afb472 (patch) | |
| tree | 7249cfda2fd14da4371d9b1c553dc385a49b964e | |
| parent | 2568b4b6959a90f01e02918971eeb12d94e4a2fe (diff) | |
| download | hercules-81bcd28716c28b326c4e41dca7228413f9afb472.tar.gz hercules-81bcd28716c28b326c4e41dca7228413f9afb472.tar.bz2 hercules-81bcd28716c28b326c4e41dca7228413f9afb472.tar.xz hercules-81bcd28716c28b326c4e41dca7228413f9afb472.zip | |
add documentation for buildin_getmapinfo
| -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 331bed1c7..8a7c9853c 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 |