[an error occurred while processing this directive]
[<a href="index.shtml">Package Index</a></code> | <a href="index_std.shtml">Mudlib Index</a></code> | <a href="index_eff.shtml">Effect Index</a></code>]<br><h2>File /obj/handlers/player_handler.c</h2>
A hander to allow the testing of values on players when they aren't logged
in.  These methods used to exist in the login object but now they're here.
<p><p>Written by Ceres
<h2>Inherits</h2>
This class inherits the following classes /global/family.c, /global/options_control.c and /std/living/nationality.c<h2>Includes</h2>
This class includes the following files /include/player.h, /include/cmds/import.h, /include/playtesters.h, /include/login_handler.h, /include/player_handler.h, /include/access.h, /include/alias.h and /include/cmds/friends.h<h2>Class Index</h2>
<ul><li><a href="#class_player_record">player_record</a>
</ul><h2>Method index</h2>
<ul>
<li><a href="#clean_cache">clean_cache</a>()<li><a href="#living_mxp_commands">living_mxp_commands</a>()<br/>
This function returns the list of commands available to use in an
mxp way on a living/player.
<li><a href="#load_player">load_player</a>(string)<br/>
This method will load in the player file.
<li><a href="#make_string">make_string</a>(mixed *, int)<br/>
This method converts an alias into a string.
<li><a href="#my_find_player">my_find_player</a>(string)<li><a href="#query_appeal_player_file_name">query_appeal_player_file_name</a>(string)<br/>
This method returns the path to the pending appeal player file.
<li><a href="#query_cap_name">query_cap_name</a>(string)<br/>
This method returns a players cap_name.
<li><a href="#query_delete_player_file_name">query_delete_player_file_name</a>(string)<br/>
This method returns the path to the deleted player file.
<li><a href="#query_guild_data">query_guild_data</a>()<br/>
This method is called by query_level() in the base guild
inheritable to determine the specialisation of the current
player.
<li><a href="#query_pk_stats">query_pk_stats</a>()<li><a href="#query_plan">query_plan</a>(string, int)<br/>
This method returns the players .
<li><a href="#query_player_disk_file_name">query_player_disk_file_name</a>(string)<li><a href="#query_player_file_name">query_player_file_name</a>(string)<br/>
This method returns the path to the player file.
<li><a href="#query_player_ram_file_name">query_player_ram_file_name</a>(string)<li><a href="#query_prevent_shadow">query_prevent_shadow</a>(object)<li><a href="#query_project">query_project</a>(string, int)<br/>
This method returns the players .
<li><a href="#query_reference">query_reference</a>(string)<br/>
This method returns the players .
<li><a href="#query_signature">query_signature</a>(string)<br/>
This method returns the signature to use on posts for the player
even when they are off line.
<li><a href="#query_skill">query_skill</a>(string)<li><a href="#remove_cache_entry">remove_cache_entry</a>(string)<li><a href="#special_add_property">special_add_property</a>(string, string, mixed)<br/>
This method updates the cached properties, it's called by
/secure/login.
<li><a href="#test_active">test_active</a>(string, int, int)<br/>
This method determines if a player is still active.
<li><a href="#test_age">test_age</a>(string)<br/>
This method determines the age of the player even if they are
not currently on.
<li><a href="#test_aliases">test_aliases</a>(string)<br/>
This method determines the aliases the player has set even if they are
not currently on.
<li><a href="#test_appealing">test_appealing</a>(string)<br/>
This method figures out if the user is marked for deletion pending appeal.
<li><a href="#test_banished">test_banished</a>(string)<br/>
This method checks to see if the name is banished of not.
<li><a href="#test_birthday">test_birthday</a>(string)<br/>
This method determines the birthday of the player even if they are
not currently on
<li><a href="#test_creator">test_creator</a>(string)<br/>
This method determines if the player is a creator.
<li><a href="#test_deity">test_deity</a>(string)<br/>
This method determines the deity of the player even if they are
not currently on.
<li><a href="#test_deleting">test_deleting</a>(string)<br/>
This method figures out if the user is marked for deletion.
<li><a href="#test_desc">test_desc</a>(string)<br/>
This method determines the description of the player even if they are
not currently on
<li><a href="#test_email">test_email</a>(string)<br/>
This method determines the email of the player even if they are
not currently on.
<li><a href="#test_family">test_family</a>(string)<br/>
This method returns the players family name
<li><a href="#test_friends">test_friends</a>(string)<br/>
This method determines the friends of the player has set even if they are
not currently on.
<li><a href="#test_gender">test_gender</a>(string)<br/>
This method determines the gender of the player even if they are
not currently on
<li><a href="#test_guild">test_guild</a>(string)<br/>
This method determines the guild of the player even if they are
not currently on.
<li><a href="#test_guild_data">test_guild_data</a>(string)<br/>
This method determines the guild data of the player even if they are
not currently on.
<li><a href="#test_home_dir">test_home_dir</a>(string)<br/>
This method returns the players home directory
<li><a href="#test_homepage">test_homepage</a>(string)<br/>
This method determines the players homepage information even if they
are not currently on
<li><a href="#test_ip_allowed">test_ip_allowed</a>(string, string)<br/>
Check if a players personal allow list permits logins from this IP
<li><a href="#test_last">test_last</a>(string, int)<br/>
This method determines the last log on of the player even if they are
not currently on.
<li><a href="#test_last_on_from">test_last_on_from</a>(string)<br/>
This method determines the last log on of the player even if they are
not currently on.
<li><a href="#test_level">test_level</a>(string)<br/>
This method determines the level of the player even if they are
not currently on
<li><a href="#test_local_time_zone">test_local_time_zone</a>(string)<br/>
Check a players local time zone.
<li><a href="#test_location">test_location</a>(string)<br/>
This method determines the players location finger information even if they
are not currently on
<li><a href="#test_my_colours">test_my_colours</a>(string)<br/>
This method determines the colours mapping of the specfied player
<li><a href="#test_nationality">test_nationality</a>(string)<br/>
This method returns the players nationality.
<li><a href="#test_nationality_data">test_nationality_data</a>(string)<br/>
This method returns the players nationality data.
<li><a href="#test_nationality_region">test_nationality_region</a>(string)<br/>
This method returns the players nationality region.
<li><a href="#test_nicknames">test_nicknames</a>(string)<br/>
This method determines the nicknames the player has set even if they are
not currently on.
<li><a href="#test_player_killer">test_player_killer</a>(string, string)<br/>
This method returns the current value of the player flag on the
player, even if they are not currently on.
<li><a href="#test_player_title">test_player_title</a>(string)<br/>
This method returns the players title.
<li><a href="#test_property">test_property</a>(string, string)<br/>
This method returns the current value of the property on the
player, even if they are not currently on.
<li><a href="#test_real_name">test_real_name</a>(string)<br/>
This method determines the real name of the player even if they are
not currently on
<li><a href="#test_start_time">test_start_time</a>(string)<br/>
This method determines the time the player started at.
<li><a href="#test_user">test_user</a>(string)<br/>
This method figures out if the user exists even if they are not on.
<li><a href="#test_valid">test_valid</a>(string)<br/>
Validate a name by checking if it, or bits of it are banished.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="clean_cache">
clean_cache</a><pre class="autodocfuncdef">
void clean_cache()
</pre>
<dt class="autodocfuncname"><a name="living_mxp_commands">
living_mxp_commands</a><pre class="autodocfuncdef">
string living_mxp_commands()
</pre><dd><br />
This function returns the list of commands available to use in an
mxp way on a living/player.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the mxp commands
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="load_player">
load_player</a><pre class="autodocfuncdef">
int load_player(string name)
</pre><dd><br />
This method will load in the player file.  It will return 0 if the player
file either does not exist or the input string is incorrect.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name to try and read in<br />
<br />
<dd><b>Returns:</b>
<br />1 if the player file exists, 0 if not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="make_string">
make_string</a><pre class="autodocfuncdef">
string make_string(mixed * al,
                   int max)
</pre><dd><br />
This method converts an alias into a string.  This is used by the
projects and plans and so on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
al - the alias to turn into a string<br />
<br />
<dd><b>Returns:</b>
<br />the converted string
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="my_find_player">
my_find_player</a><pre class="autodocfuncdef">
object my_find_player(string player)
</pre>
<dt class="autodocfuncname"><a name="query_appeal_player_file_name">
query_appeal_player_file_name</a><pre class="autodocfuncdef">
string query_appeal_player_file_name(string name)
</pre><dd><br />
This method returns the path to the pending appeal player file.
This is the appeal player files actual normal location, it was written to
allow moving the player files around easier.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the player whose file to find<br />
<br />
<dd><b>See also:</b>
<br /><a href="#test_user">test_user()</a> and <a href="#query_delete_player_file_name">query_delete_player_file_name()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_cap_name">
query_cap_name</a><pre class="autodocfuncdef">
string query_cap_name(string str)
</pre><dd><br />
This method returns a players cap_name.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players cap name
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_delete_player_file_name">
query_delete_player_file_name</a><pre class="autodocfuncdef">
string query_delete_player_file_name(string name)
</pre><dd><br />
This method returns the path to the deleted player file.
This is the deleted player files actual normal location, it was written to
allow moving the player files around easier.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the player whose file to find<br />
<br />
<dd><b>See also:</b>
<br /><a href="#test_user">test_user()</a> and <a href="#query_delete_player_file_name">query_delete_player_file_name()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_guild_data">
query_guild_data</a><pre class="autodocfuncdef">
mixed query_guild_data()
</pre><dd><br />
This method is called by query_level() in the base guild
inheritable to determine the specialisation of the current
player.
<br />

<dt class="autodocfuncname"><a name="query_pk_stats">
query_pk_stats</a><pre class="autodocfuncdef">
string query_pk_stats()
</pre>
<dt class="autodocfuncname"><a name="query_plan">
query_plan</a><pre class="autodocfuncdef">
string query_plan(string name,
                  int unused)
</pre><dd><br />
This method returns the players .plan even when they are off line.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the player<br />
<br />
<dd><b>Returns:</b>
<br />the plan, "" if none
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_player_disk_file_name">
query_player_disk_file_name</a><pre class="autodocfuncdef">
string query_player_disk_file_name(string name)
</pre>
<dt class="autodocfuncname"><a name="query_player_file_name">
query_player_file_name</a><pre class="autodocfuncdef">
string query_player_file_name(string name)
</pre><dd><br />
This method returns the path to the player file.
This is the player files actual normal location, it was written to
allow moving the player files around easier.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the player whose file to find<br />
<br />
<dd><b>See also:</b>
<br /><a href="#test_user">test_user()</a> and <a href="#query_delete_player_file_name">query_delete_player_file_name()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_player_ram_file_name">
query_player_ram_file_name</a><pre class="autodocfuncdef">
string query_player_ram_file_name(string name)
</pre>
<dt class="autodocfuncname"><a name="query_prevent_shadow">
query_prevent_shadow</a><pre class="autodocfuncdef">
nomask int query_prevent_shadow(object ob)
</pre>
<dt class="autodocfuncname"><a name="query_project">
query_project</a><pre class="autodocfuncdef">
string query_project(string name,
                     int unused)
</pre><dd><br />
This method returns the players .project even when they are off line.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the player<br />
<br />
<dd><b>Returns:</b>
<br />the project, "" if none
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_reference">
query_reference</a><pre class="autodocfuncdef">
string query_reference(string name)
</pre><dd><br />
This method returns the players .reference even when they are off line.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the player<br />
<br />
<dd><b>Returns:</b>
<br />the reference, "" if none
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_signature">
query_signature</a><pre class="autodocfuncdef">
string query_signature(string name)
</pre><dd><br />
This method returns the signature to use on posts for the player
even when they are off line.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the player<br />
<br />
<dd><b>Returns:</b>
<br />the signature, "" if none
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_skill">
query_skill</a><pre class="autodocfuncdef">
int query_skill(string skill)
</pre>
<dt class="autodocfuncname"><a name="remove_cache_entry">
remove_cache_entry</a><pre class="autodocfuncdef">
void remove_cache_entry(string name)
</pre>
<dt class="autodocfuncname"><a name="special_add_property">
special_add_property</a><pre class="autodocfuncdef">
int special_add_property(string pname,
                         string prop,
                         mixed val)
</pre><dd><br />
This method updates the cached properties, it's called by
/secure/login.
<br />

<dt class="autodocfuncname"><a name="test_active">
test_active</a><pre class="autodocfuncdef">
varargs int test_active(string player,
                        int noload,
                        int alwayscheck)
</pre><dd><br />
This method determines if a player is still active.
If you need to perform this on a lot of players please use the noload
parameter. When noload is set to 1 test_active will not attempt to load
the player file if it isn't currently loaded and will instead just do a
simple calculation of the players last login time. This is less accurate
but avoids lagging the mud.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
player - the name of the user<br />
noload - optional parameter to prevent test_active() loading the
              player file.<br />
alwayscheck - optional parameter to cause the system to check even
              if the player is logged in.<br />
<br />
<dd><b>Returns:</b>
<br />active or inactive (1 or 0)
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_age">
test_age</a><pre class="autodocfuncdef">
int test_age(string word)
</pre><dd><br />
This method determines the age of the player even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players age
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_aliases">
test_aliases</a><pre class="autodocfuncdef">
mapping test_aliases(string str)
</pre><dd><br />
This method determines the aliases the player has set even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the player's aliases
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_appealing">
test_appealing</a><pre class="autodocfuncdef">
int test_appealing(string str)
</pre><dd><br />
This method figures out if the user is marked for deletion pending appeal.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />1 if they are marked for deletion, 0 if they do not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_banished">
test_banished</a><pre class="autodocfuncdef">
int test_banished(string name)
</pre><dd><br />
This method checks to see if the name is banished of not.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the check for banishment.<br />
<br />
<dd><b>Returns:</b>
<br />1 if it banished, 0 if not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_birthday">
test_birthday</a><pre class="autodocfuncdef">
string test_birthday(string str)
</pre><dd><br />
This method determines the birthday of the player even if they are
not currently on<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players birthday (if set)
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_creator">
test_creator</a><pre class="autodocfuncdef">
int test_creator(string str)
</pre><dd><br />
This method determines if the player is a creator.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the player to test<br /><br />
<dd><b>See also:</b>
<br /><a href="#test_last">test_last()</a>, <a href="#test_user">test_user()</a> and <a href="#test_creator">test_creator()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="test_deity">
test_deity</a><pre class="autodocfuncdef">
string test_deity(string word)
</pre><dd><br />
This method determines the deity of the player even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players deity
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_deleting">
test_deleting</a><pre class="autodocfuncdef">
int test_deleting(string str)
</pre><dd><br />
This method figures out if the user is marked for deletion.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />1 if they are marked for deletion, 0 if they do not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_desc">
test_desc</a><pre class="autodocfuncdef">
string test_desc(string str)
</pre><dd><br />
This method determines the description of the player even if they are
not currently on<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players description
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_email">
test_email</a><pre class="autodocfuncdef">
string test_email(string str)
</pre><dd><br />
This method determines the email of the player even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players email
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_family">
test_family</a><pre class="autodocfuncdef">
string test_family(string str)
</pre><dd><br />
This method returns the players family name<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the family name
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_friends">
test_friends</a><pre class="autodocfuncdef">
mapping test_friends(string str)
</pre><dd><br />
This method determines the friends of the player has set even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the player's friends
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_gender">
test_gender</a><pre class="autodocfuncdef">
int test_gender(string str)
</pre><dd><br />
This method determines the gender of the player even if they are
not currently on<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players gender<br /><br />
<dd><b>See also:</b>
<br />/std/living/gender.c
<br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="test_guild">
test_guild</a><pre class="autodocfuncdef">
string test_guild(string word)
</pre><dd><br />
This method determines the guild of the player even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players guild
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_guild_data">
test_guild_data</a><pre class="autodocfuncdef">
mixed * test_guild_data(string word)
</pre><dd><br />
This method determines the guild data of the player even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players guild data
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_home_dir">
test_home_dir</a><pre class="autodocfuncdef">
string test_home_dir(string str)
</pre><dd><br />
This method returns the players home directory<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the player to test
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_homepage">
test_homepage</a><pre class="autodocfuncdef">
string test_homepage(string str)
</pre><dd><br />
This method determines the players homepage information even if they
are not currently on<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players location
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_ip_allowed">
test_ip_allowed</a><pre class="autodocfuncdef">
int test_ip_allowed(string name,
                    string ip)
</pre><dd><br />
Check if a players personal allow list permits logins from this IP<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - The player name.<br />
ip - The IP address.
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_last">
test_last</a><pre class="autodocfuncdef">
int test_last(string word,
              int noload)
</pre><dd><br />
This method determines the last log on of the player even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players last log on
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_last_on_from">
test_last_on_from</a><pre class="autodocfuncdef">
string test_last_on_from(string word)
</pre><dd><br />
This method determines the last log on of the player even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players last log on
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_level">
test_level</a><pre class="autodocfuncdef">
int test_level(string str)
</pre><dd><br />
This method determines the level of the player even if they are
not currently on<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players level<br /><br />
<dd><b>See also:</b>
<br />/std/living/gender.c
<br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="test_local_time_zone">
test_local_time_zone</a><pre class="autodocfuncdef">
mixed * test_local_time_zone(string name)
</pre><dd><br />
Check a players local time zone.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - The player name.<br />
ip - The IP address.
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_location">
test_location</a><pre class="autodocfuncdef">
string test_location(string str)
</pre><dd><br />
This method determines the players location finger information even if they
are not currently on<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players location
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_my_colours">
test_my_colours</a><pre class="autodocfuncdef">
mapping test_my_colours(string str)
</pre><dd><br />
This method determines the colours mapping of the specfied player<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players colour mapping<br /><br />
<dd><b>See also:</b>
<br />/std/living/gender.c
<br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="test_nationality">
test_nationality</a><pre class="autodocfuncdef">
string test_nationality(string str)
</pre><dd><br />
This method returns the players nationality.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the nationality
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_nationality_data">
test_nationality_data</a><pre class="autodocfuncdef">
string test_nationality_data(string str)
</pre><dd><br />
This method returns the players nationality data.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the nationality data
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_nationality_region">
test_nationality_region</a><pre class="autodocfuncdef">
string test_nationality_region(string str)
</pre><dd><br />
This method returns the players nationality region.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the nationality region
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_nicknames">
test_nicknames</a><pre class="autodocfuncdef">
mapping test_nicknames(string str)
</pre><dd><br />
This method determines the nicknames the player has set even if they are
not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the player's nicknames
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_player_killer">
test_player_killer</a><pre class="autodocfuncdef">
mixed test_player_killer(string word,
                         string str)
</pre><dd><br />
This method returns the current value of the player flag on the
player, even if they are not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
word - the player name<br />
<br />
<dd><b>Returns:</b>
<br />1 if they are a player killer, 0 if not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_player_title">
test_player_title</a><pre class="autodocfuncdef">
string test_player_title(string str)
</pre><dd><br />
This method returns the players title.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the title
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_property">
test_property</a><pre class="autodocfuncdef">
mixed test_property(string word,
                    string str)
</pre><dd><br />
This method returns the current value of the property on the
player, even if they are not currently on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
word - the player name<br />
str - the property to query<br />
<br />
<dd><b>Returns:</b>
<br />the value of the property
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_real_name">
test_real_name</a><pre class="autodocfuncdef">
string test_real_name(string str)
</pre><dd><br />
This method determines the real name of the player even if they are
not currently on<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players real name<br /><br />
<dd><b>See also:</b>
<br />/std/living/gender.c
<br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="test_start_time">
test_start_time</a><pre class="autodocfuncdef">
int test_start_time(string word)
</pre><dd><br />
This method determines the time the player started at.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />the players last log on
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_user">
test_user</a><pre class="autodocfuncdef">
int test_user(string str)
</pre><dd><br />
This method figures out if the user exists even if they are not on.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the name of the user<br />
<br />
<dd><b>Returns:</b>
<br />1 if they exist, 0 if they do not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_valid">
test_valid</a><pre class="autodocfuncdef">
varargs int test_valid(string name)
</pre><dd><br />
Validate a name by checking if it, or bits of it are banished.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - The name to be validated.<br />
full - Should we do full checks or just the basics.<br />
<br />
<dd><b>Returns:</b>
<br />1 if it's ok, 0 if not.
<br /><br />
<br /></dl>

</dl>
<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_player_record">
player_record</a><pre>
class player_record {
                      int cached;
                      int touched;
                      int deleting;
                      int appealing;
                      int gender;
                      int creator;
                      int active;
                      int level;
                      string player_name;
                      string cap_name;
                      mapping map_prop;
                      mapping player_info;
                      string deity;
                      string guild;
                      mixed * guild_data;
                      int age;
                      int last;
                      int flags;
                      string last_on_from;
                      int start_time;
                      string family_name;
                      string player_title;
                      string password;
                      mixed * project;
                      mixed * plan;
                      mixed * reference;
                      mixed * signature;
                      string home_dir;
                      string nationality;
                      string nationality_region;
                      mixed nationality_data;
                      mapping aliases;
                      mapping nicknames;
                      mapping friends;
                      mixed * timezone;
}

</pre>
</ul>
[an error occurred while processing this directive]