[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 /std/effects/object/talker.c</h2>
This is the effect skelton docs.  This effect
has a classification of "magic.talker".
<p>
Describe the arguments in here.<p><b>See also:</b><br>help::effects
.c<h2>Includes</h2>
This class includes the following files <a href="include.talker.h.shtml">/include/talker.h</a>, <a href="include.nomic_system.h.shtml">/include/nomic_system.h</a>, <a href="include.guilds.h.shtml">/include/guilds.h</a>, <a href="include.library.h.shtml">/include/library.h</a>, <a href="include.deity.h.shtml">/include/deity.h</a>, <a href="include.playtesters.h.shtml">/include/playtesters.h</a>, /std/effects/object/path.h and <a href="include.player.h.shtml">/include/player.h</a><h2>Method index</h2>
<dl><ul>
<li><a href="#all_channels">all_channels</a>(object)<br/>
This method is used to determine which talker channels can use.
<li><a href="#channels">channels</a>()<br/>
This returns the channels that a player is on in a nifty
formatted way.
<li><a href="#clear_cache">clear_cache</a>(string)<br/>
This method is used to clear a specific person's cache 
details.
<li><a href="#find_actual_talker">find_actual_talker</a>(object)<li><a href="#list">list</a>(string, int)<br/>
This method returns a formatted list of which players are using the 
talker.
<li><a href="#new_talker_args">new_talker_args</a>()<br/>
This method returns the "default" effect arguments.
<li><a href="#normalise_name">normalise_name</a>(string)<li><a href="#query_channel_cache">query_channel_cache</a>(string)<br/>
This method is used for debugging purposes to query the 
channel cache.
<li><a href="#valid">valid</a>(mixed, object)<br/>
This method is used to check whether or not a channel (or a list of
channels are valid.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="all_channels">
all_channels</a><pre>
string * all_channels(object player)
</pre></br>
This method is used to determine which talker channels can use.
It also caches the data so that it only has to be recalculated 
once.
<p>
<br/><ul>
<li><b>Parameters:</b>
<br/>player - the player's channel list to generate
<li><b>Returns:</b>
<br/>an array of channel names. (string *)
<li><b>See also:</b>
<br/><a href="#clear_cache">clear_cache()</a> and <a href="#query_channel_cache">query_channel_cache()
</a></dl>

<ul><a name="channels">
channels</a><pre>
string channels()
</pre></br>
This returns the channels that a player is on in a nifty
formatted way.  Used in the channel list and talker shadow.
<br/><ul>
<li><b>Returns:</b>
<br/>a list of channels that this_player() is on.

</dl>

<ul><a name="clear_cache">
clear_cache</a><pre>
void clear_cache(string person)
</pre></br>
This method is used to clear a specific person's cache 
details.  It is called from the shadow when a person
attempts to re-add a channel, so they their details
can be updated.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person's name to clear from the cache.

</dl>

<ul><a name="find_actual_talker">
find_actual_talker</a><pre>
object find_actual_talker(object thing)
</pre>
<ul><a name="list">
list</a><pre>
string list(string word,
            int brief)
</pre></br>
This method returns a formatted list of which players are using the 
talker.
<br/><ul>
<li><b>Parameters:</b>
<br/>word - the name of a specific channel to get a listing of.
<br/>brief - only show the people, not what they are listening to
<li><b>Returns:</b>
<br/>a formatted string containing who is on a channel.

</dl>

<ul><a name="normalise_name">
normalise_name</a><pre>
string normalise_name(string channel)
</pre>
<ul><a name="query_channel_cache">
query_channel_cache</a><pre>
varargs mapping query_channel_cache(string person)
</pre></br>
This method is used for debugging purposes to query the 
channel cache.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the name of a person to query. If this is not
specified, then the entire channel cache is returned.
<li><b>Returns:</b>
<br/>a mapping containing channel cache data.

</dl>

<ul><a name="valid">
valid</a><pre>
varargs int valid(mixed word,
                  object who)
</pre></br>
This method is used to check whether or not a channel (or a list of
channels are valid.
<br/><ul>
<li><b>Parameters:</b>
<br/>word - if this is a string, then valid() checks to see whether
or not the channel can be used.  If it is an array, then it validates
all the channels mentioned.
<li><b>Returns:</b>
<br/>1 if the channel (or channels) are valid, 0 if they are not.

</dl>


<h2>Protected Functions</h2>
These are functions that only objects inheriting the class can access.<p>
<ul><a name="new_talker_args">
new_talker_args</a><pre>
class talker_args new_talker_args()
</pre></br>
This method returns the "default" effect arguments. They are used
if the existing ones are invalid (or old).
<br/><ul>
<li><b>Returns:</b>
<br/>a talker_args class containing "new" arguments.

</dl>


[an error occurred while processing this directive]