summaryrefslogtreecommitdiffstats
path: root/doc/api_misc.rst
blob: 674ab08d798a7988acca62514024fb2b69c7365d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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

Utility functions
-----------------

.. autofunction:: weatbag.utils.transfer