Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make CmdHelp's choice of Commands to offer help on easier to override.

Browse source
This commit is contained in:
Griatch 2017-01-12 22:18:22 +01:00
parent 50e523e4f9
commit 1b92c036a1
1 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

19
evennia/commands/default/help.py
View file

@ -88,6 +88,23 @@ class CmdHelp(Command):
self.original_args = self.args.strip()
self.args = self.args.strip().lower()
def check_show_help(self, cmd, caller):
"""
Helper method. If this return True, the given cmd
auto-help will be viewable in the help listing.
Override this to easily select what is shown to
the player. Note that only commands available
in the caller's merged cmdset are available.
Args:
cmd (Command): Command class from the merged cmdset
caller (Character, Player or Session): The current caller
executing the help command.
"""
# return only those with auto_help set and passing the cmd: lock
return cmd.auto_help and cmd.access(caller)
def func(self):
"""
Run the dynamic help entry creator.
@ -106,7 +123,7 @@ class CmdHelp(Command):
cmdset.make_unique(caller)
# retrieve all available commands and database topics
all_cmds = [cmd for cmd in cmdset if cmd.auto_help and cmd.access(caller)]
all_cmds = [cmd for cmd in cmdset if self.check_show_help(cmd, caller)]
all_topics = [topic for topic in HelpEntry.objects.all() if topic.access(caller, 'view', default=True)]
all_categories = list(set([cmd.help_category.lower() for cmd in all_cmds] + [topic.help_category.lower() for topic in all_topics]))