<spanid="evennia-contrib-grid-xyzgrid-commands"></span><h1>evennia.contrib.grid.xyzgrid.commands<aclass="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
<codeclass="sig-name descname">directions</code><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.PathData.directions"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">step_sequence</code><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.PathData.step_sequence"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">target</code><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.PathData.target"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">task</code><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.PathData.task"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">xymap</code><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.PathData.xymap"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><codeclass="sig-name descname">CmdXYZTeleport</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdXYZTeleport"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdXYZTeleport.parse"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['@tel']</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '@teleport'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(teleport) or perm(Builder)'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="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><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZTeleport.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><codeclass="sig-name descname">CmdXYZOpen</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdXYZOpen"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdXYZOpen.parse"><spanclass="viewcode-link">[source]</span></a><aclass="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
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '@open'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(open) or perm(Builder)'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="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><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdXYZOpen.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><codeclass="sig-name descname">CmdGoto</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdGoto"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'goto'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['path']</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">auto_step_delay</code><emclass="property"> = 2</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.auto_step_delay"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">default_xyz_path_interrupt_msg</code><emclass="property"> = 'Pathfinding interrupted here.'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.default_xyz_path_interrupt_msg"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdGoto.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="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><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdGoto.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><codeclass="sig-name descname">CmdMap</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdMap"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdMap"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'map'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(Builders)'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdMap.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(Builders)'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="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><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdMap.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><codeclass="sig-name descname">XYZGridCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmdsetobj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">key</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#XYZGridCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'xyzgrid_cmdset'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#XYZGridCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="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
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet.path"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><codeclass="sig-name descname">CmdFlyAndDive</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdFlyAndDive"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'fly or dive'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['dive', 'fly']</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#CmdFlyAndDive.func"><spanclass="viewcode-link">[source]</span></a><aclass="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
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all();'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="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><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.contrib.grid.xyzgrid.commands.</code><codeclass="sig-name descname">XYZGridFlyDiveCmdSet</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmdsetobj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">key</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#XYZGridFlyDiveCmdSet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'xyzgrid_flydive_cmdset'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_cmdset_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/contrib/grid/xyzgrid/commands.html#XYZGridFlyDiveCmdSet.at_cmdset_creation"><spanclass="viewcode-link">[source]</span></a><aclass="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
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet'</em><aclass="headerlink"href="#evennia.contrib.grid.xyzgrid.commands.XYZGridFlyDiveCmdSet.path"title="Permalink to this definition">¶</a></dt>
