summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDico200 <dico.karssiens@gmail.com>2015-10-20 18:10:56 +0200
committerDico200 <dico.karssiens@gmail.com>2015-10-20 18:10:56 +0200
commitb4f5a68e4e3ba4993e8326d2f11f9582933b694e (patch)
tree7c2ac1f81893b660121ef707d730f83c39e6d4b4
parentce4fa316d9dbc61868650fc927e0eb23827c5938 (diff)
small addition to basecommands documentation
-rw-r--r--basecommands.py1
1 files changed, 1 insertions, 0 deletions
diff --git a/basecommands.py b/basecommands.py
index dee79f8..7bfb8c2 100644
--- a/basecommands.py
+++ b/basecommands.py
@@ -43,6 +43,7 @@ The arguments are as follows:
Comments on the function added to the decorator:
It should return a message to send to the player. Color codes are translated automatically. It can return None or an empty string to send nothing.
+Returning "HELP" makes it show the help message.
Inside the function, calls to static methods in the class Validate can be used to make the code shorter and easier to write (maybe not easier to read).
For example, to make sure that a condition is met, use Validate.isTrue(condition, message to send to the player if the condition is not met)