# evennia.contrib.grid.xyzgrid.example

Example xymaps to use with the XYZgrid contrib. Build outside of the game using the evennia xyzgrid launcher command.

First add the launcher extension in your mygame/server/conf/settings.py:

> EXTRA_LAUNCHER_COMMANDS[‘xyzgrid’] = ‘evennia.contrib.grid.xyzgrid.launchcmd.xyzcommand’

Then

> evennia xyzgrid init evennia xyzgrid add evennia.contrib.grid.xyzgrid.map_example evennia xyzgrid build

class `evennia.contrib.grid.xyzgrid.example.``TransitionToCave`(x, y, Z, node_index=0, symbol=None, xymap=None)

  Bases: `evennia.contrib.grid.xyzgrid.xymap_legend.TransitionMapNode`

  A transition from ‘the large tree’ to ‘the small cave’ map. This node is never spawned into a room but only acts as a target for finding the exit’s destination.

  `symbol` = 'T'
  `target_map_xyz` = (1, 0, 'the small cave')

class `evennia.contrib.grid.xyzgrid.example.``TransitionToLargeTree`(x, y, Z, node_index=0, symbol=None, xymap=None)

  Bases: `evennia.contrib.grid.xyzgrid.xymap_legend.TransitionMapNode`

  A transition from ‘the small cave’ to ‘the large tree’ map. This node is never spawned into a room by only acts as a target for finding the exit’s destination.

  `symbol` = 'T'
  `target_map_xyz` = (3, 0, 'the large tree')