From 4b29b4e3fe3c8590d098d91684af070a0216dc40 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 6 Sep 2015 12:22:16 +0200 Subject: [PATCH] Updated the game template with some more verbose docstring. --- evennia/game_template/commands/command.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/evennia/game_template/commands/command.py b/evennia/game_template/commands/command.py index eabf8941fe..9d850d3823 100644 --- a/evennia/game_template/commands/command.py +++ b/evennia/game_template/commands/command.py @@ -19,6 +19,15 @@ class Command(BaseCommand): used by Evennia to create the automatic help entry for the command, so make sure to document consistently here. + Each Command implements the following methods, called + in this order: + - at_pre_command(): If this returns True, execution is aborted. + - parse(): Should perform any extra parsing needed on self.args + and store the result on self. + - func(): Performs the actual work. + - at_post_command(): Extra actions, often things done after + every command, like prompts. + """ # these need to be specified