diff options
Diffstat (limited to 'doc/script_commands.txt')
| -rw-r--r-- | doc/script_commands.txt | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 9b742984c..51b772aaa 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -2067,6 +2067,20 @@ Example: ---------------------------------------
+*getpartyleader <party id>,[<type>];
+
+This function returns some information about the given party-id's leader. When type is ommitted, the default information retrieved is Character name of the party leader. Possible types are:
+
+ 1: Leader account id
+ 2: Leader character id
+ 3: Leader's class
+ 4: Leader's current map index
+ 5: Leader's current level as stored on the party structure (may not be
+ current level if leader leveled up recently).
+
+If retrieval fails (leader not found or party does not exists), "null" is returned instead of character name, and -1 is returned for the other types.
+
+---------------------------------------
*getguildname(<guild id>)
This function returns a guild's name given an ID number. If there is no such
|