271 lines
17 KiB
HTML
271 lines
17 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>region — 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="settings" href="settings.html" />
|
|
<link rel="prev" title="permissions" href="permissions.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="settings.html" title="settings"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="permissions.html" title="permissions"
|
|
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="permissions.html"
|
|
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">permissions</span></tt></a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="settings.html"
|
|
title="next chapter"><tt class="docutils literal"><span class="pre">settings</span></tt></a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/modules/region.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.region">
|
|
<h1><tt class="xref docutils literal"><span class="pre">region</span></tt><a class="headerlink" href="#module-pyogp.lib.base.region" title="Permalink to this headline">¶</a></h1>
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.region.Region">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.region.</tt><tt class="descname">Region</tt><big>(</big><em>global_x=0</em>, <em>global_y=0</em>, <em>seed_capability_url=None</em>, <em>udp_blacklist=None</em>, <em>sim_ip=None</em>, <em>sim_port=None</em>, <em>circuit_code=None</em>, <em>agent=None</em>, <em>settings=None</em>, <em>message_handler=None</em>, <em>handle=None</em>, <em>events_handler=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>a region container</p>
|
|
<p>The Region class is a container for region specific data.
|
|
It is also a nice place for convenience code.</p>
|
|
<p>Example, of initializing a region class:</p>
|
|
<p>Initialize the login class</p>
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">region</span> <span class="o">=</span> <span class="n">Region</span><span class="p">(</span><span class="mf">256</span><span class="p">,</span> <span class="mf">256</span><span class="p">,</span> <span class="s">'https://somesim.cap/uuid'</span><span class="p">,</span> <span class="s">'EnableSimulator,TeleportFinish,CrossedRegion'</span><span class="p">,</span> <span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="mf">13000</span><span class="p">,</span> <span class="mf">650000000</span><span class="p">,</span> <span class="p">{</span><span class="s">'agent_id'</span><span class="p">:</span><span class="s">'00000000-0000-0000-0000-000000000000'</span><span class="p">,</span> <span class="s">'session_id'</span><span class="p">:</span><span class="s">'00000000-0000-0000-0000-000000000000'</span><span class="p">,</span> <span class="s">'secure_session_id:'</span><span class="mf">00000000</span><span class="o">-</span><span class="mf">0000</span><span class="o">-</span><span class="mf">0000</span><span class="o">-</span><span class="mf">0000</span><span class="o">-</span><span class="mf">000000000000</span><span class="s">'})</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Start the udp and event queue connections to the region</p>
|
|
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">region</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Sample implementations: examples/sample_region_connect.py
|
|
Tests: tests/region.txt, tests/test_region.py</p>
|
|
<p>initialize a region</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.connect">
|
|
<tt class="descname">connect</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.connect" title="Permalink to this definition">¶</a></dt>
|
|
<dd>connect to the udp circuit code and event queue</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.connect_child">
|
|
<tt class="descname">connect_child</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.connect_child" title="Permalink to this definition">¶</a></dt>
|
|
<dd>connect to the a child region udp circuit code</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.enable_callbacks">
|
|
<tt class="descname">enable_callbacks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.enable_callbacks" title="Permalink to this definition">¶</a></dt>
|
|
<dd>enables the callback handles for this Region</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.enable_child_simulator">
|
|
<tt class="descname">enable_child_simulator</tt><big>(</big><em>IP</em>, <em>Port</em>, <em>Handle</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.enable_child_simulator" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.enqueue_message">
|
|
<tt class="descname">enqueue_message</tt><big>(</big><em>packet</em>, <em>reliable=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.enqueue_message" title="Permalink to this definition">¶</a></dt>
|
|
<dd>queues packets for the messaging system to send</dd></dl>
|
|
|
|
<dl class="staticmethod">
|
|
<dt id="pyogp.lib.base.region.Region.handle_to_xy">
|
|
<em class="property">
|
|
static </em><tt class="descname">handle_to_xy</tt><big>(</big><em>handle</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.handle_to_xy" title="Permalink to this definition">¶</a></dt>
|
|
<dd>Convert a handle into an x,y region location. Handle can be an int or binary string.</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.kill_coroutines">
|
|
<tt class="descname">kill_coroutines</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.kill_coroutines" title="Permalink to this definition">¶</a></dt>
|
|
<dd>trigger to end processes spawned by the child regions</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.logout">
|
|
<tt class="descname">logout</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.logout" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a logout packet</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.onRegionHandshake">
|
|
<tt class="descname">onRegionHandshake</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.onRegionHandshake" title="Permalink to this definition">¶</a></dt>
|
|
<dd>handles the response to receiving a RegionHandshake packet</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.onStartPingCheck">
|
|
<tt class="descname">onStartPingCheck</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.onStartPingCheck" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends the CompletePingCheck packet</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.sendAgentUpdate">
|
|
<tt class="descname">sendAgentUpdate</tt><big>(</big><em>AgentID</em>, <em>SessionID</em>, <em>BodyRotation=(0.0</em>, <em>0.0</em>, <em>0.0</em>, <em>1.0)</em>, <em>HeadRotation=(0.0</em>, <em>0.0</em>, <em>0.0</em>, <em>1.0)</em>, <em>State=0</em>, <em>CameraCenter=(0.0</em>, <em>0.0</em>, <em>0.0)</em>, <em>CameraAtAxis=(0.0</em>, <em>0.0</em>, <em>0.0)</em>, <em>CameraLeftAxis=(0.0</em>, <em>0.0</em>, <em>0.0)</em>, <em>CameraUpAxis=(0.0</em>, <em>0.0</em>, <em>0.0)</em>, <em>Far=0</em>, <em>ControlFlags=0</em>, <em>Flags=0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendAgentUpdate" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends an AgentUpdate packet to <em>this</em> simulator</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.sendCompleteAgentMovement">
|
|
<tt class="descname">sendCompleteAgentMovement</tt><big>(</big><em>agent_id</em>, <em>session_id</em>, <em>circuit_code</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendCompleteAgentMovement" title="Permalink to this definition">¶</a></dt>
|
|
<dd>initializing on a simulator requires sending CompleteAgentMovement, also required on teleport</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.sendCompletePingCheck">
|
|
<tt class="descname">sendCompletePingCheck</tt><big>(</big><em>PingID</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendCompletePingCheck" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends a CompletePingCheck packet</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.sendRegionHandshakeReply">
|
|
<tt class="descname">sendRegionHandshakeReply</tt><big>(</big><em>AgentID</em>, <em>SessionID</em>, <em>Flags=0</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendRegionHandshakeReply" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends a RegionHandshake packet</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.sendUUIDNameRequest">
|
|
<tt class="descname">sendUUIDNameRequest</tt><big>(</big><em>agent_ids=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendUUIDNameRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>sends a packet requesting the name corresponding to a UUID</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.sendUseCircuitCode">
|
|
<tt class="descname">sendUseCircuitCode</tt><big>(</big><em>circuit_code</em>, <em>session_id</em>, <em>agent_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.sendUseCircuitCode" title="Permalink to this definition">¶</a></dt>
|
|
<dd>initializing on a simulator requires announcing the circuit code an agent will use</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.send_LogoutRequest">
|
|
<tt class="descname">send_LogoutRequest</tt><big>(</big><em>agent_id</em>, <em>session_id</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.send_LogoutRequest" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a LogoutRequest message to the host simulator</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.send_message">
|
|
<tt class="descname">send_message</tt><big>(</big><em>packet</em>, <em>reliable=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.send_message" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a packet to the host</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.send_message_next">
|
|
<tt class="descname">send_message_next</tt><big>(</big><em>packet</em>, <em>reliable=False</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.send_message_next" title="Permalink to this definition">¶</a></dt>
|
|
<dd>inserts this packet at the fron of the queue</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.Region.send_reliable">
|
|
<tt class="descname">send_reliable</tt><big>(</big><em>packet</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.send_reliable" title="Permalink to this definition">¶</a></dt>
|
|
<dd>send a reliable packet to the host</dd></dl>
|
|
|
|
<dl class="staticmethod">
|
|
<dt id="pyogp.lib.base.region.Region.xy_to_handle">
|
|
<em class="property">
|
|
static </em><tt class="descname">xy_to_handle</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.Region.xy_to_handle" title="Permalink to this definition">¶</a></dt>
|
|
<dd>Convert an x, y region location into a 64-bit handle</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.region.RegionSeedCapability">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.region.</tt><tt class="descname">RegionSeedCapability</tt><big>(</big><em>name</em>, <em>public_url</em>, <em>restclient=None</em>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.RegionSeedCapability" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>a seed capability which is able to retrieve other capabilities</p>
|
|
<p>initialize the capability</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.RegionSeedCapability.GET">
|
|
<tt class="descname">GET</tt><big>(</big><em>custom_headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.RegionSeedCapability.GET" title="Permalink to this definition">¶</a></dt>
|
|
<dd>call this capability, return the parsed result</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.RegionSeedCapability.POST">
|
|
<tt class="descname">POST</tt><big>(</big><em>payload</em>, <em>custom_headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.RegionSeedCapability.POST" title="Permalink to this definition">¶</a></dt>
|
|
<dd>call this capability, return the parsed result</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.RegionSeedCapability.POST_FILE">
|
|
<tt class="descname">POST_FILE</tt><big>(</big><em>file_name</em>, <em>custom_headers={}</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.RegionSeedCapability.POST_FILE" title="Permalink to this definition">¶</a></dt>
|
|
<dd>Opens file at file_name and posts contents to this cap.</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.region.RegionSeedCapability.get">
|
|
<tt class="descname">get</tt><big>(</big><em>names=</em><span class="optional">[</span><span class="optional">]</span>, <em>settings=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.region.RegionSeedCapability.get" title="Permalink to this definition">¶</a></dt>
|
|
<dd>if this is a seed cap we can retrieve other caps here</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="settings.html" title="settings"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="permissions.html" title="permissions"
|
|
>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> |