Difference between revisions of "Strcharinfo"

From Hercules Wiki
Jump to: navigation, search
(Created page with "== Syntax == * strcharinfo(<type>); == Description == This function will return either the name, party name or guild name for the invoking character. Whatever it returns ...")
 
m (Changed table style)
 
Line 8: Line 8:
  
 
== Type Values ==
 
== Type Values ==
{| border="1"
+
{| class="wikitable" border="1"
 
! Value !! Description
 
! Value !! Description
 
|-
 
|-

Latest revision as of 05:25, 9 June 2013

Contents

Syntax

  • strcharinfo(<type>);

Description

This function will return either the name, party name or guild name for the invoking character. Whatever it returns is determined by type.

If a character is not a member of any party or guild, an empty string will be returned when requesting that information.

Type Values

Value Description
0 Character's name.
1 The name of the party they're in if any.
2 The name of the guild they're in if any.
3 The name of the map where the player is.

Examples

mes "Hi " + strcharinfo(0) + ", nice to meet you :)";
if (getcharid(1))
	mes "Your party name is " + strcharinfo(1);
if (getcharid(2))
	mes "Your guild name is " + strcharinfo(2);
mes "You are standing on the map " + strcharinfo(3) + ".";