Difference between revisions of "Getareausers"

From Hercules Wiki
Jump to: navigation, search
(Created page with "== Syntax == * getareausers("<map name>",<x1>,<y1>,<x2>,<y2>) == Description == This function will return the count of connected characters which are located within the s...")
 
Line 1: Line 1:
 
== Syntax ==
 
== Syntax ==
* [[getareausers]]("<map name>",<x1>,<y1>,<x2>,<y2>)
+
* getareausers("<map name>",<x1>,<y1>,<x2>,<y2>)
  
 
== Description ==
 
== Description ==
This function will return the count of connected characters which are located within the specified area - a x1/y1-x2/y2 rectangle on the specified map.
+
This function will return the count of connected characters which are located  
 +
within the specified area - an x1/y1-x2/y2 square on the specified map.
  
 
This is useful for maps that are split into many buildings, such as all the  
 
This is useful for maps that are split into many buildings, such as all the  
 
"*_in" maps, due to all the shops and houses.
 
"*_in" maps, due to all the shops and houses.
  
 +
==See Also==
 +
*[[getmapusers;]]
 +
*[[getareausers;]]
 
[[Category:Script Command]]
 
[[Category:Script Command]]

Revision as of 09:04, 24 June 2013

Syntax

  • getareausers("<map name>",<x1>,<y1>,<x2>,<y2>)

Description

This function will return the count of connected characters which are located within the specified area - an x1/y1-x2/y2 square on the specified map.

This is useful for maps that are split into many buildings, such as all the "*_in" maps, due to all the shops and houses.

See Also