<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: auxiliary</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>auxiliary</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br>(built-in)</font></td></tr></table>
<p><tt>The module for installing auxiliary data</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-install"><strong>install</strong></a>(...)</dt><dd><tt><a href="#-install">install</a>(name, AuxClass, installs_on)<br>
<br>
Register new auxiliary data to the given name. Auxiliary data can be<br>
installed on: character, object, room, account, socket. Auxiliary data<br>
must be a class object of the following form:<br>
<br>
class ClassName:<br>
def __init__(self, storage_set = None)<br>
...<br>
<br>
def copy(self)<br>
...<br>
<br>
def copyTo(self, to)<br>
...<br>
<br>
def store(self)<br>
...<br>
<br>
The Store method returns a storage set representation of the data. If<br>
the auxiliary data is not persistent, an empty storage set can be<br>
returned. The class's init function must be able to handle reading in<br>
data from a storage set, or creating a fresh instance if set = None.</tt></dd></dl>
</td></tr></table>
</body></html>