[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/identity_hold.c</h2>
This inherit deals with things on an object that's personal to the player
holding it at the moment.  This means, for now, "identify" and "keep" tags.
These are removed if the object leaves the player's inventory for too long.
This code was adapted from an effect/shadow pair.<p>Written by Woom<p>Started December 05, 2005
<h2>Method index</h2>
<ul>
<li><a href="#query_full_identifier">query_full_identifier</a>()<br/>
If identified, this returns the full identifier set for the object.
<li><a href="#query_identifier">query_identifier</a>()<br/>
If identified, this returns the identify name of the object.
<li><a href="#query_identity_hold_owner">query_identity_hold_owner</a>()<br/>
This returns the owner of the item.
<li><a href="#query_keep">query_keep</a>()<br/>
This tells us if the object is set to be kept or not.
<li><a href="#reset_keep">reset_keep</a>()<br/>
This sets the object as no longer kept.
<li><a href="#set_identifier">set_identifier</a>(string)<br/>
This sets up an identifier for the object.
<li><a href="#set_identity_hold_owner">set_identity_hold_owner</a>(object)<br/>
This sets the "owner" of the item.
<li><a href="#set_keep">set_keep</a>()<br/>
This sets the object as being kept.
<li><a href="#set_keep_value">set_keep_value</a>(int)<br/>
This sets the value of the keep flag.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="query_full_identifier">
query_full_identifier</a><pre class="autodocfuncdef">
string query_full_identifier()
</pre><dd><br />
If identified, this returns the full identifier set for the object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />The full identifier
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_identifier">
query_identifier</a><pre class="autodocfuncdef">
string query_identifier()
</pre><dd><br />
If identified, this returns the identify name of the object.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />The identify name
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_identity_hold_owner">
query_identity_hold_owner</a><pre class="autodocfuncdef">
object query_identity_hold_owner()
</pre><dd><br />
This returns the owner of the item.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />The item's owner
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_keep">
query_keep</a><pre class="autodocfuncdef">
int query_keep()
</pre><dd><br />
This tells us if the object is set to be kept or not.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />1 if the object is kept, else 0
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="reset_keep">
reset_keep</a><pre class="autodocfuncdef">
void reset_keep()
</pre><dd><br />
This sets the object as no longer kept.
<br />

<dt class="autodocfuncname"><a name="set_identifier">
set_identifier</a><pre class="autodocfuncdef">
void set_identifier(string word)
</pre><dd><br />
This sets up an identifier for the object.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
word - The string to use as identifier.  The last word will become the
identifier name, while all words before that become identifier adjectives
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_identity_hold_owner">
set_identity_hold_owner</a><pre class="autodocfuncdef">
void set_identity_hold_owner(object ob)
</pre><dd><br />
This sets the "owner" of the item.  This must be set after setting the keep
or identify properties, so that the object knows whom these properties apply
to.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
ob - The player to set as owner of the item
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_keep">
set_keep</a><pre class="autodocfuncdef">
void set_keep()
</pre><dd><br />
This sets the object as being kept.
<br />

<dt class="autodocfuncname"><a name="set_keep_value">
set_keep_value</a><pre class="autodocfuncdef">
void set_keep_value(int keep)
</pre><dd><br />
This sets the value of the keep flag.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
keep - The value to set to: 1 if the item should be kept, else 0
<br />
<br />
<br /></dl>

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