summaryrefslogtreecommitdiffstats
path: root/doc/interface.rst
diff options
context:
space:
mode:
authorThomas Kluyver <takowl@gmail.com>2013-01-05 17:12:31 +0000
committerThomas Kluyver <takowl@gmail.com>2013-01-05 17:12:31 +0000
commit3e50c8f35ab3a40231498109d7401e0097fb1dd1 (patch)
tree8dce567ffe746ab7a46d482a0ef63c994d3d9502 /doc/interface.rst
parent76d1149e6725ca8a59799e0c1f2112d3cbab5afb (diff)
Add first tile in each cardinal direction.
Diffstat (limited to 'doc/interface.rst')
-rw-r--r--doc/interface.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/interface.rst b/doc/interface.rst
index e7505a4..796fa4b 100644
--- a/doc/interface.rst
+++ b/doc/interface.rst
@@ -36,7 +36,7 @@ Your module should define a class called ``Tile``, with the following interface:
.. method:: action(player, do)
Called when the player does something inside the tile. You need to
- interpret the action and carry it out.
+ interpret the action and carry it out. Tile ``e1`` has a simple example.
:param player: the active :class:`~weatbag.Player` instance
:param action: list of strings - the player's input, split up into words,
@@ -46,7 +46,8 @@ Your module should define a class called ``Tile``, with the following interface:
*Optional.* Called when the player tries to leave the square. To let them
leave, return `True`, or to prevent them, print an explanation and return
- `False`. If the method isn't found, the player can always leave.
+ `False`. If the method isn't found, the player can always leave. Tile
+ ``w1`` has a simple example.
:param player: the active :class:`~weatbag.Player` instance
:param direction: the direction the player is trying to leave, as a single