summaryrefslogtreecommitdiffstats
path: root/doc/api_misc.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api_misc.rst')
-rw-r--r--doc/api_misc.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/api_misc.rst b/doc/api_misc.rst
new file mode 100644
index 0000000..4830e1c
--- /dev/null
+++ b/doc/api_misc.rst
@@ -0,0 +1,27 @@
+Other API components
+====================
+
+The player
+----------
+
+.. autoclass:: weatbag.Player
+ :members: has, give, take
+
+ .. attribute:: name
+
+ The name given by the player when they started the game.
+
+ .. attribute:: position
+
+ The player's position in the world as (n, e) co-ordinates.
+
+ .. attribute:: inventory
+
+ A :class:`collections.Counter` storing the item's in the player's bag.
+
+Understanding commands
+----------------------
+
+.. automodule:: weatbag.words
+
+