Files
Hippolyzer/docs/html/modules/assets.html
2009-10-15 21:48:05 +00:00

182 lines
9.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>assets &mdash; Pyogp v0.1 documentation</title>
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
<link rel="up" title="Modules" href="../modules.html" />
<link rel="next" title="caps" href="caps.html" />
<link rel="prev" title="appearance" href="appearance.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="caps.html" title="caps"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="appearance.html" title="appearance"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Pyogp v0.1 documentation</a> &raquo;</li>
<li><a href="../modules.html" accesskey="U">Modules</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="appearance.html"
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">appearance</span></tt></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="caps.html"
title="next chapter"><tt class="docutils literal"><span class="pre">caps</span></tt></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/modules/assets.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-pyogp.lib.base.assets">
<h1><tt class="xref docutils literal"><span class="pre">assets</span></tt><a class="headerlink" href="#module-pyogp.lib.base.assets" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyogp.lib.base.assets.AssetWearable">
<em class="property">
class </em><tt class="descclassname">pyogp.lib.base.assets.</tt><tt class="descname">AssetWearable</tt><big>(</big><em>assetID</em>, <em>assetType</em>, <em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetWearable" title="Permalink to this definition"></a></dt>
<dd><dl class="method">
<dt id="pyogp.lib.base.assets.AssetWearable.parse_data">
<tt class="descname">parse_data</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetWearable.parse_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyogp.lib.base.assets.AssetManager">
<em class="property">
class </em><tt class="descclassname">pyogp.lib.base.assets.</tt><tt class="descname">AssetManager</tt><big>(</big><em>agent</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetManager" title="Permalink to this definition"></a></dt>
<dd><p>The AssetManager class handles the assets of an Agent() instance</p>
<p>Sample implementations:
Tests: test_assets.py</p>
<dl class="method">
<dt id="pyogp.lib.base.assets.AssetManager.enable_callbacks">
<tt class="descname">enable_callbacks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetManager.enable_callbacks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.assets.AssetManager.get_asset">
<tt class="descname">get_asset</tt><big>(</big><em>assetID</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetManager.get_asset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.assets.AssetManager.request_asset">
<tt class="descname">request_asset</tt><big>(</big><em>assetID</em>, <em>assetType</em>, <em>isPriority</em>, <em>callback=None</em>, <em>itemID=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetManager.request_asset" title="Permalink to this definition"></a></dt>
<dd>Sends a TransferRequest to the sim for asset assetID with type assetType,
will call back with the assetID and True with asset received or False
if request failed. On successful request the asset is store in
self.assets</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.assets.AssetManager.send_AssetUploadRequest">
<tt class="descname">send_AssetUploadRequest</tt><big>(</big><em>TransactionID</em>, <em>Type</em>, <em>Tempfile</em>, <em>StoreLocal</em>, <em>AssetData=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetManager.send_AssetUploadRequest" title="Permalink to this definition"></a></dt>
<dd>Sends an AssetUploadRequest packet to request that an asset be
uploaded to the to the sim</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.assets.AssetManager.send_TransferRequest">
<tt class="descname">send_TransferRequest</tt><big>(</big><em>TransferID</em>, <em>ChannelType</em>, <em>SourceType</em>, <em>Priority</em>, <em>Params</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetManager.send_TransferRequest" title="Permalink to this definition"></a></dt>
<dd>sends a TransferRequest packet to request an asset to download, the
assetID and assetType of the request are stored in the Params variable
see assets.request_asset for example.</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.assets.AssetManager.upload_script_via_caps">
<tt class="descname">upload_script_via_caps</tt><big>(</big><em>item_id</em>, <em>script</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetManager.upload_script_via_caps" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.assets.AssetManager.upload_via_udp">
<tt class="descname">upload_via_udp</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.AssetManager.upload_via_udp" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="pyogp.lib.base.assets.Asset">
<em class="property">
class </em><tt class="descclassname">pyogp.lib.base.assets.</tt><tt class="descname">Asset</tt><big>(</big><em>assetID</em>, <em>assetType</em>, <em>data</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.assets.Asset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="caps.html" title="caps"
>next</a> |</li>
<li class="right" >
<a href="appearance.html" title="appearance"
>previous</a> |</li>
<li><a href="../index.html">Pyogp v0.1 documentation</a> &raquo;</li>
<li><a href="../modules.html" >Modules</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Pyogp team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
</div>
</body>
</html>