[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/basic/read_desc.c</h2>
This method keeps track of all the messages on the object for
reading etc.  Keeps track of the language, the text and the
size.<p>Written by Pinkfish
<h2>Inherits</h2>
This class inherits the following classes <a href="std.basic.desc.c.shtml">/std/basic/desc.c</a><h2>Includes</h2>
This class includes the following files <a href="include.language.h.shtml">/include/language.h</a> and <a href="include.nroff.h.shtml">/include/nroff.h</a><h2>Method index</h2>
<ul>
<li><a href="#add_read_mess">add_read_mess</a>(mixed, string, string, int)<br/>
This method adds a new read message onto the object.
<li><a href="#query_cur_size">query_cur_size</a>()<br/>
This method returns the current amount of wreiting size on the
object.
<li><a href="#query_max_size">query_max_size</a>()<br/>
This method returns the current maximum size of the object.
<li><a href="#query_read_mess">query_read_mess</a>()<br/>
This method returns the current read messae array on the object.
<li><a href="#query_read_short">query_read_short</a>(object, int)<br/>
This method returns the short description to use with the reading.
<li><a href="#query_readable_message">query_readable_message</a>(object, int)<br/>
This method returns the read message for the object.
<li><a href="#remove_read_mess">remove_read_mess</a>(string, string, string)<br/>
This method removes a piece of writing off the object.
<li><a href="#set_cur_size">set_cur_size</a>(int)<br/>
This method sets the current amount of writing size on
the object.
<li><a href="#set_max_size">set_max_size</a>(int)<br/>
This method sets the maximum amount of writing to be able
to be placed onto the object.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_read_mess">
add_read_mess</a><pre class="autodocfuncdef">
varargs mixed add_read_mess(mixed str,
                            string type,
                            string lang,
                            int size)
</pre><dd><br />
This method adds a new read message onto the object.
<p>
The str bit is the actual string to add, it is the message which
will get printed. The type is the type of the writing, like "spidery
writing" or "charcoal based letters". The language is the
language in which it is written and the size is the size of the
letters. The size is used to see if the writing can fit on the page.
<p>
If no type is
given, then no type bit is printed and if no size is specified a
size of 1 is the default.
<p>
This also adjusts the size of stuff on the object.  If too much
is attemnpted to be written ont
the object, the remainer will be cut off.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the text of the message<br />
type - the type of the message<br />
lang - the language the message is in<br />
size - the size of the message<br />
<br />
<dd><b>See also:</b>
<br /><a href="#query_read_mess">query_read_mess()</a>, <a href="#set_max_size">set_max_size()</a>, <a href="obj.handlers.language.c.shtml#query_language_size">/obj/handlers/language->query_language_size()</a> and <a href="obj.handlers.language.c.shtml#squidge_text">/obj/handlers/language->squidge_text()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_cur_size">
query_cur_size</a><pre class="autodocfuncdef">
int query_cur_size()
</pre><dd><br />
This method returns the current amount of wreiting size on the
object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the current amount of writing on the object
<br /><br />
<dd><b>See also:</b>
<br /><a href="#set_max_size">set_max_size()</a>, <a href="#add_read_mess">add_read_mess()</a> and <a href="#set_cur_size">set_cur_size()</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_max_size">
query_max_size</a><pre class="autodocfuncdef">
int query_max_size()
</pre><dd><br />
This method returns the current maximum size of the object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the current maximum size<br /><br />
<dd><b>See also:</b>
<br /><a href="#set_max_size">set_max_size()</a> and <a href="#add_read_mess">add_read_mess()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_read_mess">
query_read_mess</a><pre class="autodocfuncdef">
mixed * query_read_mess()
</pre><dd><br />
This method returns the current read messae array on the object.
The returned array consists of an array of arrays.  The internal
array has 4 elements, the first is the text of the mnessage
the second is the type of the message,m the third is the languae
and the last element is the size of the wiritn .
<p>
The defines in the file /include/language.h should be used
for the indexes into this array.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the read message array<br /><br />
<dd><b>See also:</b>
<br /><a href="#add_read_mess">add_read_mess()</a>, <a href="#set_max_size">set_max_size()</a> and /include/language.h
<br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_read_short">
query_read_short</a><pre class="autodocfuncdef">
string query_read_short(object player,
                        int ignore_labels)
</pre><dd><br />
This method returns the short description to use with the reading.
It will go: You read <read short>:
<p>
It will automaticly add a $name$ onto the end of the string for you.
This will be replaced with the correct a/the short for the message
which is printed.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
player - the player reading the message
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_readable_message">
query_readable_message</a><pre class="autodocfuncdef">
string query_readable_message(object player,
                              int ignore_labels)
</pre><dd><br />
This method returns the read message for the object.  This is what should
be displayed to the player if they attempt to read this object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the read message, 0 if there is none
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_read_mess">
remove_read_mess</a><pre class="autodocfuncdef">
int remove_read_mess(string str,
                     string type,
                     string lang)
</pre><dd><br />
This method removes a piece of writing off the object.
<p>
If you know the actual message or the language or the type you can remove
that message.
<p>
Using the type and or language is a very dodgy way of doing this.  Using
a combination is much better.
<p>
Any of the parameters set to a non-zero value will be used for the search.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
str - the text string<br />
type - the type of the text<br />
lang - the language it is written in<br />
<br />
<dd><b>Returns:</b>
<br />0 if the text was not found, 1 if it was
<br /><br />
<dd><b>See also:</b>
<br /><a href="obj.handlers.language.c.shtml#query_language_size">/obj/handlers/language->query_language_size()</a>, <a href="#add_read_mess">add_read_mess()</a> and <a href="#query_read_mess">query_read_mess()</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="set_cur_size">
set_cur_size</a><pre class="autodocfuncdef">
void set_cur_size(int siz)
</pre><dd><br />
This method sets the current amount of writing size on
the object.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
siz - the new current size
<br />
<br />
<dd><b>See also:</b>
<br /><a href="#set_max_size">set_max_size()</a>, <a href="#add_read_mess">add_read_mess()</a> and <a href="#query_cur_size">query_cur_size()</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="set_max_size">
set_max_size</a><pre class="autodocfuncdef">
void set_max_size(int siz)
</pre><dd><br />
This method sets the maximum amount of writing to be able
to be placed onto the object.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
siz - the maximum size<br />
<br />
<dd><b>See also:</b>
<br /><a href="#query_max_size">query_max_size()</a> and <a href="#add_read_mess">add_read_mess()
</a><br /><br /><br /></dl>

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