Difference between revisions of "Getusers"

From Hercules Wiki
Jump to: navigation, search
(See Also)
(Syntax)
Line 1: Line 1:
 
=Syntax=
 
=Syntax=
:[[getusers]](<type>)
+
*[[getusers]](<type>)
 +
 
 
=Description=
 
=Description=
 
This function will return a number of users on a map or the whole server. What  
 
This function will return a number of users on a map or the whole server. What  

Revision as of 09:08, 24 June 2013

Contents

Syntax

  • getusers(<type>)

Description

This function will return a number of users on a map or the whole server. What it returns is specified by Type.

Type can be one of the following values, which control what will be returned:

   0 - Count of all characters on the map of the invoking character.
   1 - Count of all characters in the entire server.
   8 - Count of all characters on the map of the NPC the script is
       running in.

Example

   mes getusers(1)+" players on the server";
   close;

See Also