strcharinfo()

Warning

This page may contain outdated information, incompatible with the current version of Hercules and its coding standards.

Syntax

strcharinfo(<type>);

Warning

The rest of this document hasn't been converted to Markdown yet.

== 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 == {| class="wikitable" border="1" ! 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] + ", nice to meet you :)"; [[if]] ([getcharid]) 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) + ".";