<spanid="evennia-commands-default-help"></span><h1>evennia.commands.default.help<aclass="headerlink"href="#module-evennia.commands.default.help"title="Permalink to this headline">¶</a></h1>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.help.</code><codeclass="sig-name descname">CmdHelp</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'help'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['?']</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">return_cmdset</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.return_cmdset"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_more</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.help_more"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">index_type_separator_clr</code><emclass="property"> = '|w'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.index_type_separator_clr"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">index_category_clr</code><emclass="property"> = '|W'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.index_category_clr"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">index_topic_clr</code><emclass="property"> = '|G'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.index_topic_clr"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">suggestion_cutoff</code><emclass="property"> = 0.6</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.suggestion_cutoff"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">suggestion_maxnum</code><emclass="property"> = 5</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.suggestion_maxnum"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">subtopic_separator_char</code><emclass="property"> = '/'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.subtopic_separator_char"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">msg_help</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">text</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.msg_help"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.msg_help"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_help_entry</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">topic</span><spanclass="o">=</span><spanclass="default_value">''</span></em>, <emclass="sig-param"><spanclass="n">help_text</span><spanclass="o">=</span><spanclass="default_value">''</span></em>, <emclass="sig-param"><spanclass="n">aliases</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">suggested</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">subtopics</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.format_help_entry"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.format_help_entry"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_help_index</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmd_help_dict</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">db_help_dict</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">title_lone_category</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.format_help_index"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.format_help_index"title="Permalink to this definition">¶</a></dt>
<dd><p>Output a category-ordered g for displaying the main help, grouped by
category.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cmd_help_dict</strong> (<em>dict</em>) – A dict <strong>{“category”: [topic, topic, …]}</strong> for
command-based help.</p></li>
<li><p><strong>db_help_dict</strong> (<em>dict</em>) – A dict <strong>{“category”: [topic, topic], …]}</strong> for
database-based help.</p></li>
<li><p><strong>title_lone_category</strong> (<em>bool</em><em>, </em><em>optional</em>) – If a lone category should
be titled with the category name or not. While pointless in a
general index, the title should probably show when explicitly
listing the category itself.</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>str</em>– The help index organized into a grid.</p>
<codeclass="sig-name descname">check_show_help</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmd</span></em>, <emclass="sig-param"><spanclass="n">caller</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.check_show_help"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.check_show_help"title="Permalink to this definition">¶</a></dt>
<dd><p>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 account. Note that only commands available
in the caller’s merged cmdset are available.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cmd</strong> (<aclass="reference internal"href="evennia.commands.command.html#evennia.commands.command.Command"title="evennia.commands.command.Command"><em>Command</em></a>) – Command class from the merged cmdset</p></li>
<li><p><strong>caller</strong> (<em>Character</em><em>, </em><em>Account</em><em> or </em><aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a>) – The current caller
<codeclass="sig-name descname">should_list_cmd</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">cmd</span></em>, <emclass="sig-param"><spanclass="n">caller</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.should_list_cmd"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.should_list_cmd"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">parse</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.parse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.parse"title="Permalink to this definition">¶</a></dt>
<dd><p>input is a string containing the command or topic to match.</p>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdHelp.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '?', 'category': 'general', 'key': 'help', 'tags': '', 'text': "\n Get help.\n\n Usage:\n help\n help <topic, command or category>\n help <topic>/<subtopic>\n help <topic>/<subtopic>/<subsubtopic> ...\n\n Use the 'help' command alone to see an index of all help topics, organized\n by category.eSome big topics may offer additional sub-topics.\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.help.CmdHelp.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.help.</code><codeclass="sig-name descname">CmdSetHelp</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdSetHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'sethelp'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:perm(Helper)'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'building'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/help.html#CmdSetHelp.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = []</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:perm(Helper)'</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': '', 'category': 'building', 'key': 'sethelp', 'tags': '', 'text': "\n Edit the help database.\n\n Usage:\n help[/switches] <topic>[[;alias;alias][,category[,locks]] [= <text>]\n\n Switches:\n edit - open a line editor to edit the topic's help text.\n replace - overwrite existing help topic.\n append - add text to the end of existing topic with a newline between.\n extend - as append, but don't add a newline.\n delete - remove help topic.\n\n Examples:\n sethelp lore = In the beginning was ...\n sethelp/append pickpocketing,Thievery = This steals ...\n sethelp/replace pickpocketing, ,attr(is_thief) = This steals ...\n sethelp/edit thievery\n\n If not assigning a category, the `settings.DEFAULT_HELP_CATEGORY` category\n will be used. If no lockstring is specified, everyone will be able to read\n the help entry. Sub-topics are embedded in the help text.\n\n Note that this cannot modify command-help entries - these are modified\n in-code, outside the game.\n\n # SUBTOPICS\n\n ## Adding subtopics\n\n Subtopics helps to break up a long help entry into sub-sections. Users can\n access subtopics with |whelp topic/subtopic/...|n Subtopics are created and\n stored together with the main topic.\n\n To start adding subtopics, add the text '# SUBTOPICS' on a new line at the\n end of your help text. After this you can now add any number of subtopics,\n each starting with '## <subtopic-name>' on a line, followed by the\n help-text of that subtopic.\n Use '### <subsub-name>' to add a sub-subtopic and so on. Max depth is 5. A\n subtopic's title is case-insensitive and can consist of multiple words -\n the user will be able to enter a partial match to access it.\n\n For example:\n\n | Main help text for <topic>\n |\n | # SUBTOPICS\n |\n | ## about\n |\n | Text for the '<topic>/about' subtopic'\n |\n | ### more about-info\n |\n | Text for the '<topic>/about/more about-info sub-subtopic\n |\n | ## extra\n |\n | Text for the '<topic>/extra' subtopic\n\n "}</em><aclass="headerlink"href="#evennia.commands.default.help.CmdSetHelp.search_index_entry"title="Permalink to this definition">¶</a></dt>
