Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-27 10:16:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-06-13 00:42:51 +02:00
parent e23c95c799
commit 2a9eae5458
1239 changed files with 274 additions and 274 deletions
Download patch file Download diff file Expand all files Collapse all files

310
docs/1.0-dev/_modules/evennia/contrib/ingame_python/callbackhandler.html Normal file
View file

@ -0,0 +1,310 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>evennia.contrib.ingame_python.callbackhandler &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/language_data.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for evennia.contrib.ingame_python.callbackhandler</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Module containing the CallbackHandler for individual objects.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">namedtuple</span>
<div class="viewcode-block" id="CallbackHandler"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler">[docs]</a><span class="k">class</span> <span class="nc">CallbackHandler</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> The callback handler for a specific object.</span>
<span class="sd"> The script that contains all callbacks will be reached through this</span>
<span class="sd"> handler. This handler is therefore a shortcut to be used by</span>
<span class="sd"> developers. This handler (accessible through `obj.callbacks`) is a</span>
<span class="sd"> shortcut to manipulating callbacks within this object, getting,</span>
<span class="sd"> adding, editing, deleting and calling them.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">script</span> <span class="o">=</span> <span class="kc">None</span>
<div class="viewcode-block" id="CallbackHandler.__init__"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">obj</span> <span class="o">=</span> <span class="n">obj</span></div>
<div class="viewcode-block" id="CallbackHandler.all"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.all">[docs]</a> <span class="k">def</span> <span class="nf">all</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return all callbacks linked to this object.</span>
<span class="sd"> Returns:</span>
<span class="sd"> All callbacks in a dictionary callback_name: callback}. The callback</span>
<span class="sd"> is returned as a namedtuple to simplify manipulation.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">callbacks</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">handler</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">script</span>
<span class="k">if</span> <span class="n">handler</span><span class="p">:</span>
<span class="n">dicts</span> <span class="o">=</span> <span class="n">handler</span><span class="o">.</span><span class="n">get_callbacks</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">obj</span><span class="p">)</span>
<span class="k">for</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">in_list</span> <span class="ow">in</span> <span class="n">dicts</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">new_list</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">callback</span> <span class="ow">in</span> <span class="n">in_list</span><span class="p">:</span>
<span class="n">callback</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_callback</span><span class="p">(</span><span class="n">callback</span><span class="p">)</span>
<span class="n">new_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">callback</span><span class="p">)</span>
<span class="k">if</span> <span class="n">new_list</span><span class="p">:</span>
<span class="n">callbacks</span><span class="p">[</span><span class="n">callback_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_list</span>
<span class="k">return</span> <span class="n">callbacks</span></div>
<div class="viewcode-block" id="CallbackHandler.get"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.get">[docs]</a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the callbacks associated with this name.</span>
<span class="sd"> Args:</span>
<span class="sd"> callback_name (str): the name of the callback.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A list of callbacks associated with this object and of this name.</span>
<span class="sd"> Note:</span>
<span class="sd"> This method returns a list of callback objects (namedtuple</span>
<span class="sd"> representations). If the callback name cannot be found in the</span>
<span class="sd"> object&#39;s callbacks, return an empty list.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">all</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">callback_name</span><span class="p">,</span> <span class="p">[])</span></div>
<div class="viewcode-block" id="CallbackHandler.get_variable"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.get_variable">[docs]</a> <span class="k">def</span> <span class="nf">get_variable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">variable_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the variable value or None.</span>
<span class="sd"> Args:</span>
<span class="sd"> variable_name (str): the name of the variable.</span>
<span class="sd"> Returns:</span>
<span class="sd"> Either the variable&#39;s value or None.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">handler</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">script</span>
<span class="k">if</span> <span class="n">handler</span><span class="p">:</span>
<span class="k">return</span> <span class="n">handler</span><span class="o">.</span><span class="n">get_variable</span><span class="p">(</span><span class="n">variable_name</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="CallbackHandler.add"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.add">[docs]</a> <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">author</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">valid</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Add a new callback for this object.</span>
<span class="sd"> Args:</span>
<span class="sd"> callback_name (str): the name of the callback to add.</span>
<span class="sd"> code (str): the Python code associated with this callback.</span>
<span class="sd"> author (Character or Account, optional): the author of the callback.</span>
<span class="sd"> valid (bool, optional): should the callback be connected?</span>
<span class="sd"> parameters (str, optional): optional parameters.</span>
<span class="sd"> Returns:</span>
<span class="sd"> The callback definition that was added or None.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">handler</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">script</span>
<span class="k">if</span> <span class="n">handler</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_callback</span><span class="p">(</span>
<span class="n">handler</span><span class="o">.</span><span class="n">add_callback</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">author</span><span class="o">=</span><span class="n">author</span><span class="p">,</span> <span class="n">valid</span><span class="o">=</span><span class="n">valid</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="n">parameters</span>
<span class="p">)</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="CallbackHandler.edit"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.edit">[docs]</a> <span class="k">def</span> <span class="nf">edit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">author</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">valid</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Edit an existing callback bound to this object.</span>
<span class="sd"> Args:</span>
<span class="sd"> callback_name (str): the name of the callback to edit.</span>
<span class="sd"> number (int): the callback number to be changed.</span>
<span class="sd"> code (str): the Python code associated with this callback.</span>
<span class="sd"> author (Character or Account, optional): the author of the callback.</span>
<span class="sd"> valid (bool, optional): should the callback be connected?</span>
<span class="sd"> Returns:</span>
<span class="sd"> The callback definition that was edited or None.</span>
<span class="sd"> Raises:</span>
<span class="sd"> RuntimeError if the callback is locked.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">handler</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">script</span>
<span class="k">if</span> <span class="n">handler</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_callback</span><span class="p">(</span>
<span class="n">handler</span><span class="o">.</span><span class="n">edit_callback</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">author</span><span class="o">=</span><span class="n">author</span><span class="p">,</span> <span class="n">valid</span><span class="o">=</span><span class="n">valid</span>
<span class="p">)</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="CallbackHandler.remove"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.remove">[docs]</a> <span class="k">def</span> <span class="nf">remove</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Delete the specified callback bound to this object.</span>
<span class="sd"> Args:</span>
<span class="sd"> callback_name (str): the name of the callback to delete.</span>
<span class="sd"> number (int): the number of the callback to delete.</span>
<span class="sd"> Raises:</span>
<span class="sd"> RuntimeError if the callback is locked.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">handler</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">script</span>
<span class="k">if</span> <span class="n">handler</span><span class="p">:</span>
<span class="n">handler</span><span class="o">.</span><span class="n">del_callback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="n">number</span><span class="p">)</span></div>
<div class="viewcode-block" id="CallbackHandler.call"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.call">[docs]</a> <span class="k">def</span> <span class="nf">call</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Call the specified callback(s) bound to this object.</span>
<span class="sd"> Args:</span>
<span class="sd"> callback_name (str): the callback name to call.</span>
<span class="sd"> *args: additional variables for this callback.</span>
<span class="sd"> Kwargs:</span>
<span class="sd"> number (int, optional): call just a specific callback.</span>
<span class="sd"> parameters (str, optional): call a callback with parameters.</span>
<span class="sd"> locals (dict, optional): a locals replacement.</span>
<span class="sd"> Returns:</span>
<span class="sd"> True to report the callback was called without interruption,</span>
<span class="sd"> False otherwise. If the callbackHandler isn&#39;t found, return</span>
<span class="sd"> None.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">handler</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">script</span>
<span class="k">if</span> <span class="n">handler</span><span class="p">:</span>
<span class="k">return</span> <span class="n">handler</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">obj</span><span class="p">,</span> <span class="n">callback_name</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="CallbackHandler.format_callback"><a class="viewcode-back" href="../../../../api/evennia.contrib.ingame_python.html#evennia.contrib.ingame_python.callbackhandler.CallbackHandler.format_callback">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">format_callback</span><span class="p">(</span><span class="n">callback</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the callback namedtuple to represent the specified callback.</span>
<span class="sd"> Args:</span>
<span class="sd"> callback (dict): the callback definition.</span>
<span class="sd"> The callback given in argument should be a dictionary containing</span>
<span class="sd"> the expected fields for a callback (code, author, valid...).</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="s2">&quot;obj&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;obj&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="s2">&quot;name&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;name&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;unknown&quot;</span>
<span class="k">if</span> <span class="s2">&quot;number&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;number&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
<span class="k">if</span> <span class="s2">&quot;code&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;code&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="k">if</span> <span class="s2">&quot;author&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;author&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="s2">&quot;valid&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;valid&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="s2">&quot;parameters&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;parameters&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="k">if</span> <span class="s2">&quot;created_on&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;created_on&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="s2">&quot;updated_by&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;updated_by&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="s2">&quot;updated_on&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">callback</span><span class="p">:</span>
<span class="n">callback</span><span class="p">[</span><span class="s2">&quot;updated_on&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">Callback</span><span class="p">(</span><span class="o">**</span><span class="n">callback</span><span class="p">)</span></div></div>
<span class="n">Callback</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span>
<span class="s2">&quot;Callback&quot;</span><span class="p">,</span>
<span class="p">(</span>
<span class="s2">&quot;obj&quot;</span><span class="p">,</span>
<span class="s2">&quot;name&quot;</span><span class="p">,</span>
<span class="s2">&quot;number&quot;</span><span class="p">,</span>
<span class="s2">&quot;code&quot;</span><span class="p">,</span>
<span class="s2">&quot;author&quot;</span><span class="p">,</span>
<span class="s2">&quot;valid&quot;</span><span class="p">,</span>
<span class="s2">&quot;parameters&quot;</span><span class="p">,</span>
<span class="s2">&quot;created_on&quot;</span><span class="p">,</span>
<span class="s2">&quot;updated_by&quot;</span><span class="p">,</span>
<span class="s2">&quot;updated_on&quot;</span><span class="p">,</span>
<span class="p">),</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../../../index.html">Documentation overview</a><ul>
<li><a href="../../../index.html">Module code</a><ul>
<li><a href="../../../evennia.html">evennia</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<h3>Versions</h3>
<ul>
<li><a href="callbackhandler.html">1.0-dev (develop branch)</a></li>
<li><a href="../../../../../../versions/0.9.1/index.html">0.9.1 (master branch)</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2020, The Evennia developer community.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>
</body>
</html>