530 lines
37 KiB
HTML
530 lines
37 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>inventory — 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="llsd_builder" href="llsd_builder.html" />
|
|
<link rel="prev" title="helpers" href="helpers.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="llsd_builder.html" title="llsd_builder"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="helpers.html" title="helpers"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
|
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="helpers.html"
|
|
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">helpers</span></tt></a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="llsd_builder.html"
|
|
title="next chapter"><tt class="docutils literal"><span class="pre">llsd_builder</span></tt></a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/modules/inventory.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.inventory">
|
|
<h1><tt class="xref docutils literal"><span class="pre">inventory</span></tt><a class="headerlink" href="#module-pyogp.lib.base.inventory" title="Permalink to this headline">¶</a></h1>
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">InventoryManager</tt><big>(</big><em>agent=None</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>is an inventory container</p>
|
|
<p>Initialize the event queue client class
|
|
>>> inventory = InventoryManager()</p>
|
|
<p>Sample implementations: agent.py
|
|
Tests: tests/test_inventory.py</p>
|
|
<p>set up the inventory manager</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.confirm_inventory_offer">
|
|
<tt class="descname">confirm_inventory_offer</tt><big>(</big><em>FromAgentID</em>, <em>FromAgentName</em>, <em>InventoryName</em>, <em>ID</em>, <em>AssetType</em>, <em>ItemID</em>, <em>accept</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.confirm_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends an ImprovedInstantMessage packet accepting or declining an inventory offer</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.create_new_item">
|
|
<tt class="descname">create_new_item</tt><big>(</big><em>folder</em>, <em>name</em>, <em>desc</em>, <em>asset_type</em>, <em>inv_type</em>, <em>wearable_type</em>, <em>next_owner_permission</em>, <em>callback=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.create_new_item" title="Permalink to this definition">¶</a></dt>
|
|
<dd>Creates a new item in folder.</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.display_folder_contents">
|
|
<tt class="descname">display_folder_contents</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.display_folder_contents" title="Permalink to this definition">¶</a></dt>
|
|
<dd>returns a list of the local representation of a folder’s contents</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.enable_callbacks">
|
|
<tt class="descname">enable_callbacks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.enable_callbacks" title="Permalink to this definition">¶</a></dt>
|
|
<dd>enable monitors for certain inventory related packet events</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.give_inventory">
|
|
<tt class="descname">give_inventory</tt><big>(</big><em>ItemID=None</em>, <em>agent_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.give_inventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>offers another agent the specified inventory item</p>
|
|
<p>searches the local inventory for the specified ItemID
|
|
given a match, sends an ImprovedInventoryMessage packet to the specified AgentID</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.handle_inventory_offer">
|
|
<tt class="descname">handle_inventory_offer</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.handle_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
|
<dd>parses and handles an incoming inventory offer</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.onBulkUpdateInventory">
|
|
<tt class="descname">onBulkUpdateInventory</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.onBulkUpdateInventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd>handle the inventory data being delivered in the BullkUpdateInventory packet</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.onFetchInventoryReply">
|
|
<tt class="descname">onFetchInventoryReply</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.onFetchInventoryReply" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.onInventoryDescendents">
|
|
<tt class="descname">onInventoryDescendents</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.onInventoryDescendents" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.request_inventory_by_id">
|
|
<tt class="descname">request_inventory_by_id</tt><big>(</big><em>id_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.request_inventory_by_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd>ask for inventory data by id via a list</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.request_known_folder_contents">
|
|
<tt class="descname">request_known_folder_contents</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.request_known_folder_contents" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send requests to the server for contents of all known folders</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.search_inventory">
|
|
<tt class="descname">search_inventory</tt><big>(</big><em>folder_list=</em><span class="optional">[</span><span class="optional">]</span>, <em>item_id=None</em>, <em>name=None</em>, <em>match_list=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.search_inventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>search through all inventory folders for an id(uuid) or Name, and
|
|
return a list of matching InventoryItems or InventoryFolders</p>
|
|
<p>recursive search, based on folder_id. if no folder id is specified
|
|
look through everything in self.folders</p>
|
|
<p>This does not request inventory from the grid. It could, were we to go about enabling this...</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.search_inventory_folder">
|
|
<tt class="descname">search_inventory_folder</tt><big>(</big><em>folder_id</em>, <em>_id=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.search_inventory_folder" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>search an inventory folder for _id or name</p>
|
|
<p>return a list of matches</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.sendFetchInventoryDescendentsRequest">
|
|
<tt class="descname">sendFetchInventoryDescendentsRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.sendFetchInventoryDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for folder contents</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.sendFetchInventoryRequest">
|
|
<tt class="descname">sendFetchInventoryRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.sendFetchInventoryRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for inventory items in folder</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.sendFetchLibDescendentsRequest">
|
|
<tt class="descname">sendFetchLibDescendentsRequest</tt><big>(</big><em>item_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.sendFetchLibDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for library folder contents</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.sendFetchLibRequest">
|
|
<tt class="descname">sendFetchLibRequest</tt><big>(</big><em>item_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.sendFetchLibRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for library items</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.send_CreateInventoryItem">
|
|
<tt class="descname">send_CreateInventoryItem</tt><big>(</big><em>agent_id</em>, <em>session_id</em>, <em>callback_id</em>, <em>folder_id</em>, <em>transaction_id</em>, <em>next_owner_mask</em>, <em>type_</em>, <em>inv_type</em>, <em>wearable_type</em>, <em>name</em>, <em>desc</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.send_CreateInventoryItem" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends a CreateInventoryItem message</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryManager.send_FetchInventory">
|
|
<tt class="descname">send_FetchInventory</tt><big>(</big><em>agent_id</em>, <em>session_id</em>, <em>owner_id</em>, <em>inventory_ids</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryManager.send_FetchInventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a FetchInventory message to the host simulator
|
|
each of the ids in inventory_ids will be sent in it’s own InventoryData block</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.inventory.InventoryItem">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">InventoryItem</tt><big>(</big><em>ItemID=None</em>, <em>FolderID=None</em>, <em>CreatorID=None</em>, <em>OwnerID=None</em>, <em>GroupID=None</em>, <em>BaseMask=None</em>, <em>OwnerMask=None</em>, <em>GroupMask=None</em>, <em>EveryoneMask=None</em>, <em>NextOwnerMask=0</em>, <em>GroupOwned=None</em>, <em>AssetID=None</em>, <em>Type=None</em>, <em>InvType=None</em>, <em>Flags=None</em>, <em>SaleType=None</em>, <em>SalePrice=None</em>, <em>Name=None</em>, <em>Description=None</em>, <em>CreationDate=None</em>, <em>CRC=None</em>, <em>LastOwnerID=00000000-0000-0000-0000-000000000000</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryItem" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>represents an Inventory item</p>
|
|
<p>Initialize the InventoryItem class
|
|
>>> inventoryitem = InventoryItem()</p>
|
|
<p>Sample implementations: inventory.py
|
|
Tests: tests/test_inventory.py</p>
|
|
<p>initialize the inventory item</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryItem.give">
|
|
<tt class="descname">give</tt><big>(</big><em>agent</em>, <em>to_agent_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryItem.give" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends the target agent an inventory offer of this</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryItem.rez_object">
|
|
<tt class="descname">rez_object</tt><big>(</big><em>agent</em>, <em>relative_position=(1</em>, <em>0</em>, <em>0)</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryItem.rez_object" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryItem.update">
|
|
<tt class="descname">update</tt><big>(</big><em>agent</em>, <em>name=None</em>, <em>value=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryItem.update" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>allow arbitraty update to any data in the inventory item</p>
|
|
<p>accepts a dictionary of key:value pairs which will update the stored inventory items
|
|
and then send an UpdateInventoryItem packet</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">UDP_Inventory</tt><big>(</big><em>agent</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd><dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.confirm_inventory_offer">
|
|
<tt class="descname">confirm_inventory_offer</tt><big>(</big><em>FromAgentID</em>, <em>FromAgentName</em>, <em>InventoryName</em>, <em>ID</em>, <em>AssetType</em>, <em>ItemID</em>, <em>accept</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.confirm_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends an ImprovedInstantMessage packet accepting or declining an inventory offer</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.create_new_item">
|
|
<tt class="descname">create_new_item</tt><big>(</big><em>folder</em>, <em>name</em>, <em>desc</em>, <em>asset_type</em>, <em>inv_type</em>, <em>wearable_type</em>, <em>next_owner_permission</em>, <em>callback=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.create_new_item" title="Permalink to this definition">¶</a></dt>
|
|
<dd>Creates a new item in folder.</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.display_folder_contents">
|
|
<tt class="descname">display_folder_contents</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.display_folder_contents" title="Permalink to this definition">¶</a></dt>
|
|
<dd>returns a list of the local representation of a folder’s contents</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.enable_callbacks">
|
|
<tt class="descname">enable_callbacks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.enable_callbacks" title="Permalink to this definition">¶</a></dt>
|
|
<dd>enable monitors for certain inventory related packet events</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.give_inventory">
|
|
<tt class="descname">give_inventory</tt><big>(</big><em>ItemID=None</em>, <em>agent_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.give_inventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>offers another agent the specified inventory item</p>
|
|
<p>searches the local inventory for the specified ItemID
|
|
given a match, sends an ImprovedInventoryMessage packet to the specified AgentID</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.handle_inventory_offer">
|
|
<tt class="descname">handle_inventory_offer</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.handle_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
|
<dd>parses and handles an incoming inventory offer</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.onBulkUpdateInventory">
|
|
<tt class="descname">onBulkUpdateInventory</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.onBulkUpdateInventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd>handle the inventory data being delivered in the BullkUpdateInventory packet</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.onFetchInventoryReply">
|
|
<tt class="descname">onFetchInventoryReply</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.onFetchInventoryReply" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.onInventoryDescendents">
|
|
<tt class="descname">onInventoryDescendents</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.onInventoryDescendents" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.request_inventory_by_id">
|
|
<tt class="descname">request_inventory_by_id</tt><big>(</big><em>id_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.request_inventory_by_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd>ask for inventory data by id via a list</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.request_known_folder_contents">
|
|
<tt class="descname">request_known_folder_contents</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.request_known_folder_contents" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send requests to the server for contents of all known folders</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.search_inventory">
|
|
<tt class="descname">search_inventory</tt><big>(</big><em>folder_list=</em><span class="optional">[</span><span class="optional">]</span>, <em>item_id=None</em>, <em>name=None</em>, <em>match_list=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.search_inventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>search through all inventory folders for an id(uuid) or Name, and
|
|
return a list of matching InventoryItems or InventoryFolders</p>
|
|
<p>recursive search, based on folder_id. if no folder id is specified
|
|
look through everything in self.folders</p>
|
|
<p>This does not request inventory from the grid. It could, were we to go about enabling this...</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.search_inventory_folder">
|
|
<tt class="descname">search_inventory_folder</tt><big>(</big><em>folder_id</em>, <em>_id=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.search_inventory_folder" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>search an inventory folder for _id or name</p>
|
|
<p>return a list of matches</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.sendFetchInventoryDescendentsRequest">
|
|
<tt class="descname">sendFetchInventoryDescendentsRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.sendFetchInventoryDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for folder contents</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.sendFetchInventoryRequest">
|
|
<tt class="descname">sendFetchInventoryRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.sendFetchInventoryRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for folder attributes</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.sendFetchLibDescendentsRequest">
|
|
<tt class="descname">sendFetchLibDescendentsRequest</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.sendFetchLibDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for library items</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.sendFetchLibRequest">
|
|
<tt class="descname">sendFetchLibRequest</tt><big>(</big><em>item_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.sendFetchLibRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for library items</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.send_CreateInventoryItem">
|
|
<tt class="descname">send_CreateInventoryItem</tt><big>(</big><em>agent_id</em>, <em>session_id</em>, <em>callback_id</em>, <em>folder_id</em>, <em>transaction_id</em>, <em>next_owner_mask</em>, <em>type_</em>, <em>inv_type</em>, <em>wearable_type</em>, <em>name</em>, <em>desc</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.send_CreateInventoryItem" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends a CreateInventoryItem message</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.UDP_Inventory.send_FetchInventory">
|
|
<tt class="descname">send_FetchInventory</tt><big>(</big><em>agent_id</em>, <em>session_id</em>, <em>owner_id</em>, <em>inventory_ids</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.UDP_Inventory.send_FetchInventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a FetchInventory message to the host simulator
|
|
each of the ids in inventory_ids will be sent in it’s own InventoryData block</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.inventory.AIS">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">AIS</tt><big>(</big><em>agent</em>, <em>capabilities</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>AIS specific inventory manager</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.confirm_inventory_offer">
|
|
<tt class="descname">confirm_inventory_offer</tt><big>(</big><em>FromAgentID</em>, <em>FromAgentName</em>, <em>InventoryName</em>, <em>ID</em>, <em>AssetType</em>, <em>ItemID</em>, <em>accept</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.confirm_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends an ImprovedInstantMessage packet accepting or declining an inventory offer</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.create_new_item">
|
|
<tt class="descname">create_new_item</tt><big>(</big><em>folder</em>, <em>name</em>, <em>desc</em>, <em>asset_type</em>, <em>inv_type</em>, <em>wearable_type</em>, <em>next_owner_permission</em>, <em>callback=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.create_new_item" title="Permalink to this definition">¶</a></dt>
|
|
<dd>Creates a new item in folder.</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.display_folder_contents">
|
|
<tt class="descname">display_folder_contents</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.display_folder_contents" title="Permalink to this definition">¶</a></dt>
|
|
<dd>returns a list of the local representation of a folder’s contents</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.enable_callbacks">
|
|
<tt class="descname">enable_callbacks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.enable_callbacks" title="Permalink to this definition">¶</a></dt>
|
|
<dd>enable monitors for certain inventory related packet events</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.give_inventory">
|
|
<tt class="descname">give_inventory</tt><big>(</big><em>ItemID=None</em>, <em>agent_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.give_inventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>offers another agent the specified inventory item</p>
|
|
<p>searches the local inventory for the specified ItemID
|
|
given a match, sends an ImprovedInventoryMessage packet to the specified AgentID</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.handle_inventory_offer">
|
|
<tt class="descname">handle_inventory_offer</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.handle_inventory_offer" title="Permalink to this definition">¶</a></dt>
|
|
<dd>parses and handles an incoming inventory offer</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.onBulkUpdateInventory">
|
|
<tt class="descname">onBulkUpdateInventory</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.onBulkUpdateInventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd>handle the inventory data being delivered in the BullkUpdateInventory packet</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.onFetchInventoryReply">
|
|
<tt class="descname">onFetchInventoryReply</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.onFetchInventoryReply" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.onInventoryDescendents">
|
|
<tt class="descname">onInventoryDescendents</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.onInventoryDescendents" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.request_inventory_by_id">
|
|
<tt class="descname">request_inventory_by_id</tt><big>(</big><em>id_list=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.request_inventory_by_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd>ask for inventory data by id via a list</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.request_known_folder_contents">
|
|
<tt class="descname">request_known_folder_contents</tt><big>(</big><em>folder_id=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.request_known_folder_contents" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send requests to the server for contents of all known folders</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.search_inventory">
|
|
<tt class="descname">search_inventory</tt><big>(</big><em>folder_list=</em><span class="optional">[</span><span class="optional">]</span>, <em>item_id=None</em>, <em>name=None</em>, <em>match_list=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.search_inventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>search through all inventory folders for an id(uuid) or Name, and
|
|
return a list of matching InventoryItems or InventoryFolders</p>
|
|
<p>recursive search, based on folder_id. if no folder id is specified
|
|
look through everything in self.folders</p>
|
|
<p>This does not request inventory from the grid. It could, were we to go about enabling this...</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.search_inventory_folder">
|
|
<tt class="descname">search_inventory_folder</tt><big>(</big><em>folder_id</em>, <em>_id=None</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.search_inventory_folder" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>search an inventory folder for _id or name</p>
|
|
<p>return a list of matches</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.sendFetchInventoryDescendentsRequest">
|
|
<tt class="descname">sendFetchInventoryDescendentsRequest</tt><big>(</big><em>folder_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.sendFetchInventoryDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the server for inventory folder contents</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.sendFetchInventoryRequest">
|
|
<tt class="descname">sendFetchInventoryRequest</tt><big>(</big><em>item_ids=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.sendFetchInventoryRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for inventory item attributes</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.sendFetchLibDescendentsRequest">
|
|
<tt class="descname">sendFetchLibDescendentsRequest</tt><big>(</big><em>folder_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.sendFetchLibDescendentsRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the server for folder contents</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.sendFetchLibRequest">
|
|
<tt class="descname">sendFetchLibRequest</tt><big>(</big><em>folder_id</em>, <em>item_ids=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.sendFetchLibRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a request to the grid for library item attributes</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.send_CreateInventoryItem">
|
|
<tt class="descname">send_CreateInventoryItem</tt><big>(</big><em>agent_id</em>, <em>session_id</em>, <em>callback_id</em>, <em>folder_id</em>, <em>transaction_id</em>, <em>next_owner_mask</em>, <em>type_</em>, <em>inv_type</em>, <em>wearable_type</em>, <em>name</em>, <em>desc</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.send_CreateInventoryItem" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends a CreateInventoryItem message</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.AIS.send_FetchInventory">
|
|
<tt class="descname">send_FetchInventory</tt><big>(</big><em>agent_id</em>, <em>session_id</em>, <em>owner_id</em>, <em>inventory_ids</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.AIS.send_FetchInventory" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a FetchInventory message to the host simulator
|
|
each of the ids in inventory_ids will be sent in it’s own InventoryData block</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.inventory.InventoryFolder">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.inventory.</tt><tt class="descname">InventoryFolder</tt><big>(</big><em>Name=None</em>, <em>FolderID=None</em>, <em>ParentID=None</em>, <em>Version=None</em>, <em>Type=None</em>, <em>AgentID=00000000-0000-0000-0000-000000000000</em>, <em>Descendents=0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>represents an Inventory folder</p>
|
|
<p>Initialize the event queue client class
|
|
>>> inventoryfolder = InventoryFolder()</p>
|
|
<p>Sample implementations: inventory.py
|
|
Tests: tests/test_inventory.py</p>
|
|
<p>initialize the inventory folder</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryFolder.move">
|
|
<tt class="descname">move</tt><big>(</big><em>agent</em>, <em>parent_id</em>, <em>restamp=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder.move" title="Permalink to this definition">¶</a></dt>
|
|
<dd>reparents this inventory folder</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryFolder.purge_descendents">
|
|
<tt class="descname">purge_descendents</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder.purge_descendents" title="Permalink to this definition">¶</a></dt>
|
|
<dd>removes inventory from this folder, by unlinking the inventory from this parent folder</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryFolder.remove">
|
|
<tt class="descname">remove</tt><big>(</big><em>agent</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder.remove" title="Permalink to this definition">¶</a></dt>
|
|
<dd>removes this inventory folder</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryFolder.send_MoveInventoryFolder">
|
|
<tt class="descname">send_MoveInventoryFolder</tt><big>(</big><em>agent</em>, <em>agent_id</em>, <em>session_id</em>, <em>restamp</em>, <em>folder_id</em>, <em>parent_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder.send_MoveInventoryFolder" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends a MoveInventoryFolder message to the host simulator</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryFolder.send_PurgeInventoryDescendents">
|
|
<tt class="descname">send_PurgeInventoryDescendents</tt><big>(</big><em>agent</em>, <em>agent_id</em>, <em>session_id</em>, <em>folder_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder.send_PurgeInventoryDescendents" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a PurgeInventoryDescendents message to the host simulator</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.inventory.InventoryFolder.send_RemoveInventoryFolder">
|
|
<tt class="descname">send_RemoveInventoryFolder</tt><big>(</big><em>agent</em>, <em>agent_id</em>, <em>session_id</em>, <em>restamp</em>, <em>folder_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.inventory.InventoryFolder.send_RemoveInventoryFolder" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends a RemoveInventoryFolder message to the host simulator</dd></dl>
|
|
|
|
</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="llsd_builder.html" title="llsd_builder"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="helpers.html" title="helpers"
|
|
>previous</a> |</li>
|
|
<li><a href="../index.html">Pyogp v0.1 documentation</a> »</li>
|
|
<li><a href="../modules.html" >Modules</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2009, Pyogp team.
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
|
|
</div>
|
|
</body>
|
|
</html> |