summaryrefslogtreecommitdiffstats
path: root/doc/interface.rst
diff options
context:
space:
mode:
authorThomas Kluyver <takowl@gmail.com>2013-01-10 16:45:18 +0000
committerThomas Kluyver <takowl@gmail.com>2013-01-10 16:45:18 +0000
commitead0301daaa6f07d9fc740050019bf204543f0ea (patch)
tree0206475cd0c8fa0ce88572d82e776db21630be57 /doc/interface.rst
parent1da208f02a091c1dc9a9912d7066805a445d09bd (diff)
Allow custom message when player attempts to move to nonexistent tile.
Closes gh-7
Diffstat (limited to 'doc/interface.rst')
-rw-r--r--doc/interface.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/interface.rst b/doc/interface.rst
index 796fa4b..dd960b4 100644
--- a/doc/interface.rst
+++ b/doc/interface.rst
@@ -52,3 +52,9 @@ Your module should define a class called ``Tile``, with the following interface:
:param player: the active :class:`~weatbag.Player` instance
:param direction: the direction the player is trying to leave, as a single
lowercase character, n/e/s/w
+
+ .. attribute:: no_path_msg
+
+ *Optional.* The message to display if the player attempts to leave in a
+ direction where there is no tile. The default message says "The undergrowth
+ in that direction is impassable. You turn back."