Merge pull request #1589 from mekolat/strinfo2

allow strcharinfo() and strnpcinfo() to take a GID

1 files changed, 10 insertions, 2 deletions

diff --git a/doc/script_commands.txt b/doc/script_commands.txt
index 7015feec1..6df1f6e87 100644
--- a/doc/script_commands.txt
+++ b/doc/script_commands.txt
@@ -2362,7 +2362,7 @@ deleted.
 //=====================================
 ---------------------------------------
 
-*strcharinfo(<type>)
+*strcharinfo(<type>{, <default value>{, <GID>}})
 
 This function will return either the name, party name or guild name for 
 the invoking character. Whatever it returns is determined by type.
@@ -2370,6 +2370,10 @@ the invoking character. Whatever it returns is determined by type.
 (1) PC_PARTY	- The name of the party they're in if any.
 (2) PC_GUILD	- The name of the guild they're in if any.
 (3) PC_MAP		- The name of the map the character is in.
+
+If <GID> is passed, it will return the value of the specified player instead
+the attached player. If the player is not found, it will return
+<default value>, if any, or else return an empty string.
  
 If a character is not a member of any party or guild, an empty string will 
 be returned when requesting that information.
@@ -2379,7 +2383,7 @@ using only numbers reduces script readability
 
 ---------------------------------------
 
-*strnpcinfo(<type>)
+*strnpcinfo(<type>{, <default value>{, <GID>}})
 
 This function will return the various parts of the name of the calling NPC.
 Whatever it returns is determined by type.
@@ -2390,6 +2394,10 @@ Whatever it returns is determined by type.
 (3) NPC_NAME_UNIQUE  - The NPC's unique name (::name)
 (4) NPC_MAP		    - The name of the map the NPC is in.
 
+If <GID> is passed, it will return the value of the specified NPC instead of
+the attached NPC. If the NPC is not found, it will return <default value>,
+if any, or else return an empty string.
+
 ---------------------------------------
 
 *charid2rid(<char id>)