Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-31 21:17:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Updated HTML docs

Browse source
This commit is contained in:
Evennia docbuilder action 2022-07-05 17:32:14 +00:00
parent 70b4caedb6
commit 5649e6f7e7
58 changed files with 328 additions and 163 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/1.0-dev/_modules/evennia/accounts/accounts.html
View file

@ -720,7 +720,7 @@
<span class="sd"> typeclass (str, optional): Typeclass to use for this character. If</span>
<span class="sd"> not given, use settings.BASE_CHARACTER_TYPECLASS.</span>
<span class="sd"> permissions (list, optional): If not given, use the account&#39;s permissions.</span>
<span class="sd"> ip (str, optiona): The client IP creating this character. Will fall back to the</span>
<span class="sd"> ip (str, optional): The client IP creating this character. Will fall back to the</span>
<span class="sd"> one stored for the account if not given.</span>
<span class="sd"> kwargs (any): Other kwargs will be used in the create_call.</span>
<span class="sd"> Returns:</span>
@ -997,7 +997,7 @@
<span class="sd"> kwargs (any): Other keyword arguments will be added to the</span>
<span class="sd"> found command object instance as variables before it</span>
<span class="sd"> executes. This is unused by default Evennia but may be</span>
<span class="sd"> used to set flags and change operating paramaters for</span>
<span class="sd"> used to set flags and change operating parameters for</span>
<span class="sd"> commands at run-time.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -1475,7 +1475,7 @@
<span class="bp">self</span><span class="o">.</span><span class="n">_send_to_connect_channel</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;|G</span><span class="si">{key}</span><span class="s2"> connected|n&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">))</span>
<span class="k">if</span> <span class="n">_MULTISESSION_MODE</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="c1"># in this mode we should have only one character available. We</span>
<span class="c1"># try to auto-connect to our last conneted object, if any</span>
<span class="c1"># try to auto-connect to our last connected object, if any</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">puppet_object</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">_last_puppet</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
@ -1502,7 +1502,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Called by the login process if a user account is targeted correctly</span>
<span class="sd"> but provided with an invalid password. By default it does nothing,</span>
<span class="sd"> but exists to be overriden.</span>
<span class="sd"> but exists to be overridden.</span>
<span class="sd"> Args:</span>
<span class="sd"> session (session): Session logging in.</span>
@ -1745,7 +1745,7 @@
<span class="sd"> Gets or creates a Guest account object.</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> ip (str, optional): IP address of requestor; used for ban checking,</span>
<span class="sd"> ip (str, optional): IP address of requester; used for ban checking,</span>
<span class="sd"> throttling and logging</span>
<span class="sd"> Returns:</span>

8
docs/1.0-dev/_modules/evennia/commands/default/building.html
View file

@ -1113,7 +1113,7 @@
<span class="n">exitname</span><span class="p">,</span> <span class="n">backshort</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">directions</span><span class="p">[</span><span class="n">exitshort</span><span class="p">]</span>
<span class="n">backname</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">directions</span><span class="p">[</span><span class="n">backshort</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="c1"># if we recieved a typeclass for the exit, add it to the alias(short name)</span>
<span class="c1"># if we received a typeclass for the exit, add it to the alias(short name)</span>
<span class="k">if</span> <span class="s2">&quot;:&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">lhs</span><span class="p">:</span>
<span class="c1"># limit to only the first : character</span>
<span class="n">exit_typeclass</span> <span class="o">=</span> <span class="s2">&quot;:&quot;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">lhs</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;:&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
@ -1707,7 +1707,7 @@
<div class="viewcode-block" id="CmdSetAttribute.split_nested_attr"><a class="viewcode-back" href="../../../../api/evennia.commands.default.building.html#evennia.commands.default.building.CmdSetAttribute.split_nested_attr">[docs]</a> <span class="k">def</span> <span class="nf">split_nested_attr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Yields tuples of (possible attr name, nested keys on that attr).</span>
<span class="sd"> For performance, this is biased to the deepest match, but allows compatability</span>
<span class="sd"> For performance, this is biased to the deepest match, but allows compatibility</span>
<span class="sd"> with older attrs that might have been named with `[]`&#39;s.</span>
<span class="sd"> &gt; list(split_nested_attr(&quot;nested[&#39;asdf&#39;][0]&quot;))</span>
@ -2874,7 +2874,7 @@
<span class="n">objdata</span><span class="p">[</span><span class="s2">&quot;Stored Cmdset(s)&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_stored_cmdsets</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
<span class="n">objdata</span><span class="p">[</span><span class="s2">&quot;Merged Cmdset(s)&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_merged_cmdsets</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">current_cmdset</span><span class="p">)</span>
<span class="n">objdata</span><span class="p">[</span>
<span class="sa">f</span><span class="s2">&quot;Commands vailable to </span><span class="si">{</span><span class="n">obj</span><span class="o">.</span><span class="n">key</span><span class="si">}</span><span class="s2"> (result of Merged Cmdset(s))&quot;</span>
<span class="sa">f</span><span class="s2">&quot;Commands available to </span><span class="si">{</span><span class="n">obj</span><span class="o">.</span><span class="n">key</span><span class="si">}</span><span class="s2"> (result of Merged Cmdset(s))&quot;</span>
<span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_current_cmds</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">current_cmdset</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">object_type</span> <span class="o">==</span> <span class="s2">&quot;script&quot;</span><span class="p">:</span>
<span class="n">objdata</span><span class="p">[</span><span class="s2">&quot;Description&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">format_script_desc</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
@ -4073,7 +4073,7 @@
<span class="p">)</span>
<span class="k">return</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># we homogenize the protoype first, to be more lenient with free-form</span>
<span class="c1"># we homogenize the prototype first, to be more lenient with free-form</span>
<span class="n">protlib</span><span class="o">.</span><span class="n">validate_prototype</span><span class="p">(</span><span class="n">protlib</span><span class="o">.</span><span class="n">homogenize_prototype</span><span class="p">(</span><span class="n">prototype</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">RuntimeError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">caller</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">err</span><span class="p">))</span>

2
docs/1.0-dev/_modules/evennia/commands/default/comms.html
View file

@ -1860,7 +1860,7 @@
<div class="viewcode-block" id="CmdGrapevine2Chan"><a class="viewcode-back" href="../../../../api/evennia.commands.default.comms.html#evennia.commands.default.comms.CmdGrapevine2Chan">[docs]</a><span class="k">class</span> <span class="nc">CmdGrapevine2Chan</span><span class="p">(</span><span class="n">COMMAND_DEFAULT_CLASS</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Link an Evennia channel to an exteral Grapevine channel</span>
<span class="sd"> Link an Evennia channel to an external Grapevine channel</span>
<span class="sd"> Usage:</span>
<span class="sd"> grapevine2chan[/switches] &lt;evennia_channel&gt; = &lt;grapevine_channel&gt;</span>

4
docs/1.0-dev/_modules/evennia/commands/default/help.html
View file

@ -109,7 +109,7 @@
<span class="sd"> help &lt;topic&gt;/&lt;subtopic&gt;/&lt;subsubtopic&gt; ...</span>
<span class="sd"> Use the &#39;help&#39; command alone to see an index of all help topics, organized</span>
<span class="sd"> by category.eSome big topics may offer additional sub-topics.</span>
<span class="sd"> by category. Some big topics may offer additional sub-topics.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -180,7 +180,7 @@
<span class="n">click_topics</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">):</span>
<span class="sd">&quot;&quot;&quot;This visually formats the help entry.</span>
<span class="sd"> This method can be overriden to customize the way a help</span>
<span class="sd"> This method can be overridden to customize the way a help</span>
<span class="sd"> entry is displayed.</span>
<span class="sd"> Args:</span>

3
docs/1.0-dev/_modules/evennia/contrib/rpg/rpsystem/rpsystem.html
View file

@ -392,7 +392,8 @@
<span class="n">candidate_map</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">.</span><span class="n">sdesc</span><span class="o">.</span><span class="n">get</span><span class="p">()))</span>
<span class="c1"># if no sdesc, include key plus aliases instead</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">candidate_map</span><span class="o">.</span><span class="n">extend</span><span class="p">([(</span><span class="n">obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">.</span><span class="n">key</span><span class="p">)]</span> <span class="o">+</span> <span class="p">[(</span><span class="n">obj</span><span class="p">,</span> <span class="n">alias</span><span class="p">)</span> <span class="k">for</span> <span class="n">alias</span> <span class="ow">in</span> <span class="n">obj</span><span class="o">.</span><span class="n">aliases</span><span class="o">.</span><span class="n">all</span><span class="p">()])</span>
<span class="n">candidate_map</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">obj</span><span class="p">,</span> <span class="n">obj</span><span class="o">.</span><span class="n">key</span><span class="p">))</span>
<span class="n">candidate_map</span><span class="o">.</span><span class="n">extend</span><span class="p">([(</span><span class="n">obj</span><span class="p">,</span> <span class="n">alias</span><span class="p">)</span> <span class="k">for</span> <span class="n">alias</span> <span class="ow">in</span> <span class="n">obj</span><span class="o">.</span><span class="n">aliases</span><span class="o">.</span><span class="n">all</span><span class="p">()])</span>
<span class="c1"># escape mapping syntax on the form {#id} if it exists already in emote,</span>
<span class="c1"># if so it is replaced with just &quot;id&quot;.</span>

2
docs/1.0-dev/_modules/evennia/server/portal/telnet.html
View file

@ -268,6 +268,7 @@
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">naws</span><span class="o">.</span><span class="n">NAWS</span>
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">MCCP</span>
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">mssp</span><span class="o">.</span><span class="n">MSSP</span>
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">ECHO</span>
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">suppress_ga</span><span class="o">.</span><span class="n">SUPPRESS_GA</span>
<span class="p">)</span></div>
@ -278,6 +279,7 @@
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">naws</span><span class="o">.</span><span class="n">NAWS</span>
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">MCCP</span>
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">mssp</span><span class="o">.</span><span class="n">MSSP</span>
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">ECHO</span>
<span class="ow">or</span> <span class="n">option</span> <span class="o">==</span> <span class="n">suppress_ga</span><span class="o">.</span><span class="n">SUPPRESS_GA</span>
<span class="p">)</span></div>

2
docs/1.0-dev/_modules/evennia/server/sessionhandler.html
View file

@ -725,7 +725,7 @@
<span class="sd"> Get a unique list of connected and logged-in Accounts.</span>
<span class="sd"> Returns:</span>
<span class="sd"> accounts (list): All conected Accounts (which may be fewer than the</span>
<span class="sd"> accounts (list): All connected Accounts (which may be fewer than the</span>
<span class="sd"> amount of Sessions due to multi-playing).</span>
<span class="sd"> &quot;&quot;&quot;</span>

4
docs/1.0-dev/_modules/evennia/utils/evmore.html
View file

@ -223,7 +223,7 @@
<span class="sd"> justify (bool, optional): If set, auto-justify long lines. This must be turned</span>
<span class="sd"> off for fixed-width or formatted output, like tables. It&#39;s force-disabled</span>
<span class="sd"> if `inp` is an EvTable.</span>
<span class="sd"> justify_kwargs (dict, optional): Keywords for the justifiy function. Used only</span>
<span class="sd"> justify_kwargs (dict, optional): Keywords for the justify function. Used only</span>
<span class="sd"> if `justify` is True. If this is not set, default arguments will be used.</span>
<span class="sd"> exit_on_lastpage (bool, optional): If reaching the last page without the</span>
<span class="sd"> page being completely filled, exit pager immediately. If unset,</span>
@ -549,7 +549,7 @@
<div class="viewcode-block" id="EvMore.page_formatter"><a class="viewcode-back" href="../../../api/evennia.utils.evmore.html#evennia.utils.evmore.EvMore.page_formatter">[docs]</a> <span class="k">def</span> <span class="nf">page_formatter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">page</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Page formatter. Every page passes through this method. Override</span>
<span class="sd"> it to customize behvaior per-page. A common use is to generate a new</span>
<span class="sd"> it to customize behavior per-page. A common use is to generate a new</span>
<span class="sd"> EvTable for every page (this is more efficient than to generate one huge</span>
<span class="sd"> EvTable across many pages and feed it into EvMore all at once).</span>

12
docs/1.0-dev/_modules/evennia/utils/utils.html
View file

@ -861,7 +861,7 @@
<span class="sd"> This is used as a last resort when normal encoding does not work.</span>
<span class="sd"> Arguments:</span>
<span class="sd"> string (str): A string to convert to &#39;safe characters&#39; convertable</span>
<span class="sd"> string (str): A string to convert to &#39;safe characters&#39; convertible</span>
<span class="sd"> to an latin-1 bytestring later.</span>
<span class="sd"> default (str, optional): Characters resisting mapping will be replaced</span>
<span class="sd"> with this character or string. The intent is to apply an encode operation</span>
@ -1120,7 +1120,7 @@
<span class="sd"> Keep in mind that persistent tasks arguments and callback should not</span>
<span class="sd"> use memory references.</span>
<span class="sd"> If persistent is set to True the delay function will return an int</span>
<span class="sd"> which is the task&#39;s id itended for use with TASK_HANDLER&#39;s do_task</span>
<span class="sd"> which is the task&#39;s id intended for use with TASK_HANDLER&#39;s do_task</span>
<span class="sd"> and remove methods.</span>
<span class="sd"> All persistent tasks whose time delays have passed will be called on server startup.</span>
@ -1573,12 +1573,12 @@
<span class="sd"> defaultpaths (iterable, optional): If a direct import from `path` fails,</span>
<span class="sd"> try subsequent imports by prepending those paths to `path`.</span>
<span class="sd"> fallback (str): If all other attempts fail, use this path as a fallback.</span>
<span class="sd"> This is intended as a last-resport. In the example of Evennia</span>
<span class="sd"> This is intended as a last-resort. In the example of Evennia</span>
<span class="sd"> loading, this would be a path to a default parent class in the</span>
<span class="sd"> evennia repo itself.</span>
<span class="sd"> Returns:</span>
<span class="sd"> class (Class): An uninstatiated class recovered from path.</span>
<span class="sd"> class (Class): An uninstantiated class recovered from path.</span>
<span class="sd"> Raises:</span>
<span class="sd"> ImportError: If all loading failed.</span>
@ -1717,7 +1717,7 @@
<span class="sd"> Matching is made from the start of each subword in each</span>
<span class="sd"> alternative. Case is not important. So e.g. &quot;bi sh sw&quot; or just</span>
<span class="sd"> &quot;big&quot; or &quot;shiny&quot; or &quot;sw&quot; will match &quot;Big shiny sword&quot;. Scoring is</span>
<span class="sd"> done to allow to separate by most common demoninator. You will get</span>
<span class="sd"> done to allow to separate by most common denominator. You will get</span>
<span class="sd"> multiple matches returned if appropriate.</span>
<span class="sd"> Args:</span>
@ -1791,7 +1791,7 @@
<span class="sd"> ftable = format_table([[1,2,3], [4,5,6]])</span>
<span class="sd"> string = &quot;&quot;</span>
<span class="sd"> for ir, row in enumarate(ftable):</span>
<span class="sd"> for ir, row in enumerate(ftable):</span>
<span class="sd"> if ir == 0:</span>
<span class="sd"> # make first row white</span>
<span class="sd"> string += &quot;\\n|w&quot; + &quot;&quot;.join(row) + &quot;|n&quot;</span>