diff options
Diffstat (limited to 'doc/script_commands.txt')
| -rw-r--r-- | doc/script_commands.txt | 26 |
1 files changed, 11 insertions, 15 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 68b62816e..c9bc08bf1 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -3087,15 +3087,6 @@ Example: --------------------------------------- -*getmapmobs("<map name>") - -This function will return the total count of monsters currently located on the -specified map. If the map name is given as "this", the map the invoking -character is on will be used. If the map is not found, or the invoker is not a -character while the map is "this", it will return -1. - ---------------------------------------- - *skillpointcount() Returns the total amount of skill points a character possesses (SkillPoint+SP's used in skills) @@ -5012,14 +5003,19 @@ per 'db/mob_db.txt'. Type is the kind of information returned. Valid types are: This function will count all the monsters on the specified map that have a given event label and return the number or 0 if it can't find any. Naturally, only -monsters spawned with 'monster' and 'areamonster' script commands can be like -this. - -However, apparently, if you pass this function an empty string for the event -label, it should return the total count of normal permanently respawning -monsters instead. With the current dynamic mobs system, where mobs are not kept +monsters spawned with 'monster' and 'areamonster' script commands can have non-empty +event label. +If you pass this function an empty string for the event label, it will return +the total count of monster without event label, including permanently spawning monsters. +With the dynamic mobs system enabled, where mobs are not kept in memory for maps with no actual people playing on them, this will return a 0 for any such map. +If the event label is given as "all", all monsters will be counted, regardless of +having any event label attached. + +If the map name is given as "this", the map the invoking character is on will +be used. If the map is not found, or the invoker is not a character while the map +is "this", it will return -1. --------------------------------------- |