[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 /global/communicate.c</h2>
The communication handling code for the player object.  Controls all
the basic channels and basic communication stuff.<p>Written by Pinkfish
<h2>Includes</h2>
This class includes the following files /include/language.h, /include/drinks.h, /include/playtesters.h, /include/player.h and /include/library.h<h2>Class Index</h2>
<ul><li><a href="#class_ignore_info">ignore_info</a>
<li><a href="#class_language_info">language_info</a>
</ul><h2>Method index</h2>
<ul>
<li><a href="#add_ignore">add_ignore</a>(string, string, int)<br/>
Adds someone to the ignore list for the specific person with the
reason and the number of hours the ignore lasts for.
<li><a href="#add_language">add_language</a>(string)<br/>
This method will add a language to a player/npc.
<li><a href="#adjust_max_sp">adjust_max_sp</a>(int)<br/>
This method adjusts the current maximum social points.
<li><a href="#adjust_sp">adjust_sp</a>(int)<br/>
This method changes the current number of social points
<li><a href="#comm_event">comm_event</a>(mixed, string, string, string, string, string)<li><a href="#comm_event_to">comm_event_to</a>(object, string, string, string, string, object *, string, object, string)<li><a href="#communicate_commands">communicate_commands</a>()<li><a href="#do_converse">do_converse</a>(string)<li><a href="#do_whisper">do_whisper</a>(object, string, string, string, string, object *, string, object, string)<li><a href="#do_wombat_repeat">do_wombat_repeat</a>(string, string)<li><a href="#is_ignoring">is_ignoring</a>(string)<br/>
FIgures out if the user is being ignored.
<li><a href="#query_all_ignoring">query_all_ignoring</a>()<br/>
THis method returns all the peopel we are ignoring.
<li><a href="#query_current_language">query_current_language</a>()<br/>
This method returns the language the person is currently speaking.
<li><a href="#query_default_language">query_default_language</a>()<br/>
This method returns the default language to use for the person.
<li><a href="#query_ignore_reason">query_ignore_reason</a>(string)<br/>
Returns the reason the user was ignored for.
<li><a href="#query_ignore_time_left">query_ignore_time_left</a>(string)<br/>
This figures out how much time is left before the user expires
from the ignore list.
<li><a href="#query_ignored_by">query_ignored_by</a>(object *)<br/>
This method returns the people in the array who are ignoring this
player.
<li><a href="#query_ignoring">query_ignoring</a>(object *)<br/>
This method returns the people in the array who this player is currently
ignoring.
<li><a href="#query_mangle_accent">query_mangle_accent</a>()<br/>
This method returns the mangle accents flag.
<li><a href="#query_max_sp">query_max_sp</a>()<br/>
This returns the maximum number of social points available.
<li><a href="#query_real_max_sp">query_real_max_sp</a>()<li><a href="#query_sp">query_sp</a>()<br/>
This method returns the current social points.
<li><a href="#query_tell_reply_list">query_tell_reply_list</a>()<br/>
This method returns the players tell reply list.
<li><a href="#remove_ignore">remove_ignore</a>(string)<br/>
Removes someone from the ignore list.
<li><a href="#set_default_language">set_default_language</a>(string)<br/>
This method sets the default language to use for the person.
<li><a href="#set_language">set_language</a>(string)<br/>
This method sets the language we are currently speaking.
<li><a href="#set_mangle_accent">set_mangle_accent</a>(int)<br/>
This method sets the mangle accents flag.
<li><a href="#set_max_sp">set_max_sp</a>(int)<br/>
This method sets the maximum social points.
<li><a href="#set_sp">set_sp</a>(int)<br/>
This method sets the current social points for the player
<li><a href="#set_tell_reply_list">set_tell_reply_list</a>(mixed)<br/>
This method sets the players tell reply list.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_ignore">
add_ignore</a><pre class="autodocfuncdef">
void add_ignore(string user,
                string reason,
                int num_hours)
</pre><dd><br />
Adds someone to the ignore list for the specific person with the
reason and the number of hours the ignore lasts for.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
user - the user to add<br />
reason - the reason to ignore<br />
num_hours - the number of hours to ignore for
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_language">
add_language</a><pre class="autodocfuncdef">
void add_language(string lang)
</pre><dd><br />
This method will add a language to a player/npc.  It is used to make sure
that a player or npc has a specific language.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
lang - the language to add
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="adjust_max_sp">
adjust_max_sp</a><pre class="autodocfuncdef">
int adjust_max_sp(int number)
</pre><dd><br />
This method adjusts the current maximum social points.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
number - the amount to adjust it by<br />
<br />
<dd><b>Returns:</b>
<br />the new maximum social points
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="adjust_sp">
adjust_sp</a><pre class="autodocfuncdef">
int adjust_sp(int number)
</pre><dd><br />
This method changes the current number of social points<br />
<br /><dl>
<dd><b>Parameters:</b><br />
number - the amount to change the social points by<br />
<br />
<dd><b>Returns:</b>
<br />the current social points
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="comm_event">
comm_event</a><pre class="autodocfuncdef">
void comm_event(mixed thing,
                string type,
                string start,
                string rest,
                string lang,
                string accent)
</pre>
<dt class="autodocfuncname"><a name="comm_event_to">
comm_event_to</a><pre class="autodocfuncdef">
void comm_event_to(object ob,
                   string event_type,
                   string start,
                   string type,
                   string words,
                   object * others,
                   string lang,
                   object me,
                   string accent)
</pre>
<dt class="autodocfuncname"><a name="communicate_commands">
communicate_commands</a><pre class="autodocfuncdef">
void communicate_commands()
</pre>
<dt class="autodocfuncname"><a name="do_converse">
do_converse</a><pre class="autodocfuncdef">
void do_converse(string str)
</pre>
<dt class="autodocfuncname"><a name="do_whisper">
do_whisper</a><pre class="autodocfuncdef">
void do_whisper(object ob,
                string event_type,
                string start,
                string type,
                string words,
                object * others,
                string lang,
                object me,
                string accent)
</pre>
<dt class="autodocfuncname"><a name="is_ignoring">
is_ignoring</a><pre class="autodocfuncdef">
int is_ignoring(string user)
</pre><dd><br />
FIgures out if the user is being ignored.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
user - the user to ignore<br />
<br />
<dd><b>Returns:</b>
<br />1 if the user is ignore, 0 if not.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_all_ignoring">
query_all_ignoring</a><pre class="autodocfuncdef">
string * query_all_ignoring()
</pre><dd><br />
THis method returns all the peopel we are ignoring.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the list of people we are ignoring
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_current_language">
query_current_language</a><pre class="autodocfuncdef">
string query_current_language()
</pre><dd><br />
This method returns the language the person is currently speaking.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the spoken language<br /><br />
<dd><b>See also:</b>
<br /><a href="#set_language">set_language()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_default_language">
query_default_language</a><pre class="autodocfuncdef">
string query_default_language()
</pre><dd><br />
This method returns the default language to use for the person.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the default language
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_ignore_reason">
query_ignore_reason</a><pre class="autodocfuncdef">
string query_ignore_reason(string user)
</pre><dd><br />
Returns the reason the user was ignored for.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
user - the uset to find the reason for<br />
<br />
<dd><b>Returns:</b>
<br />the reason
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_ignore_time_left">
query_ignore_time_left</a><pre class="autodocfuncdef">
int query_ignore_time_left(string user)
</pre><dd><br />
This figures out how much time is left before the user expires
from the ignore list.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
user - the user to find the time left for<br />
<br />
<dd><b>Returns:</b>
<br />the time left (0 if this is not being timed)
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_ignored_by">
query_ignored_by</a><pre class="autodocfuncdef">
object * query_ignored_by(object * people)
</pre><dd><br />
This method returns the people in the array who are ignoring this
player.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
people - the people to check to see for ignoring<br />
<br />
<dd><b>Returns:</b>
<br />the array of people that are ignoring this player<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_ignoring">query_ignoring()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_ignoring">
query_ignoring</a><pre class="autodocfuncdef">
object * query_ignoring(object * people)
</pre><dd><br />
This method returns the people in the array who this player is currently
ignoring.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
people - the people to check to see if they are being ignored<br />
<br />
<dd><b>Returns:</b>
<br />the people who are being ignored from the array<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_ignored_by">query_ignored_by()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_mangle_accent">
query_mangle_accent</a><pre class="autodocfuncdef">
int query_mangle_accent()
</pre><dd><br />
This method returns the mangle accents flag.  If this is set to 1 then the
accents will be mangled in the speech text, if it is set to 0 then
the accent will just be added to the say string instead.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the mangle accent flag
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_max_sp">
query_max_sp</a><pre class="autodocfuncdef">
int query_max_sp()
</pre><dd><br />
This returns the maximum number of social points available.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the maximum social points
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_real_max_sp">
query_real_max_sp</a><pre class="autodocfuncdef">
int query_real_max_sp()
</pre>
<dt class="autodocfuncname"><a name="query_sp">
query_sp</a><pre class="autodocfuncdef">
int query_sp()
</pre><dd><br />
This method returns the current social points.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the current social points
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_tell_reply_list">
query_tell_reply_list</a><pre class="autodocfuncdef">
mixed query_tell_reply_list()
</pre><dd><br />
This method returns the players tell reply list.
<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the tell reply list.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_ignore">
remove_ignore</a><pre class="autodocfuncdef">
void remove_ignore(string user)
</pre><dd><br />
Removes someone from the ignore list.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
user - the user to remove
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_default_language">
set_default_language</a><pre class="autodocfuncdef">
void set_default_language(string def)
</pre><dd><br />
This method sets the default language to use for the person.  The default
language is their native tongue, so things in this language show as
not being a special language.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
def - the default language
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_language">
set_language</a><pre class="autodocfuncdef">
int set_language(string str)
</pre><dd><br />
This method sets the language we are currently speaking.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the language we are current speaking<br />
<br />
<dd><b>See also:</b>
<br /><a href="#query_current_language">query_current_language()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="set_mangle_accent">
set_mangle_accent</a><pre class="autodocfuncdef">
void set_mangle_accent(int flag)
</pre><dd><br />
This method sets the mangle accents flag.  If this is set to 1 then the
accents will be mangled in the speech text, if it is set to 0 then
the accent will just be added to the say string instead.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
flag - the new value of the flag
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_max_sp">
set_max_sp</a><pre class="autodocfuncdef">
int set_max_sp(int number)
</pre><dd><br />
This method sets the maximum social points.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
number - the maxmum social points<br />
<br />
<dd><b>Returns:</b>
<br />the new maximum social points
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_sp">
set_sp</a><pre class="autodocfuncdef">
int set_sp(int number)
</pre><dd><br />
This method sets the current social points for the player<br />
<br /><dl>
<dd><b>Parameters:</b><br />
number - the number of social points
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_tell_reply_list">
set_tell_reply_list</a><pre class="autodocfuncdef">
int set_tell_reply_list(mixed list)
</pre><dd><br />
This method sets the players tell reply list.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
list - the reply list.<br />
tim - the timeout
<br />
<br />
<br /></dl>

</dl>
<h2>Protected Functions</h2>
These are functions that only objects inheriting the class can access.<p>
<dl>
<dt class="autodocfuncname"><a name="do_wombat_repeat">
do_wombat_repeat</a><pre class="autodocfuncdef">
int do_wombat_repeat(string str,
                     string com)
</pre>
</dl>
<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_ignore_info">
ignore_info</a><pre>
class ignore_info {
                    string person;
                    string reason;
                    int start;
                    int num_hours;
}

</pre>
<li><a name="class_language_info">
language_info</a><pre>
class language_info {
                      string cur_lang;
                      int mangle_accent;
                      string default_lang;
}

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