<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>Discworld MUD</title>
    <link href="/external/includes/style.css" rel="stylesheet" type="text/css">
    <link rel="shortcut icon" href="/favicon.ico">
    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  </head>
  <body>
    <table border="0" width="95%">
        <tr>
          <td style="width:125px">
            <a href="/lpc/index.html"><img src="/external/images/logo_turtle.gif" style="border-style:none" alt="Home" width="110" height="106"></a>
          </td>
          <td valign="top">
            <br>
            <br>
            <script type="text/javascript" src="/external/includes/discworld.js"></script>
            <div id="textnav" style="visibility:hidden;position:absolute;">
              <a href="/lpc/about/">About</a>  | <a href="/lpc/playing/">Playing</a>  | <a href="/lpc/~Playtesters/">Playtesting</a>  | <a href="/lpc/creating/">Creating</a>  | <a href="/lpc/links/">Links</a> 
              <!--%textsubmenu%-->
            </div>
          </td>
        </tr>
        <tr>
          <td valign="top" style="width:125px">
            <!--%login%-->
          <p style="text-align:center" class="menu"><a href="javascript:popup('/external/java/newtelnet/java_client.shtml','JavaClient', 'width=800,height=600,resizable=yes,scrollbar=yes,toolbar=no,menubar=no,location=no,directories=no,status=no')">Play Now</a></p>

          </td>
          <td valign="top">


[<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/room/safe_room.c</h2>
This is the object that is the keeper of the safe room. This should "
be an NPC.<h2>Inherits</h2>
This class inherits the following classes <a href="std.room.basic_room.c.shtml">/std/room/basic_room.c</a><h2>Includes</h2>
This class includes the following files <a href="include.armoury.h.shtml">/include/armoury.h</a><h2>Method index</h2>
<dl><ul>
<li><a href="#do_dream">do_dream</a>(string)<li><a href="#do_rest">do_rest</a>(string)<li><a href="#event_enter">event_enter</a>(object, string, string)<li><a href="#event_exit">event_exit</a>(object, string, object)<li><a href="#event_fight_in_progress">event_fight_in_progress</a>(object, object)<li><a href="#make_calm">make_calm</a>(object)<li><a href="#query_calm_mess">query_calm_mess</a>()<br/>
This returns the message given to the player when they are calmed.
<li><a href="#query_dream_chats">query_dream_chats</a>()<br/>
This returns the chats given to the player when they dream.
<li><a href="#query_keeper">query_keeper</a>()<br/>
This returns the object that is the keeper of the safe room.
<li><a href="#query_keeper_stop_emote">query_keeper_stop_emote</a>()<br/>
This returns the emote made by the room's keeper, should there be
one, when an active fight is stopped.
<li><a href="#query_rest_mess">query_rest_mess</a>()<br/>
This returns the message given to the player when they rest.
<li><a href="#query_room_stop_mess">query_room_stop_mess</a>()<br/>
This returns the message given to the player when they are calmed.
<li><a href="#query_sneak_stop_mess">query_sneak_stop_mess</a>()<br/>
This returns the message given when the player attempts to sneak
into the room.
<li><a href="#query_violent_action_mess">query_violent_action_mess</a>()<br/>
This returns the message given when the player attempts an action
which is not permitted by the room.
<li><a href="#set_calm_mess">set_calm_mess</a>(string)<br/>
This sets the message given to the player when they are calmed.
<li><a href="#set_dream_chats">set_dream_chats</a>(string *)<br/>
This sets the array of chats given to the player when they dream in
here.
<li><a href="#set_keeper">set_keeper</a>(object)<li><a href="#set_keeper_stop_emote">set_keeper_stop_emote</a>(string)<br/>
This sets the emote made by the room's keeper, should there be
one, when an active fight is stopped.
<li><a href="#set_rest_mess">set_rest_mess</a>(string)<br/>
This sets the message given to the player when they rest.
<li><a href="#set_room_stop_mess">set_room_stop_mess</a>(string)<br/>
This sets the message the room gives to a player when an active fight
is stopped.
<li><a href="#set_sneak_stop_mess">set_sneak_stop_mess</a>(string)<br/>
This sets the message given when the player attempts to sneak
into the room.
<li><a href="#set_violent_action_mess">set_violent_action_mess</a>(string)<br/>
This sets the message given when the player attempts an action
which is not permitted by the room.
<li><a href="#stop_sneaking">stop_sneaking</a>(object)<li><a href="#trap_action">trap_action</a>(string)</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="do_dream">
do_dream</a><pre>
int do_dream(string str)
</pre>
<ul><a name="do_rest">
do_rest</a><pre>
int do_rest(string str)
</pre>
<ul><a name="event_enter">
event_enter</a><pre>
void event_enter(object ob,
                 string stringy,
                 string stringy2)
</pre>
<ul><a name="event_exit">
event_exit</a><pre>
void event_exit(object ob,
                string message,
                object to)
</pre>
<ul><a name="event_fight_in_progress">
event_fight_in_progress</a><pre>
void event_fight_in_progress(object ob1,
                             object ob2)
</pre>
<ul><a name="make_calm">
make_calm</a><pre>
void make_calm(object blue)
</pre>
<ul><a name="query_calm_mess">
query_calm_mess</a><pre>
string query_calm_mess()
</pre></br>
This returns the message given to the player when they are calmed.


<ul><a name="query_dream_chats">
query_dream_chats</a><pre>
string * query_dream_chats()
</pre></br>
This returns the chats given to the player when they dream.


<ul><a name="query_keeper">
query_keeper</a><pre>
object query_keeper()
</pre></br>
This returns the object that is the keeper of the safe room.


<ul><a name="query_keeper_stop_emote">
query_keeper_stop_emote</a><pre>
string query_keeper_stop_emote()
</pre></br>
This returns the emote made by the room's keeper, should there be
one, when an active fight is stopped.


<ul><a name="query_rest_mess">
query_rest_mess</a><pre>
string query_rest_mess()
</pre></br>
This returns the message given to the player when they rest.


<ul><a name="query_room_stop_mess">
query_room_stop_mess</a><pre>
string query_room_stop_mess()
</pre></br>
This returns the message given to the player when they are calmed.


<ul><a name="query_sneak_stop_mess">
query_sneak_stop_mess</a><pre>
string query_sneak_stop_mess()
</pre></br>
This returns the message given when the player attempts to sneak
into the room.


<ul><a name="query_violent_action_mess">
query_violent_action_mess</a><pre>
string query_violent_action_mess()
</pre></br>
This returns the message given when the player attempts an action
which is not permitted by the room.


<ul><a name="set_calm_mess">
set_calm_mess</a><pre>
void set_calm_mess(string mess)
</pre></br>
This sets the message given to the player when they are calmed.
<br/><ul>
<li><b>Parameters:</b>
<br/>mess - The calmed message.

</dl>

<ul><a name="set_dream_chats">
set_dream_chats</a><pre>
void set_dream_chats(string * chats)
</pre></br>
This sets the array of chats given to the player when they dream in
here.
<br/><ul>
<li><b>Parameters:</b>
<br/>chats - The chat array, which is just a list of strings.

</dl>

<ul><a name="set_keeper">
set_keeper</a><pre>
void set_keeper(object ob)
</pre>
<ul><a name="set_keeper_stop_emote">
set_keeper_stop_emote</a><pre>
void set_keeper_stop_emote(string mess)
</pre></br>
This sets the emote made by the room's keeper, should there be
one, when an active fight is stopped.  If this is set and the keeper
does not exist, the room stop message (set_room_stop_mess) will be
used.  The initial : to emote is not required.
<br/><ul>
<li><b>Parameters:</b>
<br/>mess - The calmed emote.

</dl>

<ul><a name="set_rest_mess">
set_rest_mess</a><pre>
void set_rest_mess(string mess)
</pre></br>
This sets the message given to the player when they rest.
<br/><ul>
<li><b>Parameters:</b>
<br/>mess - The rest message.

</dl>

<ul><a name="set_room_stop_mess">
set_room_stop_mess</a><pre>
void set_room_stop_mess(string mess)
</pre></br>
This sets the message the room gives to a player when an active fight
is stopped.  This will only be used if the room has no keeper.
<br/><ul>
<li><b>Parameters:</b>
<br/>mess - The calmed message.

</dl>

<ul><a name="set_sneak_stop_mess">
set_sneak_stop_mess</a><pre>
void set_sneak_stop_mess(string mess)
</pre></br>
This sets the message given when the player attempts to sneak
into the room.
<br/><ul>
<li><b>Parameters:</b>
<br/>mess - The end of sneak message.

</dl>

<ul><a name="set_violent_action_mess">
set_violent_action_mess</a><pre>
void set_violent_action_mess(string mess)
</pre></br>
This sets the message given when the player attempts an action
which is not permitted by the room.
<br/><ul>
<li><b>Parameters:</b>
<br/>mess - The failure message.

</dl>

<ul><a name="stop_sneaking">
stop_sneaking</a><pre>
void stop_sneaking(object sneaker)
</pre>
<ul><a name="trap_action">
trap_action</a><pre>
int trap_action(string str)
</pre>

</td>
</tr>
<tr>
<td valign="bottom" align="center">
<table>
<tr>
<td align="center" class="imgcell">
<a href="http://validator.w3.org/check?uri=referer"><img src="/external/images/valid-html401" alt="Valid HTML 4.01 Transitional" height=31 width=88 border=0></a>
</td>
</tr>
<tr>
<td align="center" class="imgcell">
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img height="31" width="88" style="border-style:none" src="/external/images/vcss" alt="Valid CSS!"></a>
</td>
</tr>
<tr>
<td align="center">
<a href="/lpc/html_css.html" style="font-size:smaller">Read More</a>
</td>
</tr>
</table>
</td>
<td align="left" valign="top">
<h3></h3>
<p class="copyright">Brought to you by CMOT Dibbler's <a href="/lpc/sausages.html">Sensational Sausages</a>; buy one while they're hot.<br>
Copyright &copy; Discworld MUD, <a href="javascript:popup('/external/java/newtelnet/java_client.shtml','JavaClient', 'width=800,height=600,resizable=yes,toolbar=no,menubar=no,location=no,directories=no,status=no')">Play Now</a>, <a href="http://www.topmudsites.com/cgi-bin/topmuds/rankem.cgi?action=in&amp;id=pinkfish" rel="external">Vote</a>.</p>
</td>
</tr>
</table>
</body>
</html>

