mirror of
https://github.com/evennia/evennia.git
synced 2026-03-20 23:06:31 +01:00
527 lines
No EOL
39 KiB
HTML
527 lines
No EOL
39 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>evennia.contrib.grid.xyzgrid.commands — Evennia 2.x documentation</title>
|
||
<link rel="stylesheet" href="../_static/nature.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="shortcut icon" href="../_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="evennia.contrib.grid.xyzgrid.example" href="evennia.contrib.grid.xyzgrid.example.html" />
|
||
<link rel="prev" title="evennia.contrib.grid.xyzgrid" href="evennia.contrib.grid.xyzgrid.html" />
|
||
</head><body>
|
||
|
||
|
||
|
||
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<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="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.contrib.grid.xyzgrid.example.html" title="evennia.contrib.grid.xyzgrid.example"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.contrib.grid.xyzgrid.html" title="evennia.contrib.grid.xyzgrid"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||
<li class="nav-item nav-item-5"><a href="evennia.contrib.grid.html" >evennia.contrib.grid</a> »</li>
|
||
<li class="nav-item nav-item-6"><a href="evennia.contrib.grid.xyzgrid.html" accesskey="U">evennia.contrib.grid.xyzgrid</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.xyzgrid.commands</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
|
||
<div class="documentwrapper">
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||
</a></p>
|
||
<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>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="evennia.contrib.grid.xyzgrid.html"
|
||
title="previous chapter">evennia.contrib.grid.xyzgrid</a></p>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="evennia.contrib.grid.xyzgrid.example.html"
|
||
title="next chapter">evennia.contrib.grid.xyzgrid.example</a></p>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.contrib.grid.xyzgrid.commands.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div><h3>Links</h3>
|
||
<ul>
|
||
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
||
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
||
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
|
||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||
<li>
|
||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||
</li>
|
||
</ul>
|
||
<h3>Doc Versions</h3>
|
||
<ul>
|
||
|
||
<li><a href="evennia.contrib.grid.xyzgrid.commands.html">2.x (main branch)</a></li>
|
||
<ul>
|
||
<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
|
||
|
||
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||
|
||
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.contrib.grid.xyzgrid.commands">
|
||
<span id="evennia-contrib-grid-xyzgrid-commands"></span><h1>evennia.contrib.grid.xyzgrid.commands<a class="headerlink" href="#module-evennia.contrib.grid.xyzgrid.commands" title="Permalink to this headline">¶</a></h1>
|
||
<p>XYZ-aware commands</p>
|
||
<p>Just add the XYZGridCmdSet to the default character cmdset to override
|
||
the commands with XYZ-aware equivalents.</p>
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.PathData">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><code class="sig-name descname">PathData</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="n">xymap</span></em>, <em class="sig-param"><span class="n">directions</span></em>, <em class="sig-param"><span class="n">step_sequence</span></em>, <em class="sig-param"><span class="n">task</span></em><span class="sig-paren">)</span><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.PathData" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.PathData.directions">
|
||
<code class="sig-name descname">directions</code><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.PathData.directions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Alias for field number 2</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.PathData.step_sequence">
|
||
<code class="sig-name descname">step_sequence</code><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.PathData.step_sequence" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Alias for field number 3</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.PathData.target">
|
||
<code class="sig-name descname">target</code><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.PathData.target" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Alias for field number 0</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.PathData.task">
|
||
<code class="sig-name descname">task</code><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.PathData.task" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Alias for field number 4</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.PathData.xymap">
|
||
<code class="sig-name descname">xymap</code><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.PathData.xymap" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Alias for field number 1</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><code class="sig-name descname">CmdXYZTeleport</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdXYZTeleport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.building.html#evennia.commands.default.building.CmdTeleport" title="evennia.commands.default.building.CmdTeleport"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.building.CmdTeleport</span></code></a></p>
|
||
<p>teleport object to another location</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>tel/switch [<object> to||=] <target location>
|
||
tel/switch [<object> to||=] (X,Y[,Z])</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Examples</p>
|
||
<p>tel Limbo
|
||
tel/quiet box = Limbo
|
||
tel/tonone box
|
||
tel (3, 3, the small cave)
|
||
tel (4, 1) # on the same map
|
||
tel/map Z|mapname</p>
|
||
<dl>
|
||
<dt>Switches:</dt><dd><dl class="simple">
|
||
<dt>quiet - don’t echo leave/arrive messages to the source/target</dt><dd><p>locations for the move.</p>
|
||
</dd>
|
||
<dt>intoexit - if target is an exit, teleport INTO</dt><dd><p>the exit object instead of to its destination</p>
|
||
</dd>
|
||
<dt>tonone - if set, teleport the object to a None-location. If this</dt><dd><p>switch is set, <target location> is ignored.
|
||
Note that the only way to retrieve
|
||
an object from a None location is by direct #dbref
|
||
reference. A puppeted object cannot be moved to None.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>loc - teleport object to the target’s location instead of its contents
|
||
map - show coordinate map of given Zcoord/mapname.</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Teleports an object somewhere. If no object is given, you yourself are
|
||
teleported to the target location. If (X,Y) or (X,Y,Z) coordinates
|
||
are given, the target is a location on the XYZGrid.</p>
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.parse">
|
||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdXYZTeleport.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.parse" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Breaking out searching here to make this easier to override.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['@tel']</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = '@teleport'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(teleport) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '@tel', 'category': 'building', 'key': '@teleport', 'no_prefix': 'teleport tel', 'tags': '', 'text': "\n teleport object to another location\n\n Usage:\n tel/switch [<object> to||=] <target location>\n tel/switch [<object> to||=] (X,Y[,Z])\n\n Examples:\n tel Limbo\n tel/quiet box = Limbo\n tel/tonone box\n tel (3, 3, the small cave)\n tel (4, 1) # on the same map\n tel/map Z|mapname\n\n Switches:\n quiet - don't echo leave/arrive messages to the source/target\n locations for the move.\n intoexit - if target is an exit, teleport INTO\n the exit object instead of to its destination\n tonone - if set, teleport the object to a None-location. If this\n switch is set, <target location> is ignored.\n Note that the only way to retrieve\n an object from a None location is by direct #dbref\n reference. A puppeted object cannot be moved to None.\n loc - teleport object to the target's location instead of its contents\n map - show coordinate map of given Zcoord/mapname.\n\n Teleports an object somewhere. If no object is given, you yourself are\n teleported to the target location. If (X,Y) or (X,Y,Z) coordinates\n are given, the target is a location on the XYZGrid.\n\n "}</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><code class="sig-name descname">CmdXYZOpen</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdXYZOpen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.building.html#evennia.commands.default.building.CmdOpen" title="evennia.commands.default.building.CmdOpen"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.building.CmdOpen</span></code></a></p>
|
||
<p>open a new exit from the current room</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>open <new exit>[;alias;..][:typeclass] [,<return exit>[;alias;..][:typeclass]]] = <destination>
|
||
open <new exit>[;alias;..][:typeclass] [,<return exit>[;alias;..][:typeclass]]] = (X,Y,Z)</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Handles the creation of exits. If a destination is given, the exit
|
||
will point there. The destination can also be given as an (X,Y,Z) coordinate on the
|
||
XYZGrid - this command is used to link non-grid rooms to the grid and vice-versa.</p>
|
||
<p>The <return exit> argument sets up an exit at the destination leading back to the current room.
|
||
Apart from (X,Y,Z) coordinate, destination name can be given both as a #dbref and a name, if
|
||
that name is globally unique.</p>
|
||
<p class="rubric">Examples</p>
|
||
<p>open kitchen = Kitchen
|
||
open north, south = Town Center
|
||
open cave mouth;cave = (3, 4, the small cave)</p>
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.parse">
|
||
<code class="sig-name descname">parse</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdXYZOpen.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.parse" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>We need to expand the default parsing to get all
|
||
the cases, see the module doc.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'building'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = '@open'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(open) or perm(Builder)'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'building', 'key': '@open', 'no_prefix': 'open ', 'tags': '', 'text': '\n open a new exit from the current room\n\n Usage:\n open <new exit>[;alias;..][:typeclass] [,<return exit>[;alias;..][:typeclass]]] = <destination>\n open <new exit>[;alias;..][:typeclass] [,<return exit>[;alias;..][:typeclass]]] = (X,Y,Z)\n\n Handles the creation of exits. If a destination is given, the exit\n will point there. The destination can also be given as an (X,Y,Z) coordinate on the\n XYZGrid - this command is used to link non-grid rooms to the grid and vice-versa.\n\n The <return exit> argument sets up an exit at the destination leading back to the current room.\n Apart from (X,Y,Z) coordinate, destination name can be given both as a #dbref and a name, if\n that name is globally unique.\n\n Examples:\n open kitchen = Kitchen\n open north, south = Town Center\n open cave mouth;cave = (3, 4, the small cave)\n\n '}</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><code class="sig-name descname">CmdGoto</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdGoto"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>Go to a named location in this area via the shortest path.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>path <location> - find shortest path to target location (don’t move)
|
||
goto <location> - auto-move to target location, using shortest path
|
||
path - show current target location and shortest path
|
||
goto - abort current goto, otherwise show current path
|
||
path clear - clear current path</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Finds the shortest route to a location in your current area and
|
||
can then automatically walk you there.</p>
|
||
<p>Builders can optionally specify a specific grid coordinate (X,Y) to go to.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'goto'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['path']</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto.auto_step_delay">
|
||
<code class="sig-name descname">auto_step_delay</code><em class="property"> = 2</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.auto_step_delay" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto.default_xyz_path_interrupt_msg">
|
||
<code class="sig-name descname">default_xyz_path_interrupt_msg</code><em class="property"> = 'Pathfinding interrupted here.'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.default_xyz_path_interrupt_msg" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdGoto.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implement command</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all()'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdGoto.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'path', 'category': 'general', 'key': 'goto', 'no_prefix': ' path', 'tags': '', 'text': "\n Go to a named location in this area via the shortest path.\n\n Usage:\n path <location> - find shortest path to target location (don't move)\n goto <location> - auto-move to target location, using shortest path\n path - show current target location and shortest path\n goto - abort current goto, otherwise show current path\n path clear - clear current path\n\n Finds the shortest route to a location in your current area and\n can then automatically walk you there.\n\n Builders can optionally specify a specific grid coordinate (X,Y) to go to.\n\n "}</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdMap">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><code class="sig-name descname">CmdMap</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdMap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdMap" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>Show a map of an area</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>map [Zcoord]
|
||
map list</p>
|
||
</dd>
|
||
</dl>
|
||
<p>This is a builder-command.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdMap.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'map'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdMap.locks">
|
||
<code class="sig-name descname">locks</code><em class="property"> = 'cmd:perm(Builders)'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdMap.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdMap.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Implement command</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdMap.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = []</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdMap.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdMap.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:perm(Builders)'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdMap.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': '', 'category': 'general', 'key': 'map', 'no_prefix': ' ', 'tags': '', 'text': '\n Show a map of an area\n\n Usage:\n map [Zcoord]\n map list\n\n This is a builder-command.\n\n '}</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><code class="sig-name descname">XYZGridCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#XYZGridCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||
<p>Cmdset for easily adding the above cmds to the character cmdset.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'xyzgrid_cmdset'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet.at_cmdset_creation">
|
||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#XYZGridCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hook method - this should be overloaded in the inheriting
|
||
class, and should take care of populating the cmdset by use of
|
||
self.add().</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><code class="sig-name descname">CmdFlyAndDive</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdFlyAndDive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand" title="evennia.commands.default.muxcommand.MuxCommand"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.default.muxcommand.MuxCommand</span></code></a></p>
|
||
<p>Fly or Dive up and down.</p>
|
||
<dl class="simple">
|
||
<dt>Usage:</dt><dd><p>fly
|
||
dive</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Will fly up one room or dive down one room at your current position. If
|
||
there is no room above/below you, your movement will fail.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'fly or dive'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.aliases">
|
||
<code class="sig-name descname">aliases</code><em class="property"> = ['dive', 'fly']</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.func">
|
||
<code class="sig-name descname">func</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdFlyAndDive.func"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.func" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This is the hook function that actually does all the work. It is called
|
||
by the cmdhandler right after self.parser() finishes, and so has access
|
||
to all the variables defined therein.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.help_category">
|
||
<code class="sig-name descname">help_category</code><em class="property"> = 'general'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.help_category" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.lock_storage">
|
||
<code class="sig-name descname">lock_storage</code><em class="property"> = 'cmd:all();'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.lock_storage" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.search_index_entry">
|
||
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'dive fly', 'category': 'general', 'key': 'fly or dive', 'no_prefix': ' dive fly', 'tags': '', 'text': '\n Fly or Dive up and down.\n\n Usage:\n fly\n dive\n\n Will fly up one room or dive down one room at your current position. If\n there is no room above/below you, your movement will fail.\n\n '}</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.search_index_entry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><code class="sig-name descname">XYZGridFlyDiveCmdSet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cmdsetobj</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">key</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#XYZGridFlyDiveCmdSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.commands.cmdset.html#evennia.commands.cmdset.CmdSet" title="evennia.commands.cmdset.CmdSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.commands.cmdset.CmdSet</span></code></a></p>
|
||
<p>Optional cmdset if you want the fly/dive commands to move in a 3D environment.</p>
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet.key">
|
||
<code class="sig-name descname">key</code><em class="property"> = 'xyzgrid_flydive_cmdset'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet.at_cmdset_creation">
|
||
<code class="sig-name descname">at_cmdset_creation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#XYZGridFlyDiveCmdSet.at_cmdset_creation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet.at_cmdset_creation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hook method - this should be overloaded in the inheriting
|
||
class, and should take care of populating the cmdset by use of
|
||
self.add().</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt id="evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet.path">
|
||
<code class="sig-name descname">path</code><em class="property"> = 'evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet'</em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<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="../py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.contrib.grid.xyzgrid.example.html" title="evennia.contrib.grid.xyzgrid.example"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.contrib.grid.xyzgrid.html" title="evennia.contrib.grid.xyzgrid"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.contrib.html" >evennia.contrib</a> »</li>
|
||
<li class="nav-item nav-item-5"><a href="evennia.contrib.grid.html" >evennia.contrib.grid</a> »</li>
|
||
<li class="nav-item nav-item-6"><a href="evennia.contrib.grid.xyzgrid.html" >evennia.contrib.grid.xyzgrid</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.contrib.grid.xyzgrid.commands</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2023, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |