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

Updated HTML docs.

Browse source
This commit is contained in:
Evennia docbuilder action 2026-01-12 16:46:03 +00:00
parent 76d95c253e
commit d35cbb8f68
29 changed files with 96 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/latest/api/evennia.commands.default.admin.html
View file

@ -265,7 +265,7 @@ to accounts respectively.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdEmit.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['remit',</span> <span class="pre">'pemit']</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['pemit',</span> <span class="pre">'remit']</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -296,7 +296,7 @@ to accounts respectively.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.admin.CmdEmit.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'remit</span> <span class="pre">pemit',</span> <span class="pre">'category':</span> <span class="pre">'admin',</span> <span class="pre">'key':</span> <span class="pre">'emit',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">remit</span> <span class="pre">pemit',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nadmin</span> <span class="pre">command</span> <span class="pre">for</span> <span class="pre">emitting</span> <span class="pre">message</span> <span class="pre">to</span> <span class="pre">multiple</span> <span class="pre">objects\n\nUsage:\n</span>&#160; <span class="pre">emit[/switches]</span> <span class="pre">[&lt;obj&gt;,</span> <span class="pre">&lt;obj&gt;,</span> <span class="pre">...</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n</span>&#160; <span class="pre">remit</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[&lt;obj&gt;,</span> <span class="pre">&lt;obj&gt;,</span> <span class="pre">...</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n</span>&#160; <span class="pre">pemit</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[&lt;obj&gt;,</span> <span class="pre">&lt;obj&gt;,</span> <span class="pre">...</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n\nSwitches:\n</span>&#160; <span class="pre">room</span>&#160;&#160;&#160;&#160; <span class="pre">-</span>&#160; <span class="pre">limit</span> <span class="pre">emits</span> <span class="pre">to</span> <span class="pre">rooms</span> <span class="pre">only</span> <span class="pre">(default)\n</span>&#160; <span class="pre">accounts</span> <span class="pre">-</span>&#160; <span class="pre">limit</span> <span class="pre">emits</span> <span class="pre">to</span> <span class="pre">accounts</span> <span class="pre">only\n</span>&#160; <span class="pre">contents</span> <span class="pre">-</span>&#160; <span class="pre">send</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">contents</span> <span class="pre">of</span> <span class="pre">matched</span> <span class="pre">objects</span> <span class="pre">too\n\nEmits</span> <span class="pre">a</span> <span class="pre">message</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">selected</span> <span class="pre">objects</span> <span class="pre">or</span> <span class="pre">to\nyour</span> <span class="pre">immediate</span> <span class="pre">surroundings.</span> <span class="pre">If</span> <span class="pre">the</span> <span class="pre">object</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">room,\nsend</span> <span class="pre">to</span> <span class="pre">its</span> <span class="pre">contents.</span> <span class="pre">remit</span> <span class="pre">and</span> <span class="pre">pemit</span> <span class="pre">are</span> <span class="pre">just\nlimited</span> <span class="pre">forms</span> <span class="pre">of</span> <span class="pre">emit,</span> <span class="pre">for</span> <span class="pre">sending</span> <span class="pre">to</span> <span class="pre">rooms</span> <span class="pre">and\nto</span> <span class="pre">accounts</span> <span class="pre">respectively.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'pemit</span> <span class="pre">remit',</span> <span class="pre">'category':</span> <span class="pre">'admin',</span> <span class="pre">'key':</span> <span class="pre">'emit',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">pemit</span> <span class="pre">remit',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nadmin</span> <span class="pre">command</span> <span class="pre">for</span> <span class="pre">emitting</span> <span class="pre">message</span> <span class="pre">to</span> <span class="pre">multiple</span> <span class="pre">objects\n\nUsage:\n</span>&#160; <span class="pre">emit[/switches]</span> <span class="pre">[&lt;obj&gt;,</span> <span class="pre">&lt;obj&gt;,</span> <span class="pre">...</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n</span>&#160; <span class="pre">remit</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[&lt;obj&gt;,</span> <span class="pre">&lt;obj&gt;,</span> <span class="pre">...</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n</span>&#160; <span class="pre">pemit</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">[&lt;obj&gt;,</span> <span class="pre">&lt;obj&gt;,</span> <span class="pre">...</span> <span class="pre">=]</span> <span class="pre">&lt;message&gt;\n\nSwitches:\n</span>&#160; <span class="pre">room</span>&#160;&#160;&#160;&#160; <span class="pre">-</span>&#160; <span class="pre">limit</span> <span class="pre">emits</span> <span class="pre">to</span> <span class="pre">rooms</span> <span class="pre">only</span> <span class="pre">(default)\n</span>&#160; <span class="pre">accounts</span> <span class="pre">-</span>&#160; <span class="pre">limit</span> <span class="pre">emits</span> <span class="pre">to</span> <span class="pre">accounts</span> <span class="pre">only\n</span>&#160; <span class="pre">contents</span> <span class="pre">-</span>&#160; <span class="pre">send</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">contents</span> <span class="pre">of</span> <span class="pre">matched</span> <span class="pre">objects</span> <span class="pre">too\n\nEmits</span> <span class="pre">a</span> <span class="pre">message</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">selected</span> <span class="pre">objects</span> <span class="pre">or</span> <span class="pre">to\nyour</span> <span class="pre">immediate</span> <span class="pre">surroundings.</span> <span class="pre">If</span> <span class="pre">the</span> <span class="pre">object</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">room,\nsend</span> <span class="pre">to</span> <span class="pre">its</span> <span class="pre">contents.</span> <span class="pre">remit</span> <span class="pre">and</span> <span class="pre">pemit</span> <span class="pre">are</span> <span class="pre">just\nlimited</span> <span class="pre">forms</span> <span class="pre">of</span> <span class="pre">emit,</span> <span class="pre">for</span> <span class="pre">sending</span> <span class="pre">to</span> <span class="pre">rooms</span> <span class="pre">and\nto</span> <span class="pre">accounts</span> <span class="pre">respectively.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

16
docs/latest/api/evennia.commands.default.building.html
View file

File diff suppressed because one or more lines are too long

8
docs/latest/api/evennia.commands.default.comms.html
View file

File diff suppressed because one or more lines are too long

16
docs/latest/api/evennia.commands.default.general.html
View file

File diff suppressed because one or more lines are too long

4
docs/latest/api/evennia.commands.default.system.html
View file

File diff suppressed because one or more lines are too long

12
docs/latest/api/evennia.commands.default.unloggedin.html
View file

@ -70,7 +70,7 @@ connect “account name” “pass word”</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['con',</span> <span class="pre">'co',</span> <span class="pre">'conn']</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['con',</span> <span class="pre">'conn',</span> <span class="pre">'co']</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -105,7 +105,7 @@ there is no object yet before the account has logged in)</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'con</span> <span class="pre">co</span> <span class="pre">conn',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'connect',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">con</span> <span class="pre">co</span> <span class="pre">conn',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nconnect</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">game\n\nUsage</span> <span class="pre">(at</span> <span class="pre">login</span> <span class="pre">screen):\n</span>&#160; <span class="pre">connect</span> <span class="pre">accountname</span> <span class="pre">password\n</span>&#160; <span class="pre">connect</span> <span class="pre">&quot;account</span> <span class="pre">name&quot;</span> <span class="pre">&quot;pass</span> <span class="pre">word&quot;\n\nUse</span> <span class="pre">the</span> <span class="pre">create</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">first</span> <span class="pre">create</span> <span class="pre">an</span> <span class="pre">account</span> <span class="pre">before</span> <span class="pre">logging</span> <span class="pre">in.\n\nIf</span> <span class="pre">you</span> <span class="pre">have</span> <span class="pre">spaces</span> <span class="pre">in</span> <span class="pre">your</span> <span class="pre">name,</span> <span class="pre">enclose</span> <span class="pre">it</span> <span class="pre">in</span> <span class="pre">double</span> <span class="pre">quotes.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'con</span> <span class="pre">conn</span> <span class="pre">co',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'connect',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">con</span> <span class="pre">conn</span> <span class="pre">co',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nconnect</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">game\n\nUsage</span> <span class="pre">(at</span> <span class="pre">login</span> <span class="pre">screen):\n</span>&#160; <span class="pre">connect</span> <span class="pre">accountname</span> <span class="pre">password\n</span>&#160; <span class="pre">connect</span> <span class="pre">&quot;account</span> <span class="pre">name&quot;</span> <span class="pre">&quot;pass</span> <span class="pre">word&quot;\n\nUse</span> <span class="pre">the</span> <span class="pre">create</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">first</span> <span class="pre">create</span> <span class="pre">an</span> <span class="pre">account</span> <span class="pre">before</span> <span class="pre">logging</span> <span class="pre">in.\n\nIf</span> <span class="pre">you</span> <span class="pre">have</span> <span class="pre">spaces</span> <span class="pre">in</span> <span class="pre">your</span> <span class="pre">name,</span> <span class="pre">enclose</span> <span class="pre">it</span> <span class="pre">in</span> <span class="pre">double</span> <span class="pre">quotes.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -240,7 +240,7 @@ All it does is display the connect screen.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['l',</span> <span class="pre">'look']</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['look',</span> <span class="pre">'l']</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -266,7 +266,7 @@ All it does is display the connect screen.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'l</span> <span class="pre">look',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'__unloggedin_look_command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">l</span> <span class="pre">look',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nlook</span> <span class="pre">when</span> <span class="pre">in</span> <span class="pre">unlogged-in</span> <span class="pre">state\n\nUsage:\n</span>&#160; <span class="pre">look\n\nThis</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">unconnected</span> <span class="pre">version</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">look</span> <span class="pre">command</span> <span class="pre">for</span> <span class="pre">simplicity.\n\nThis</span> <span class="pre">is</span> <span class="pre">called</span> <span class="pre">by</span> <span class="pre">the</span> <span class="pre">server</span> <span class="pre">and</span> <span class="pre">kicks</span> <span class="pre">everything</span> <span class="pre">in</span> <span class="pre">gear.\nAll</span> <span class="pre">it</span> <span class="pre">does</span> <span class="pre">is</span> <span class="pre">display</span> <span class="pre">the</span> <span class="pre">connect</span> <span class="pre">screen.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'look</span> <span class="pre">l',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'__unloggedin_look_command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">look</span> <span class="pre">l',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nlook</span> <span class="pre">when</span> <span class="pre">in</span> <span class="pre">unlogged-in</span> <span class="pre">state\n\nUsage:\n</span>&#160; <span class="pre">look\n\nThis</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">unconnected</span> <span class="pre">version</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">look</span> <span class="pre">command</span> <span class="pre">for</span> <span class="pre">simplicity.\n\nThis</span> <span class="pre">is</span> <span class="pre">called</span> <span class="pre">by</span> <span class="pre">the</span> <span class="pre">server</span> <span class="pre">and</span> <span class="pre">kicks</span> <span class="pre">everything</span> <span class="pre">in</span> <span class="pre">gear.\nAll</span> <span class="pre">it</span> <span class="pre">does</span> <span class="pre">is</span> <span class="pre">display</span> <span class="pre">the</span> <span class="pre">connect</span> <span class="pre">screen.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -289,7 +289,7 @@ for simplicity. It shows a pane of info.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['h',</span> <span class="pre">'?']</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['?',</span> <span class="pre">'h']</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -315,7 +315,7 @@ for simplicity. It shows a pane of info.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'h</span> <span class="pre">?',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'help',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">h</span> <span class="pre">?',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nget</span> <span class="pre">help</span> <span class="pre">when</span> <span class="pre">in</span> <span class="pre">unconnected-in</span> <span class="pre">state\n\nUsage:\n</span>&#160; <span class="pre">help\n\nThis</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">unconnected</span> <span class="pre">version</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">help</span> <span class="pre">command,\nfor</span> <span class="pre">simplicity.</span> <span class="pre">It</span> <span class="pre">shows</span> <span class="pre">a</span> <span class="pre">pane</span> <span class="pre">of</span> <span class="pre">info.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'?</span> <span class="pre">h',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'help',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">?</span> <span class="pre">h',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nget</span> <span class="pre">help</span> <span class="pre">when</span> <span class="pre">in</span> <span class="pre">unconnected-in</span> <span class="pre">state\n\nUsage:\n</span>&#160; <span class="pre">help\n\nThis</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">unconnected</span> <span class="pre">version</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">help</span> <span class="pre">command,\nfor</span> <span class="pre">simplicity.</span> <span class="pre">It</span> <span class="pre">shows</span> <span class="pre">a</span> <span class="pre">pane</span> <span class="pre">of</span> <span class="pre">info.\n'}</span></em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

12
docs/latest/api/evennia.contrib.base_systems.email_login.email_login.html
View file

@ -87,7 +87,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['con',</span> <span class="pre">'co',</span> <span class="pre">'conn']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['con',</span> <span class="pre">'conn',</span> <span class="pre">'co']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -117,7 +117,7 @@ there is no object yet before the account has logged in)</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'con</span> <span class="pre">co</span> <span class="pre">conn',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'connect',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">con</span> <span class="pre">co</span> <span class="pre">conn',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nConnect</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">game.\n\nUsage</span> <span class="pre">(at</span> <span class="pre">login</span> <span class="pre">screen):\n</span>&#160;&#160;&#160; <span class="pre">connect</span> <span class="pre">&lt;email&gt;</span> <span class="pre">&lt;password&gt;\n\nUse</span> <span class="pre">the</span> <span class="pre">create</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">first</span> <span class="pre">create</span> <span class="pre">an</span> <span class="pre">account</span> <span class="pre">before</span> <span class="pre">logging</span> <span class="pre">in.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'con</span> <span class="pre">conn</span> <span class="pre">co',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'connect',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">con</span> <span class="pre">conn</span> <span class="pre">co',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nConnect</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">game.\n\nUsage</span> <span class="pre">(at</span> <span class="pre">login</span> <span class="pre">screen):\n</span>&#160;&#160;&#160; <span class="pre">connect</span> <span class="pre">&lt;email&gt;</span> <span class="pre">&lt;password&gt;\n\nUse</span> <span class="pre">the</span> <span class="pre">create</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">first</span> <span class="pre">create</span> <span class="pre">an</span> <span class="pre">account</span> <span class="pre">before</span> <span class="pre">logging</span> <span class="pre">in.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedConnect.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -245,7 +245,7 @@ All it does is display the connect screen.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['l',</span> <span class="pre">'look']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['look',</span> <span class="pre">'l']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -271,7 +271,7 @@ All it does is display the connect screen.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'l</span> <span class="pre">look',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'__unloggedin_look_command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">l</span> <span class="pre">look',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nThis</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">unconnected</span> <span class="pre">version</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">`look`</span> <span class="pre">command</span> <span class="pre">for</span> <span class="pre">simplicity.\n\nThis</span> <span class="pre">is</span> <span class="pre">called</span> <span class="pre">by</span> <span class="pre">the</span> <span class="pre">server</span> <span class="pre">and</span> <span class="pre">kicks</span> <span class="pre">everything</span> <span class="pre">in</span> <span class="pre">gear.\nAll</span> <span class="pre">it</span> <span class="pre">does</span> <span class="pre">is</span> <span class="pre">display</span> <span class="pre">the</span> <span class="pre">connect</span> <span class="pre">screen.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'look</span> <span class="pre">l',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'__unloggedin_look_command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">look</span> <span class="pre">l',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nThis</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">unconnected</span> <span class="pre">version</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">`look`</span> <span class="pre">command</span> <span class="pre">for</span> <span class="pre">simplicity.\n\nThis</span> <span class="pre">is</span> <span class="pre">called</span> <span class="pre">by</span> <span class="pre">the</span> <span class="pre">server</span> <span class="pre">and</span> <span class="pre">kicks</span> <span class="pre">everything</span> <span class="pre">in</span> <span class="pre">gear.\nAll</span> <span class="pre">it</span> <span class="pre">does</span> <span class="pre">is</span> <span class="pre">display</span> <span class="pre">the</span> <span class="pre">connect</span> <span class="pre">screen.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedLook.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -289,7 +289,7 @@ for simplicity. It shows a pane of info.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['h',</span> <span class="pre">'?']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['?',</span> <span class="pre">'h']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -315,7 +315,7 @@ for simplicity. It shows a pane of info.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'h</span> <span class="pre">?',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'help',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">h</span> <span class="pre">?',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nThis</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">unconnected</span> <span class="pre">version</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">help</span> <span class="pre">command,\nfor</span> <span class="pre">simplicity.</span> <span class="pre">It</span> <span class="pre">shows</span> <span class="pre">a</span> <span class="pre">pane</span> <span class="pre">of</span> <span class="pre">info.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'?</span> <span class="pre">h',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'help',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">?</span> <span class="pre">h',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nThis</span> <span class="pre">is</span> <span class="pre">an</span> <span class="pre">unconnected</span> <span class="pre">version</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">help</span> <span class="pre">command,\nfor</span> <span class="pre">simplicity.</span> <span class="pre">It</span> <span class="pre">shows</span> <span class="pre">a</span> <span class="pre">pane</span> <span class="pre">of</span> <span class="pre">info.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.email_login.email_login.CmdUnconnectedHelp.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.base_systems.ingame_python.commands.html
View file

@ -64,7 +64,7 @@
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['&#64;calls',</span> <span class="pre">'&#64;callbacks',</span> <span class="pre">'&#64;callback']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['&#64;calls',</span> <span class="pre">'&#64;callback',</span> <span class="pre">'&#64;callbacks']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -145,7 +145,7 @@ on user permission.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'&#64;calls</span> <span class="pre">&#64;callbacks</span> <span class="pre">&#64;callback',</span> <span class="pre">'category':</span> <span class="pre">'building',</span> <span class="pre">'key':</span> <span class="pre">'&#64;call',</span> <span class="pre">'no_prefix':</span> <span class="pre">'call</span> <span class="pre">calls</span> <span class="pre">callbacks</span> <span class="pre">callback',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nCommand</span> <span class="pre">to</span> <span class="pre">edit</span> <span class="pre">callbacks.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'&#64;calls</span> <span class="pre">&#64;callback</span> <span class="pre">&#64;callbacks',</span> <span class="pre">'category':</span> <span class="pre">'building',</span> <span class="pre">'key':</span> <span class="pre">'&#64;call',</span> <span class="pre">'no_prefix':</span> <span class="pre">'call</span> <span class="pre">calls</span> <span class="pre">callback</span> <span class="pre">callbacks',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nCommand</span> <span class="pre">to</span> <span class="pre">edit</span> <span class="pre">callbacks.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.commands.CmdCallback.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.base_systems.ingame_reports.reports.html
View file

@ -100,7 +100,7 @@ players</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['manage</span> <span class="pre">bugs',</span> <span class="pre">'manage</span> <span class="pre">players',</span> <span class="pre">'manage</span> <span class="pre">ideas']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['manage</span> <span class="pre">players',</span> <span class="pre">'manage</span> <span class="pre">ideas',</span> <span class="pre">'manage</span> <span class="pre">bugs']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -136,7 +136,7 @@ to all the variables defined therein.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'manage</span> <span class="pre">bugs</span> <span class="pre">manage</span> <span class="pre">players</span> <span class="pre">manage</span> <span class="pre">ideas',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'manage</span> <span class="pre">reports',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">manage</span> <span class="pre">bugs</span> <span class="pre">manage</span> <span class="pre">players</span> <span class="pre">manage</span> <span class="pre">ideas',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nmanage</span> <span class="pre">the</span> <span class="pre">various</span> <span class="pre">reports\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">manage</span> <span class="pre">[report</span> <span class="pre">type]\n\nAvailable</span> <span class="pre">report</span> <span class="pre">types:\n</span>&#160;&#160;&#160; <span class="pre">bugs\n</span>&#160;&#160;&#160; <span class="pre">ideas\n</span>&#160;&#160;&#160; <span class="pre">players\n\nInitializes</span> <span class="pre">a</span> <span class="pre">menu</span> <span class="pre">for</span> <span class="pre">reviewing</span> <span class="pre">and</span> <span class="pre">changing</span> <span class="pre">the</span> <span class="pre">status</span> <span class="pre">of</span> <span class="pre">current</span> <span class="pre">reports.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'manage</span> <span class="pre">players</span> <span class="pre">manage</span> <span class="pre">ideas</span> <span class="pre">manage</span> <span class="pre">bugs',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'manage</span> <span class="pre">reports',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">manage</span> <span class="pre">players</span> <span class="pre">manage</span> <span class="pre">ideas</span> <span class="pre">manage</span> <span class="pre">bugs',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nmanage</span> <span class="pre">the</span> <span class="pre">various</span> <span class="pre">reports\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">manage</span> <span class="pre">[report</span> <span class="pre">type]\n\nAvailable</span> <span class="pre">report</span> <span class="pre">types:\n</span>&#160;&#160;&#160; <span class="pre">bugs\n</span>&#160;&#160;&#160; <span class="pre">ideas\n</span>&#160;&#160;&#160; <span class="pre">players\n\nInitializes</span> <span class="pre">a</span> <span class="pre">menu</span> <span class="pre">for</span> <span class="pre">reviewing</span> <span class="pre">and</span> <span class="pre">changing</span> <span class="pre">the</span> <span class="pre">status</span> <span class="pre">of</span> <span class="pre">current</span> <span class="pre">reports.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.ingame_reports.reports.CmdManageReports.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.html
View file

@ -108,7 +108,7 @@ aliases to an already joined channel.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['aliaschan',</span> <span class="pre">'chanalias']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['chanalias',</span> <span class="pre">'aliaschan']</span></em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -139,7 +139,7 @@ aliases to an already joined channel.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'aliaschan</span> <span class="pre">chanalias',</span> <span class="pre">'category':</span> <span class="pre">'comms',</span> <span class="pre">'key':</span> <span class="pre">'addcom',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">aliaschan</span> <span class="pre">chanalias',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nAdd</span> <span class="pre">a</span> <span class="pre">channel</span> <span class="pre">alias</span> <span class="pre">and/or</span> <span class="pre">subscribe</span> <span class="pre">to</span> <span class="pre">a</span> <span class="pre">channel\n\nUsage:\n</span>&#160;&#160; <span class="pre">addcom</span> <span class="pre">[alias=]</span> <span class="pre">&lt;channel&gt;\n\nJoins</span> <span class="pre">a</span> <span class="pre">given</span> <span class="pre">channel.</span> <span class="pre">If</span> <span class="pre">alias</span> <span class="pre">is</span> <span class="pre">given,</span> <span class="pre">this</span> <span class="pre">will</span> <span class="pre">allow</span> <span class="pre">you</span> <span class="pre">to\nrefer</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">channel</span> <span class="pre">by</span> <span class="pre">this</span> <span class="pre">alias</span> <span class="pre">rather</span> <span class="pre">than</span> <span class="pre">the</span> <span class="pre">full</span> <span class="pre">channel\nname.</span> <span class="pre">Subsequent</span> <span class="pre">calls</span> <span class="pre">of</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">can</span> <span class="pre">be</span> <span class="pre">used</span> <span class="pre">to</span> <span class="pre">add</span> <span class="pre">multiple\naliases</span> <span class="pre">to</span> <span class="pre">an</span> <span class="pre">already</span> <span class="pre">joined</span> <span class="pre">channel.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'chanalias</span> <span class="pre">aliaschan',</span> <span class="pre">'category':</span> <span class="pre">'comms',</span> <span class="pre">'key':</span> <span class="pre">'addcom',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">chanalias</span> <span class="pre">aliaschan',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nAdd</span> <span class="pre">a</span> <span class="pre">channel</span> <span class="pre">alias</span> <span class="pre">and/or</span> <span class="pre">subscribe</span> <span class="pre">to</span> <span class="pre">a</span> <span class="pre">channel\n\nUsage:\n</span>&#160;&#160; <span class="pre">addcom</span> <span class="pre">[alias=]</span> <span class="pre">&lt;channel&gt;\n\nJoins</span> <span class="pre">a</span> <span class="pre">given</span> <span class="pre">channel.</span> <span class="pre">If</span> <span class="pre">alias</span> <span class="pre">is</span> <span class="pre">given,</span> <span class="pre">this</span> <span class="pre">will</span> <span class="pre">allow</span> <span class="pre">you</span> <span class="pre">to\nrefer</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">channel</span> <span class="pre">by</span> <span class="pre">this</span> <span class="pre">alias</span> <span class="pre">rather</span> <span class="pre">than</span> <span class="pre">the</span> <span class="pre">full</span> <span class="pre">channel\nname.</span> <span class="pre">Subsequent</span> <span class="pre">calls</span> <span class="pre">of</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">can</span> <span class="pre">be</span> <span class="pre">used</span> <span class="pre">to</span> <span class="pre">add</span> <span class="pre">multiple\naliases</span> <span class="pre">to</span> <span class="pre">an</span> <span class="pre">already</span> <span class="pre">joined</span> <span class="pre">channel.\n'}</span></em><a class="headerlink" href="#evennia.contrib.base_systems.mux_comms_cmds.mux_comms_cmds.CmdAddCom.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

16
docs/latest/api/evennia.contrib.full_systems.evscaperoom.commands.html
View file

@ -159,7 +159,7 @@ the operation will be general or on the room.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['abort',</span> <span class="pre">'chicken</span> <span class="pre">out',</span> <span class="pre">'quit',</span> <span class="pre">'q']</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['chicken</span> <span class="pre">out',</span> <span class="pre">'q',</span> <span class="pre">'abort',</span> <span class="pre">'quit']</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@ -183,7 +183,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'abort</span> <span class="pre">chicken</span> <span class="pre">out</span> <span class="pre">quit</span> <span class="pre">q',</span> <span class="pre">'category':</span> <span class="pre">'evscaperoom',</span> <span class="pre">'key':</span> <span class="pre">'give</span> <span class="pre">up',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">abort</span> <span class="pre">chicken</span> <span class="pre">out</span> <span class="pre">quit</span> <span class="pre">q',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nGive</span> <span class="pre">up\n\nUsage:\n</span>&#160; <span class="pre">give</span> <span class="pre">up\n\nAbandons</span> <span class="pre">your</span> <span class="pre">attempts</span> <span class="pre">at</span> <span class="pre">escaping</span> <span class="pre">and</span> <span class="pre">of</span> <span class="pre">ever</span> <span class="pre">winning</span> <span class="pre">the</span> <span class="pre">pie-eating</span> <span class="pre">contest.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'chicken</span> <span class="pre">out</span> <span class="pre">q</span> <span class="pre">abort</span> <span class="pre">quit',</span> <span class="pre">'category':</span> <span class="pre">'evscaperoom',</span> <span class="pre">'key':</span> <span class="pre">'give</span> <span class="pre">up',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">chicken</span> <span class="pre">out</span> <span class="pre">q</span> <span class="pre">abort</span> <span class="pre">quit',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nGive</span> <span class="pre">up\n\nUsage:\n</span>&#160; <span class="pre">give</span> <span class="pre">up\n\nAbandons</span> <span class="pre">your</span> <span class="pre">attempts</span> <span class="pre">at</span> <span class="pre">escaping</span> <span class="pre">and</span> <span class="pre">of</span> <span class="pre">ever</span> <span class="pre">winning</span> <span class="pre">the</span> <span class="pre">pie-eating</span> <span class="pre">contest.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGiveUp.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -319,7 +319,7 @@ shout</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['shout',</span> <span class="pre">'whisper',</span> <span class="pre">';']</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['whisper',</span> <span class="pre">'shout',</span> <span class="pre">';']</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -348,7 +348,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'shout</span> <span class="pre">whisper</span> <span class="pre">;',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'say',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">shout</span> <span class="pre">whisper</span> <span class="pre">;',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPerform</span> <span class="pre">an</span> <span class="pre">communication</span> <span class="pre">action.\n\nUsage:\n</span>&#160; <span class="pre">say</span> <span class="pre">&lt;text&gt;\n</span>&#160; <span class="pre">whisper\n</span>&#160; <span class="pre">shout\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'whisper</span> <span class="pre">shout</span> <span class="pre">;',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'say',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">whisper</span> <span class="pre">shout</span> <span class="pre">;',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPerform</span> <span class="pre">an</span> <span class="pre">communication</span> <span class="pre">action.\n\nUsage:\n</span>&#160; <span class="pre">say</span> <span class="pre">&lt;text&gt;\n</span>&#160; <span class="pre">whisper\n</span>&#160; <span class="pre">shout\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdSpeak.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -438,7 +438,7 @@ looks and what actions is available.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['examine',</span> <span class="pre">'unfocus',</span> <span class="pre">'ex',</span> <span class="pre">'e']</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['e',</span> <span class="pre">'examine',</span> <span class="pre">'unfocus',</span> <span class="pre">'ex']</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -467,7 +467,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'examine</span> <span class="pre">unfocus</span> <span class="pre">ex</span> <span class="pre">e',</span> <span class="pre">'category':</span> <span class="pre">'evscaperoom',</span> <span class="pre">'key':</span> <span class="pre">'focus',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">examine</span> <span class="pre">unfocus</span> <span class="pre">ex</span> <span class="pre">e',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nFocus</span> <span class="pre">your</span> <span class="pre">attention</span> <span class="pre">on</span> <span class="pre">a</span> <span class="pre">target.\n\nUsage:\n</span>&#160; <span class="pre">focus</span> <span class="pre">&lt;obj&gt;\n\nOnce</span> <span class="pre">focusing</span> <span class="pre">on</span> <span class="pre">an</span> <span class="pre">object,</span> <span class="pre">use</span> <span class="pre">look</span> <span class="pre">to</span> <span class="pre">get</span> <span class="pre">more</span> <span class="pre">information</span> <span class="pre">about</span> <span class="pre">how</span> <span class="pre">it\nlooks</span> <span class="pre">and</span> <span class="pre">what</span> <span class="pre">actions</span> <span class="pre">is</span> <span class="pre">available.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'e</span> <span class="pre">examine</span> <span class="pre">unfocus</span> <span class="pre">ex',</span> <span class="pre">'category':</span> <span class="pre">'evscaperoom',</span> <span class="pre">'key':</span> <span class="pre">'focus',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">e</span> <span class="pre">examine</span> <span class="pre">unfocus</span> <span class="pre">ex',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nFocus</span> <span class="pre">your</span> <span class="pre">attention</span> <span class="pre">on</span> <span class="pre">a</span> <span class="pre">target.\n\nUsage:\n</span>&#160; <span class="pre">focus</span> <span class="pre">&lt;obj&gt;\n\nOnce</span> <span class="pre">focusing</span> <span class="pre">on</span> <span class="pre">an</span> <span class="pre">object,</span> <span class="pre">use</span> <span class="pre">look</span> <span class="pre">to</span> <span class="pre">get</span> <span class="pre">more</span> <span class="pre">information</span> <span class="pre">about</span> <span class="pre">how</span> <span class="pre">it\nlooks</span> <span class="pre">and</span> <span class="pre">what</span> <span class="pre">actions</span> <span class="pre">is</span> <span class="pre">available.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdFocus.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -529,7 +529,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['inventory',</span> <span class="pre">'give',</span> <span class="pre">'i',</span> <span class="pre">'inv']</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['inv',</span> <span class="pre">'give',</span> <span class="pre">'i',</span> <span class="pre">'inventory']</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@ -553,7 +553,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'inventory</span> <span class="pre">give</span> <span class="pre">i</span> <span class="pre">inv',</span> <span class="pre">'category':</span> <span class="pre">'evscaperoom',</span> <span class="pre">'key':</span> <span class="pre">'get',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">inventory</span> <span class="pre">give</span> <span class="pre">i</span> <span class="pre">inv',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nUse</span> <span class="pre">focus</span> <span class="pre">/</span> <span class="pre">examine</span> <span class="pre">instead.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'inv</span> <span class="pre">give</span> <span class="pre">i</span> <span class="pre">inventory',</span> <span class="pre">'category':</span> <span class="pre">'evscaperoom',</span> <span class="pre">'key':</span> <span class="pre">'get',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">inv</span> <span class="pre">give</span> <span class="pre">i</span> <span class="pre">inventory',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nUse</span> <span class="pre">focus</span> <span class="pre">/</span> <span class="pre">examine</span> <span class="pre">instead.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.full_systems.evscaperoom.commands.CmdGet.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.game_systems.achievements.achievements.html
View file

@ -223,7 +223,7 @@ achievements/progress rats</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.achievements.achievements.CmdAchieve.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['achievement',</span> <span class="pre">'achieves',</span> <span class="pre">'achieve']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.achievements.achievements.CmdAchieve.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['achieves',</span> <span class="pre">'achievement',</span> <span class="pre">'achieve']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.achievements.achievements.CmdAchieve.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -273,7 +273,7 @@ to all the variables defined therein.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.achievements.achievements.CmdAchieve.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'achievement</span> <span class="pre">achieves</span> <span class="pre">achieve',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'achievements',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">achievement</span> <span class="pre">achieves</span> <span class="pre">achieve',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nview</span> <span class="pre">achievements\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">achievements[/switches]</span> <span class="pre">[args]\n\nSwitches:\n</span>&#160;&#160;&#160; <span class="pre">all</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">View</span> <span class="pre">all</span> <span class="pre">achievements,</span> <span class="pre">including</span> <span class="pre">locked</span> <span class="pre">ones.\n</span>&#160;&#160;&#160; <span class="pre">completed</span>&#160;&#160;&#160; <span class="pre">View</span> <span class="pre">achievements</span> <span class="pre">you\'ve</span> <span class="pre">completed.\n</span>&#160;&#160;&#160; <span class="pre">progress</span>&#160;&#160;&#160;&#160; <span class="pre">View</span> <span class="pre">achievements</span> <span class="pre">you</span> <span class="pre">have</span> <span class="pre">partially</span> <span class="pre">completed\n\nCheck</span> <span class="pre">your</span> <span class="pre">achievement</span> <span class="pre">statuses</span> <span class="pre">or</span> <span class="pre">browse</span> <span class="pre">the</span> <span class="pre">list.</span> <span class="pre">Providing</span> <span class="pre">a</span> <span class="pre">command</span> <span class="pre">argument\nwill</span> <span class="pre">search</span> <span class="pre">all</span> <span class="pre">your</span> <span class="pre">currently</span> <span class="pre">unlocked</span> <span class="pre">achievements</span> <span class="pre">for</span> <span class="pre">matches,</span> <span class="pre">and</span> <span class="pre">the</span> <span class="pre">switches\nwill</span> <span class="pre">filter</span> <span class="pre">the</span> <span class="pre">list</span> <span class="pre">to</span> <span class="pre">something</span> <span class="pre">other</span> <span class="pre">than</span> <span class="pre">&quot;all</span> <span class="pre">unlocked&quot;.</span> <span class="pre">Combining</span> <span class="pre">a</span> <span class="pre">command\nargument</span> <span class="pre">with</span> <span class="pre">a</span> <span class="pre">switch</span> <span class="pre">will</span> <span class="pre">search</span> <span class="pre">only</span> <span class="pre">in</span> <span class="pre">that</span> <span class="pre">list.\n\nExamples:\n</span>&#160;&#160;&#160; <span class="pre">achievements</span> <span class="pre">apples\n</span>&#160;&#160;&#160; <span class="pre">achievements/all\n</span>&#160;&#160;&#160; <span class="pre">achievements/progress</span> <span class="pre">rats\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.achievements.achievements.CmdAchieve.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'achieves</span> <span class="pre">achievement</span> <span class="pre">achieve',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'achievements',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">achieves</span> <span class="pre">achievement</span> <span class="pre">achieve',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nview</span> <span class="pre">achievements\n\nUsage:\n</span>&#160;&#160;&#160; <span class="pre">achievements[/switches]</span> <span class="pre">[args]\n\nSwitches:\n</span>&#160;&#160;&#160; <span class="pre">all</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">View</span> <span class="pre">all</span> <span class="pre">achievements,</span> <span class="pre">including</span> <span class="pre">locked</span> <span class="pre">ones.\n</span>&#160;&#160;&#160; <span class="pre">completed</span>&#160;&#160;&#160; <span class="pre">View</span> <span class="pre">achievements</span> <span class="pre">you\'ve</span> <span class="pre">completed.\n</span>&#160;&#160;&#160; <span class="pre">progress</span>&#160;&#160;&#160;&#160; <span class="pre">View</span> <span class="pre">achievements</span> <span class="pre">you</span> <span class="pre">have</span> <span class="pre">partially</span> <span class="pre">completed\n\nCheck</span> <span class="pre">your</span> <span class="pre">achievement</span> <span class="pre">statuses</span> <span class="pre">or</span> <span class="pre">browse</span> <span class="pre">the</span> <span class="pre">list.</span> <span class="pre">Providing</span> <span class="pre">a</span> <span class="pre">command</span> <span class="pre">argument\nwill</span> <span class="pre">search</span> <span class="pre">all</span> <span class="pre">your</span> <span class="pre">currently</span> <span class="pre">unlocked</span> <span class="pre">achievements</span> <span class="pre">for</span> <span class="pre">matches,</span> <span class="pre">and</span> <span class="pre">the</span> <span class="pre">switches\nwill</span> <span class="pre">filter</span> <span class="pre">the</span> <span class="pre">list</span> <span class="pre">to</span> <span class="pre">something</span> <span class="pre">other</span> <span class="pre">than</span> <span class="pre">&quot;all</span> <span class="pre">unlocked&quot;.</span> <span class="pre">Combining</span> <span class="pre">a</span> <span class="pre">command\nargument</span> <span class="pre">with</span> <span class="pre">a</span> <span class="pre">switch</span> <span class="pre">will</span> <span class="pre">search</span> <span class="pre">only</span> <span class="pre">in</span> <span class="pre">that</span> <span class="pre">list.\n\nExamples:\n</span>&#160;&#160;&#160; <span class="pre">achievements</span> <span class="pre">apples\n</span>&#160;&#160;&#160; <span class="pre">achievements/all\n</span>&#160;&#160;&#160; <span class="pre">achievements/progress</span> <span class="pre">rats\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.achievements.achievements.CmdAchieve.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.game_systems.clothing.clothing.html
View file

@ -576,7 +576,7 @@ inv</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['i',</span> <span class="pre">'inv']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['inv',</span> <span class="pre">'i']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -607,7 +607,7 @@ inv</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.clothing.clothing.CmdInventory.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'i</span> <span class="pre">inv',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'inventory',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">i</span> <span class="pre">inv',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nview</span> <span class="pre">inventory\n\nUsage:\n</span>&#160; <span class="pre">inventory\n</span>&#160; <span class="pre">inv\n\nShows</span> <span class="pre">your</span> <span class="pre">inventory.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'inv</span> <span class="pre">i',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'inventory',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">inv</span> <span class="pre">i',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nview</span> <span class="pre">inventory\n\nUsage:\n</span>&#160; <span class="pre">inventory\n</span>&#160; <span class="pre">inv\n\nShows</span> <span class="pre">your</span> <span class="pre">inventory.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.clothing.clothing.CmdInventory.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_basic.html
View file

@ -626,7 +626,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['wait',</span> <span class="pre">'hold']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['hold',</span> <span class="pre">'wait']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -652,7 +652,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'wait</span> <span class="pre">hold',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">wait</span> <span class="pre">hold',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'hold</span> <span class="pre">wait',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">hold</span> <span class="pre">wait',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_basic.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_equip.html
View file

@ -521,7 +521,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['wait',</span> <span class="pre">'hold']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['hold',</span> <span class="pre">'wait']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -541,7 +541,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'wait</span> <span class="pre">hold',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">wait</span> <span class="pre">hold',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'hold</span> <span class="pre">wait',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">hold</span> <span class="pre">wait',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_equip.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_items.html
View file

@ -647,7 +647,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['wait',</span> <span class="pre">'hold']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['hold',</span> <span class="pre">'wait']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -667,7 +667,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'wait</span> <span class="pre">hold',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">wait</span> <span class="pre">hold',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'hold</span> <span class="pre">wait',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">hold</span> <span class="pre">wait',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_items.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_magic.html
View file

@ -426,7 +426,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['wait',</span> <span class="pre">'hold']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['hold',</span> <span class="pre">'wait']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -446,7 +446,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'wait</span> <span class="pre">hold',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">wait</span> <span class="pre">hold',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'hold</span> <span class="pre">wait',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">hold</span> <span class="pre">wait',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_magic.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.game_systems.turnbattle.tb_range.html
View file

@ -883,7 +883,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['wait',</span> <span class="pre">'hold']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['hold',</span> <span class="pre">'wait']</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -903,7 +903,7 @@ if there are still any actions you can take.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'wait</span> <span class="pre">hold',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">wait</span> <span class="pre">hold',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'hold</span> <span class="pre">wait',</span> <span class="pre">'category':</span> <span class="pre">'combat',</span> <span class="pre">'key':</span> <span class="pre">'pass',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">hold</span> <span class="pre">wait',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPasses</span> <span class="pre">on</span> <span class="pre">your</span> <span class="pre">turn.\n\nUsage:\n</span>&#160; <span class="pre">pass\n\nWhen</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">fight,</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">use</span> <span class="pre">this</span> <span class="pre">command</span> <span class="pre">to</span> <span class="pre">end</span> <span class="pre">your</span> <span class="pre">turn</span> <span class="pre">early,</span> <span class="pre">even\nif</span> <span class="pre">there</span> <span class="pre">are</span> <span class="pre">still</span> <span class="pre">any</span> <span class="pre">actions</span> <span class="pre">you</span> <span class="pre">can</span> <span class="pre">take.\n'}</span></em><a class="headerlink" href="#evennia.contrib.game_systems.turnbattle.tb_range.CmdPass.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.grid.xyzgrid.commands.html
View file

@ -370,7 +370,7 @@ there is no room above/below you, your movement will fail.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['fly',</span> <span class="pre">'dive']</span></em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['dive',</span> <span class="pre">'fly']</span></em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@ -395,7 +395,7 @@ to all the variables defined therein.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'fly</span> <span class="pre">dive',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'fly</span> <span class="pre">or</span> <span class="pre">dive',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">fly</span> <span class="pre">dive',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nFly</span> <span class="pre">or</span> <span class="pre">Dive</span> <span class="pre">up</span> <span class="pre">and</span> <span class="pre">down.\n\nUsage:\n</span>&#160; <span class="pre">fly\n</span>&#160; <span class="pre">dive\n\nWill</span> <span class="pre">fly</span> <span class="pre">up</span> <span class="pre">one</span> <span class="pre">room</span> <span class="pre">or</span> <span class="pre">dive</span> <span class="pre">down</span> <span class="pre">one</span> <span class="pre">room</span> <span class="pre">at</span> <span class="pre">your</span> <span class="pre">current</span> <span class="pre">position.</span> <span class="pre">If\nthere</span> <span class="pre">is</span> <span class="pre">no</span> <span class="pre">room</span> <span class="pre">above/below</span> <span class="pre">you,</span> <span class="pre">your</span> <span class="pre">movement</span> <span class="pre">will</span> <span class="pre">fail.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'dive</span> <span class="pre">fly',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'fly</span> <span class="pre">or</span> <span class="pre">dive',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">dive</span> <span class="pre">fly',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nFly</span> <span class="pre">or</span> <span class="pre">Dive</span> <span class="pre">up</span> <span class="pre">and</span> <span class="pre">down.\n\nUsage:\n</span>&#160; <span class="pre">fly\n</span>&#160; <span class="pre">dive\n\nWill</span> <span class="pre">fly</span> <span class="pre">up</span> <span class="pre">one</span> <span class="pre">room</span> <span class="pre">or</span> <span class="pre">dive</span> <span class="pre">down</span> <span class="pre">one</span> <span class="pre">room</span> <span class="pre">at</span> <span class="pre">your</span> <span class="pre">current</span> <span class="pre">position.</span> <span class="pre">If\nthere</span> <span class="pre">is</span> <span class="pre">no</span> <span class="pre">room</span> <span class="pre">above/below</span> <span class="pre">you,</span> <span class="pre">your</span> <span class="pre">movement</span> <span class="pre">will</span> <span class="pre">fail.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.grid.xyzgrid.commands.CmdFlyAndDive.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.rpg.dice.dice.html
View file

File diff suppressed because one or more lines are too long

4
docs/latest/api/evennia.contrib.rpg.rpsystem.rpsystem.html
View file

@ -670,7 +670,7 @@ commands the caller can use.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[&quot;'&quot;,</span> <span class="pre">'&quot;']</span></em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['&quot;',</span> <span class="pre">&quot;'&quot;]</span></em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -701,7 +701,7 @@ commands the caller can use.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'\'</span> <span class="pre">&quot;',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'say',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">\'</span> <span class="pre">&quot;',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nspeak</span> <span class="pre">as</span> <span class="pre">your</span> <span class="pre">character\n\nUsage:\n</span>&#160; <span class="pre">say</span> <span class="pre">&lt;message&gt;\n\nTalk</span> <span class="pre">to</span> <span class="pre">those</span> <span class="pre">in</span> <span class="pre">your</span> <span class="pre">current</span> <span class="pre">location.\n'}</span></em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'&quot;</span> <span class="pre">\'',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'say',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">&quot;</span> <span class="pre">\'',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nspeak</span> <span class="pre">as</span> <span class="pre">your</span> <span class="pre">character\n\nUsage:\n</span>&#160; <span class="pre">say</span> <span class="pre">&lt;message&gt;\n\nTalk</span> <span class="pre">to</span> <span class="pre">those</span> <span class="pre">in</span> <span class="pre">your</span> <span class="pre">current</span> <span class="pre">location.\n'}</span></em><a class="headerlink" href="#evennia.contrib.rpg.rpsystem.rpsystem.CmdSay.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.tutorials.evadventure.combat_turnbased.html
View file

@ -414,7 +414,7 @@ turn of combat, performing everyone’s actions in random order.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['turnbased</span> <span class="pre">combat',</span> <span class="pre">'hit']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['hit',</span> <span class="pre">'turnbased</span> <span class="pre">combat']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -460,7 +460,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'turnbased</span> <span class="pre">combat</span> <span class="pre">hit',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'attack',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">turnbased</span> <span class="pre">combat</span> <span class="pre">hit',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nStart</span> <span class="pre">or</span> <span class="pre">join</span> <span class="pre">combat.\n\nUsage:\n</span>&#160; <span class="pre">attack</span> <span class="pre">[&lt;target&gt;]\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'hit</span> <span class="pre">turnbased</span> <span class="pre">combat',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'attack',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">hit</span> <span class="pre">turnbased</span> <span class="pre">combat',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nStart</span> <span class="pre">or</span> <span class="pre">join</span> <span class="pre">combat.\n\nUsage:\n</span>&#160; <span class="pre">attack</span> <span class="pre">[&lt;target&gt;]\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.combat_turnbased.CmdTurnAttack.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

8
docs/latest/api/evennia.contrib.tutorials.evadventure.commands.html
View file

@ -140,7 +140,7 @@ self.args).</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.commands.CmdInventory.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['i',</span> <span class="pre">'inv']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['inv',</span> <span class="pre">'i']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@ -164,7 +164,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.commands.CmdInventory.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'i</span> <span class="pre">inv',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'inventory',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">i</span> <span class="pre">inv',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nView</span> <span class="pre">your</span> <span class="pre">inventory\n\nUsage:\n</span>&#160; <span class="pre">inventory\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'inv</span> <span class="pre">i',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'inventory',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">inv</span> <span class="pre">i',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nView</span> <span class="pre">your</span> <span class="pre">inventory\n\nUsage:\n</span>&#160; <span class="pre">inventory\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdInventory.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -241,7 +241,7 @@ unwear &lt;item&gt;</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['unwear',</span> <span class="pre">'unwield']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['unwield',</span> <span class="pre">'unwear']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
@ -265,7 +265,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'unwear</span> <span class="pre">unwield',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'remove',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">unwear</span> <span class="pre">unwield',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nRemove</span> <span class="pre">a</span> <span class="pre">remove</span> <span class="pre">a</span> <span class="pre">weapon/shield,</span> <span class="pre">armor</span> <span class="pre">or</span> <span class="pre">helmet.\n\nUsage:\n</span>&#160; <span class="pre">remove</span> <span class="pre">&lt;item&gt;\n</span>&#160; <span class="pre">unwield</span> <span class="pre">&lt;item&gt;\n</span>&#160; <span class="pre">unwear</span> <span class="pre">&lt;item&gt;\n\nTo</span> <span class="pre">remove</span> <span class="pre">an</span> <span class="pre">item</span> <span class="pre">from</span> <span class="pre">the</span> <span class="pre">backpack,</span> <span class="pre">use</span> <span class="pre">|wdrop|n</span> <span class="pre">instead.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'unwield</span> <span class="pre">unwear',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'remove',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">unwield</span> <span class="pre">unwear',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nRemove</span> <span class="pre">a</span> <span class="pre">remove</span> <span class="pre">a</span> <span class="pre">weapon/shield,</span> <span class="pre">armor</span> <span class="pre">or</span> <span class="pre">helmet.\n\nUsage:\n</span>&#160; <span class="pre">remove</span> <span class="pre">&lt;item&gt;\n</span>&#160; <span class="pre">unwield</span> <span class="pre">&lt;item&gt;\n</span>&#160; <span class="pre">unwear</span> <span class="pre">&lt;item&gt;\n\nTo</span> <span class="pre">remove</span> <span class="pre">an</span> <span class="pre">item</span> <span class="pre">from</span> <span class="pre">the</span> <span class="pre">backpack,</span> <span class="pre">use</span> <span class="pre">|wdrop|n</span> <span class="pre">instead.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.evadventure.commands.CmdRemove.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

12
docs/latest/api/evennia.contrib.tutorials.red_button.red_button.html
View file

@ -94,7 +94,7 @@ such as when closing the lid and un-blinding a character.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['press</span> <span class="pre">button',</span> <span class="pre">'press',</span> <span class="pre">'push']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['push',</span> <span class="pre">'press',</span> <span class="pre">'press</span> <span class="pre">button']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -123,7 +123,7 @@ check if the lid is open or closed.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'press</span> <span class="pre">button</span> <span class="pre">press</span> <span class="pre">push',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'push</span> <span class="pre">button',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">press</span> <span class="pre">button</span> <span class="pre">press</span> <span class="pre">push',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPush</span> <span class="pre">the</span> <span class="pre">red</span> <span class="pre">button</span> <span class="pre">(lid</span> <span class="pre">closed)\n\nUsage:\n</span>&#160; <span class="pre">push</span> <span class="pre">button\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'push</span> <span class="pre">press</span> <span class="pre">press</span> <span class="pre">button',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'push</span> <span class="pre">button',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">push</span> <span class="pre">press</span> <span class="pre">press</span> <span class="pre">button',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPush</span> <span class="pre">the</span> <span class="pre">red</span> <span class="pre">button</span> <span class="pre">(lid</span> <span class="pre">closed)\n\nUsage:\n</span>&#160; <span class="pre">push</span> <span class="pre">button\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidClosed.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -320,7 +320,7 @@ be mutually exclusive.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['press</span> <span class="pre">button',</span> <span class="pre">'press',</span> <span class="pre">'push']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['push',</span> <span class="pre">'press',</span> <span class="pre">'press</span> <span class="pre">button']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -349,7 +349,7 @@ set in self.parse())</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'press</span> <span class="pre">button</span> <span class="pre">press</span> <span class="pre">push',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'push</span> <span class="pre">button',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">press</span> <span class="pre">button</span> <span class="pre">press</span> <span class="pre">push',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPush</span> <span class="pre">the</span> <span class="pre">red</span> <span class="pre">button\n\nUsage:\n</span>&#160; <span class="pre">push</span> <span class="pre">button\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'push</span> <span class="pre">press</span> <span class="pre">press</span> <span class="pre">button',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'push</span> <span class="pre">button',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">push</span> <span class="pre">press</span> <span class="pre">press</span> <span class="pre">button',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPush</span> <span class="pre">the</span> <span class="pre">red</span> <span class="pre">button\n\nUsage:\n</span>&#160; <span class="pre">push</span> <span class="pre">button\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdPushLidOpen.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -447,7 +447,7 @@ be mutually exclusive.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['get',</span> <span class="pre">'listen',</span> <span class="pre">'examine',</span> <span class="pre">'l',</span> <span class="pre">'ex',</span> <span class="pre">'feel']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['get',</span> <span class="pre">'ex',</span> <span class="pre">'l',</span> <span class="pre">'feel',</span> <span class="pre">'examine',</span> <span class="pre">'listen']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -473,7 +473,7 @@ be mutually exclusive.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'get</span> <span class="pre">listen</span> <span class="pre">examine</span> <span class="pre">l</span> <span class="pre">ex</span> <span class="pre">feel',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'look',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">get</span> <span class="pre">listen</span> <span class="pre">examine</span> <span class="pre">l</span> <span class="pre">ex</span> <span class="pre">feel',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nLooking</span> <span class="pre">around</span> <span class="pre">in</span> <span class="pre">darkness\n\nUsage:\n</span>&#160; <span class="pre">look</span> <span class="pre">&lt;obj&gt;\n\n...</span> <span class="pre">not</span> <span class="pre">that</span> <span class="pre">there's</span> <span class="pre">much</span> <span class="pre">to</span> <span class="pre">see</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">dark.\n\n&quot;}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'get</span> <span class="pre">ex</span> <span class="pre">l</span> <span class="pre">feel</span> <span class="pre">examine</span> <span class="pre">listen',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'look',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">get</span> <span class="pre">ex</span> <span class="pre">l</span> <span class="pre">feel</span> <span class="pre">examine</span> <span class="pre">listen',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">&quot;\nLooking</span> <span class="pre">around</span> <span class="pre">in</span> <span class="pre">darkness\n\nUsage:\n</span>&#160; <span class="pre">look</span> <span class="pre">&lt;obj&gt;\n\n...</span> <span class="pre">not</span> <span class="pre">that</span> <span class="pre">there's</span> <span class="pre">much</span> <span class="pre">to</span> <span class="pre">see</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">dark.\n\n&quot;}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.red_button.red_button.CmdBlindLook.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

12
docs/latest/api/evennia.contrib.tutorials.tutorial_world.objects.html
View file

@ -504,7 +504,7 @@ shift green root up/down</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['pull',</span> <span class="pre">'move',</span> <span class="pre">'push',</span> <span class="pre">'shiftroot']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['push',</span> <span class="pre">'move',</span> <span class="pre">'shiftroot',</span> <span class="pre">'pull']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -540,7 +540,7 @@ yellow/green - horizontal roots</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'pull</span> <span class="pre">move</span> <span class="pre">push</span> <span class="pre">shiftroot',</span> <span class="pre">'category':</span> <span class="pre">'tutorialworld',</span> <span class="pre">'key':</span> <span class="pre">'shift',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">pull</span> <span class="pre">move</span> <span class="pre">push</span> <span class="pre">shiftroot',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nShifts</span> <span class="pre">roots</span> <span class="pre">around.\n\nUsage:\n</span>&#160; <span class="pre">shift</span> <span class="pre">blue</span> <span class="pre">root</span> <span class="pre">left/right\n</span>&#160; <span class="pre">shift</span> <span class="pre">red</span> <span class="pre">root</span> <span class="pre">left/right\n</span>&#160; <span class="pre">shift</span> <span class="pre">yellow</span> <span class="pre">root</span> <span class="pre">up/down\n</span>&#160; <span class="pre">shift</span> <span class="pre">green</span> <span class="pre">root</span> <span class="pre">up/down\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'push</span> <span class="pre">move</span> <span class="pre">shiftroot</span> <span class="pre">pull',</span> <span class="pre">'category':</span> <span class="pre">'tutorialworld',</span> <span class="pre">'key':</span> <span class="pre">'shift',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">push</span> <span class="pre">move</span> <span class="pre">shiftroot</span> <span class="pre">pull',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nShifts</span> <span class="pre">roots</span> <span class="pre">around.\n\nUsage:\n</span>&#160; <span class="pre">shift</span> <span class="pre">blue</span> <span class="pre">root</span> <span class="pre">left/right\n</span>&#160; <span class="pre">shift</span> <span class="pre">red</span> <span class="pre">root</span> <span class="pre">left/right\n</span>&#160; <span class="pre">shift</span> <span class="pre">yellow</span> <span class="pre">root</span> <span class="pre">up/down\n</span>&#160; <span class="pre">shift</span> <span class="pre">green</span> <span class="pre">root</span> <span class="pre">up/down\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdShiftRoot.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -557,7 +557,7 @@ yellow/green - horizontal roots</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['push</span> <span class="pre">button',</span> <span class="pre">'press</span> <span class="pre">button',</span> <span class="pre">'button']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['press</span> <span class="pre">button',</span> <span class="pre">'button',</span> <span class="pre">'push</span> <span class="pre">button']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -583,7 +583,7 @@ yellow/green - horizontal roots</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'push</span> <span class="pre">button</span> <span class="pre">press</span> <span class="pre">button</span> <span class="pre">button',</span> <span class="pre">'category':</span> <span class="pre">'tutorialworld',</span> <span class="pre">'key':</span> <span class="pre">'press',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">push</span> <span class="pre">button</span> <span class="pre">press</span> <span class="pre">button</span> <span class="pre">button',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPresses</span> <span class="pre">a</span> <span class="pre">button.\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'press</span> <span class="pre">button</span> <span class="pre">button</span> <span class="pre">push</span> <span class="pre">button',</span> <span class="pre">'category':</span> <span class="pre">'tutorialworld',</span> <span class="pre">'key':</span> <span class="pre">'press',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">press</span> <span class="pre">button</span> <span class="pre">button</span> <span class="pre">push</span> <span class="pre">button',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nPresses</span> <span class="pre">a</span> <span class="pre">button.\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdPressButton.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -727,7 +727,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['stab',</span> <span class="pre">'parry',</span> <span class="pre">'bash',</span> <span class="pre">'thrust',</span> <span class="pre">'hit',</span> <span class="pre">'slash',</span> <span class="pre">'kill',</span> <span class="pre">'fight',</span> <span class="pre">'chop',</span> <span class="pre">'pierce',</span> <span class="pre">'defend']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['slash',</span> <span class="pre">'defend',</span> <span class="pre">'pierce',</span> <span class="pre">'kill',</span> <span class="pre">'parry',</span> <span class="pre">'fight',</span> <span class="pre">'hit',</span> <span class="pre">'thrust',</span> <span class="pre">'chop',</span> <span class="pre">'stab',</span> <span class="pre">'bash']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -753,7 +753,7 @@ parry - forgoes your attack but will make you harder to hit on next</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'stab</span> <span class="pre">parry</span> <span class="pre">bash</span> <span class="pre">thrust</span> <span class="pre">hit</span> <span class="pre">slash</span> <span class="pre">kill</span> <span class="pre">fight</span> <span class="pre">chop</span> <span class="pre">pierce</span> <span class="pre">defend',</span> <span class="pre">'category':</span> <span class="pre">'tutorialworld',</span> <span class="pre">'key':</span> <span class="pre">'attack',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">stab</span> <span class="pre">parry</span> <span class="pre">bash</span> <span class="pre">thrust</span> <span class="pre">hit</span> <span class="pre">slash</span> <span class="pre">kill</span> <span class="pre">fight</span> <span class="pre">chop</span> <span class="pre">pierce</span> <span class="pre">defend',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nAttack</span> <span class="pre">the</span> <span class="pre">enemy.</span> <span class="pre">Commands:\n\n</span>&#160; <span class="pre">stab</span> <span class="pre">&lt;enemy&gt;\n</span>&#160; <span class="pre">slash</span> <span class="pre">&lt;enemy&gt;\n</span>&#160; <span class="pre">parry\n\nstab</span> <span class="pre">-</span> <span class="pre">(thrust)</span> <span class="pre">makes</span> <span class="pre">a</span> <span class="pre">lot</span> <span class="pre">of</span> <span class="pre">damage</span> <span class="pre">but</span> <span class="pre">is</span> <span class="pre">harder</span> <span class="pre">to</span> <span class="pre">hit</span> <span class="pre">with.\nslash</span> <span class="pre">-</span> <span class="pre">is</span> <span class="pre">easier</span> <span class="pre">to</span> <span class="pre">land,</span> <span class="pre">but</span> <span class="pre">does</span> <span class="pre">not</span> <span class="pre">make</span> <span class="pre">as</span> <span class="pre">much</span> <span class="pre">damage.\nparry</span> <span class="pre">-</span> <span class="pre">forgoes</span> <span class="pre">your</span> <span class="pre">attack</span> <span class="pre">but</span> <span class="pre">will</span> <span class="pre">make</span> <span class="pre">you</span> <span class="pre">harder</span> <span class="pre">to</span> <span class="pre">hit</span> <span class="pre">on</span> <span class="pre">next\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">enemy</span> <span class="pre">attack.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'slash</span> <span class="pre">defend</span> <span class="pre">pierce</span> <span class="pre">kill</span> <span class="pre">parry</span> <span class="pre">fight</span> <span class="pre">hit</span> <span class="pre">thrust</span> <span class="pre">chop</span> <span class="pre">stab</span> <span class="pre">bash',</span> <span class="pre">'category':</span> <span class="pre">'tutorialworld',</span> <span class="pre">'key':</span> <span class="pre">'attack',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">slash</span> <span class="pre">defend</span> <span class="pre">pierce</span> <span class="pre">kill</span> <span class="pre">parry</span> <span class="pre">fight</span> <span class="pre">hit</span> <span class="pre">thrust</span> <span class="pre">chop</span> <span class="pre">stab</span> <span class="pre">bash',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nAttack</span> <span class="pre">the</span> <span class="pre">enemy.</span> <span class="pre">Commands:\n\n</span>&#160; <span class="pre">stab</span> <span class="pre">&lt;enemy&gt;\n</span>&#160; <span class="pre">slash</span> <span class="pre">&lt;enemy&gt;\n</span>&#160; <span class="pre">parry\n\nstab</span> <span class="pre">-</span> <span class="pre">(thrust)</span> <span class="pre">makes</span> <span class="pre">a</span> <span class="pre">lot</span> <span class="pre">of</span> <span class="pre">damage</span> <span class="pre">but</span> <span class="pre">is</span> <span class="pre">harder</span> <span class="pre">to</span> <span class="pre">hit</span> <span class="pre">with.\nslash</span> <span class="pre">-</span> <span class="pre">is</span> <span class="pre">easier</span> <span class="pre">to</span> <span class="pre">land,</span> <span class="pre">but</span> <span class="pre">does</span> <span class="pre">not</span> <span class="pre">make</span> <span class="pre">as</span> <span class="pre">much</span> <span class="pre">damage.\nparry</span> <span class="pre">-</span> <span class="pre">forgoes</span> <span class="pre">your</span> <span class="pre">attack</span> <span class="pre">but</span> <span class="pre">will</span> <span class="pre">make</span> <span class="pre">you</span> <span class="pre">harder</span> <span class="pre">to</span> <span class="pre">hit</span> <span class="pre">on</span> <span class="pre">next\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">enemy</span> <span class="pre">attack.\n\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.objects.CmdAttack.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.contrib.tutorials.tutorial_world.rooms.html
View file

@ -766,7 +766,7 @@ if they fall off the bridge.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['h',</span> <span class="pre">'?']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['?',</span> <span class="pre">'h']</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -792,7 +792,7 @@ if they fall off the bridge.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'h</span> <span class="pre">?',</span> <span class="pre">'category':</span> <span class="pre">'tutorial</span> <span class="pre">world',</span> <span class="pre">'key':</span> <span class="pre">'help',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">h</span> <span class="pre">?',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nOverwritten</span> <span class="pre">help</span> <span class="pre">command</span> <span class="pre">while</span> <span class="pre">on</span> <span class="pre">the</span> <span class="pre">bridge.\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'?</span> <span class="pre">h',</span> <span class="pre">'category':</span> <span class="pre">'tutorial</span> <span class="pre">world',</span> <span class="pre">'key':</span> <span class="pre">'help',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">?</span> <span class="pre">h',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nOverwritten</span> <span class="pre">help</span> <span class="pre">command</span> <span class="pre">while</span> <span class="pre">on</span> <span class="pre">the</span> <span class="pre">bridge.\n'}</span></em><a class="headerlink" href="#evennia.contrib.tutorials.tutorial_world.rooms.CmdBridgeHelp.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.utils.eveditor.html
View file

@ -290,7 +290,7 @@ indentation.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.utils.eveditor.CmdEditorGroup.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[':y',</span> <span class="pre">':u',</span> <span class="pre">':::',</span> <span class="pre">':fd',</span> <span class="pre">':s',</span> <span class="pre">':dw',</span> <span class="pre">':dd',</span> <span class="pre">':A',</span> <span class="pre">':!',</span> <span class="pre">':f',</span> <span class="pre">':uu',</span> <span class="pre">':h',</span> <span class="pre">':r',</span> <span class="pre">':echo',</span> <span class="pre">':q',</span> <span class="pre">':&gt;',</span> <span class="pre">':DD',</span> <span class="pre">':&lt;',</span> <span class="pre">':i',</span> <span class="pre">':S',</span> <span class="pre">':I',</span> <span class="pre">':UU',</span> <span class="pre">':fi',</span> <span class="pre">'::',</span> <span class="pre">':j',</span> <span class="pre">':q!',</span> <span class="pre">':p',</span> <span class="pre">':=',</span> <span class="pre">':x',</span> <span class="pre">':',</span> <span class="pre">':wq',</span> <span class="pre">':w']</span></em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[':echo',</span> <span class="pre">':I',</span> <span class="pre">':h',</span> <span class="pre">':x',</span> <span class="pre">':r',</span> <span class="pre">':w',</span> <span class="pre">':&lt;',</span> <span class="pre">':fi',</span> <span class="pre">':UU',</span> <span class="pre">':A',</span> <span class="pre">':uu',</span> <span class="pre">':q!',</span> <span class="pre">':wq',</span> <span class="pre">':S',</span> <span class="pre">':s',</span> <span class="pre">':fd',</span> <span class="pre">':p',</span> <span class="pre">':DD',</span> <span class="pre">':q',</span> <span class="pre">':f',</span> <span class="pre">':dd',</span> <span class="pre">':j',</span> <span class="pre">':',</span> <span class="pre">':::',</span> <span class="pre">':=',</span> <span class="pre">':u',</span> <span class="pre">':!',</span> <span class="pre">':dw',</span> <span class="pre">':&gt;',</span> <span class="pre">':y',</span> <span class="pre">':i',</span> <span class="pre">'::']</span></em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -318,7 +318,7 @@ efficient presentation.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.utils.eveditor.CmdEditorGroup.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">':y</span> <span class="pre">:u</span> <span class="pre">:::</span> <span class="pre">:fd</span> <span class="pre">:s</span> <span class="pre">:dw</span> <span class="pre">:dd</span> <span class="pre">:A</span> <span class="pre">:!</span> <span class="pre">:f</span> <span class="pre">:uu</span> <span class="pre">:h</span> <span class="pre">:r</span> <span class="pre">:echo</span> <span class="pre">:q</span> <span class="pre">:&gt;</span> <span class="pre">:DD</span> <span class="pre">:&lt;</span> <span class="pre">:i</span> <span class="pre">:S</span> <span class="pre">:I</span> <span class="pre">:UU</span> <span class="pre">:fi</span> <span class="pre">::</span> <span class="pre">:j</span> <span class="pre">:q!</span> <span class="pre">:p</span> <span class="pre">:=</span> <span class="pre">:x</span> <span class="pre">:</span> <span class="pre">:wq</span> <span class="pre">:w',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">':editor_command_group',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">:y</span> <span class="pre">:u</span> <span class="pre">:::</span> <span class="pre">:fd</span> <span class="pre">:s</span> <span class="pre">:dw</span> <span class="pre">:dd</span> <span class="pre">:A</span> <span class="pre">:!</span> <span class="pre">:f</span> <span class="pre">:uu</span> <span class="pre">:h</span> <span class="pre">:r</span> <span class="pre">:echo</span> <span class="pre">:q</span> <span class="pre">:&gt;</span> <span class="pre">:DD</span> <span class="pre">:&lt;</span> <span class="pre">:i</span> <span class="pre">:S</span> <span class="pre">:I</span> <span class="pre">:UU</span> <span class="pre">:fi</span> <span class="pre">::</span> <span class="pre">:j</span> <span class="pre">:q!</span> <span class="pre">:p</span> <span class="pre">:=</span> <span class="pre">:x</span> <span class="pre">:</span> <span class="pre">:wq</span> <span class="pre">:w',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nCommands</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">editor\n'}</span></em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">':echo</span> <span class="pre">:I</span> <span class="pre">:h</span> <span class="pre">:x</span> <span class="pre">:r</span> <span class="pre">:w</span> <span class="pre">:&lt;</span> <span class="pre">:fi</span> <span class="pre">:UU</span> <span class="pre">:A</span> <span class="pre">:uu</span> <span class="pre">:q!</span> <span class="pre">:wq</span> <span class="pre">:S</span> <span class="pre">:s</span> <span class="pre">:fd</span> <span class="pre">:p</span> <span class="pre">:DD</span> <span class="pre">:q</span> <span class="pre">:f</span> <span class="pre">:dd</span> <span class="pre">:j</span> <span class="pre">:</span> <span class="pre">:::</span> <span class="pre">:=</span> <span class="pre">:u</span> <span class="pre">:!</span> <span class="pre">:dw</span> <span class="pre">:&gt;</span> <span class="pre">:y</span> <span class="pre">:i</span> <span class="pre">::',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">':editor_command_group',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">:echo</span> <span class="pre">:I</span> <span class="pre">:h</span> <span class="pre">:x</span> <span class="pre">:r</span> <span class="pre">:w</span> <span class="pre">:&lt;</span> <span class="pre">:fi</span> <span class="pre">:UU</span> <span class="pre">:A</span> <span class="pre">:uu</span> <span class="pre">:q!</span> <span class="pre">:wq</span> <span class="pre">:S</span> <span class="pre">:s</span> <span class="pre">:fd</span> <span class="pre">:p</span> <span class="pre">:DD</span> <span class="pre">:q</span> <span class="pre">:f</span> <span class="pre">:dd</span> <span class="pre">:j</span> <span class="pre">:</span> <span class="pre">:::</span> <span class="pre">:=</span> <span class="pre">:u</span> <span class="pre">:!</span> <span class="pre">:dw</span> <span class="pre">:&gt;</span> <span class="pre">:y</span> <span class="pre">:i</span> <span class="pre">::',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nCommands</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">editor\n'}</span></em><a class="headerlink" href="#evennia.utils.eveditor.CmdEditorGroup.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.utils.evmenu.html
View file

@ -882,7 +882,7 @@ single question.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.utils.evmenu.CmdYesNoQuestion.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['__nomatch_command',</span> <span class="pre">'a',</span> <span class="pre">'yes',</span> <span class="pre">'abort',</span> <span class="pre">'no',</span> <span class="pre">'y',</span> <span class="pre">'n']</span></em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['yes',</span> <span class="pre">'a',</span> <span class="pre">'y',</span> <span class="pre">'no',</span> <span class="pre">'abort',</span> <span class="pre">'n',</span> <span class="pre">'__nomatch_command']</span></em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -908,7 +908,7 @@ single question.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'__nomatch_command</span> <span class="pre">a</span> <span class="pre">yes</span> <span class="pre">abort</span> <span class="pre">no</span> <span class="pre">y</span> <span class="pre">n',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'__noinput_command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">__nomatch_command</span> <span class="pre">a</span> <span class="pre">yes</span> <span class="pre">abort</span> <span class="pre">no</span> <span class="pre">y</span> <span class="pre">n',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nHandle</span> <span class="pre">a</span> <span class="pre">prompt</span> <span class="pre">for</span> <span class="pre">yes</span> <span class="pre">or</span> <span class="pre">no.</span> <span class="pre">Press</span> <span class="pre">[return]</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">default</span> <span class="pre">choice.\n\n'}</span></em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'yes</span> <span class="pre">a</span> <span class="pre">y</span> <span class="pre">no</span> <span class="pre">abort</span> <span class="pre">n</span> <span class="pre">__nomatch_command',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'__noinput_command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">yes</span> <span class="pre">a</span> <span class="pre">y</span> <span class="pre">no</span> <span class="pre">abort</span> <span class="pre">n</span> <span class="pre">__nomatch_command',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nHandle</span> <span class="pre">a</span> <span class="pre">prompt</span> <span class="pre">for</span> <span class="pre">yes</span> <span class="pre">or</span> <span class="pre">no.</span> <span class="pre">Press</span> <span class="pre">[return]</span> <span class="pre">for</span> <span class="pre">the</span> <span class="pre">default</span> <span class="pre">choice.\n\n'}</span></em><a class="headerlink" href="#evennia.utils.evmenu.CmdYesNoQuestion.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/latest/api/evennia.utils.evmore.html
View file

@ -85,7 +85,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.utils.evmore.CmdMore.aliases">
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['top',</span> <span class="pre">'a',</span> <span class="pre">'quit',</span> <span class="pre">'previous',</span> <span class="pre">'abort',</span> <span class="pre">'p',</span> <span class="pre">'e',</span> <span class="pre">'next',</span> <span class="pre">'t',</span> <span class="pre">'end',</span> <span class="pre">'n',</span> <span class="pre">'q']</span></em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">aliases</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['p',</span> <span class="pre">'a',</span> <span class="pre">'next',</span> <span class="pre">'quit',</span> <span class="pre">'abort',</span> <span class="pre">'t',</span> <span class="pre">'top',</span> <span class="pre">'q',</span> <span class="pre">'n',</span> <span class="pre">'e',</span> <span class="pre">'end',</span> <span class="pre">'previous']</span></em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.aliases" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
@ -111,7 +111,7 @@ the <strong>caller.msg()</strong> construct every time the page is updated.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.utils.evmore.CmdMore.search_index_entry">
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'top</span> <span class="pre">a</span> <span class="pre">quit</span> <span class="pre">previous</span> <span class="pre">abort</span> <span class="pre">p</span> <span class="pre">e</span> <span class="pre">next</span> <span class="pre">t</span> <span class="pre">end</span> <span class="pre">n</span> <span class="pre">q',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'__noinput_command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">top</span> <span class="pre">a</span> <span class="pre">quit</span> <span class="pre">previous</span> <span class="pre">abort</span> <span class="pre">p</span> <span class="pre">e</span> <span class="pre">next</span> <span class="pre">t</span> <span class="pre">end</span> <span class="pre">n</span> <span class="pre">q',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nManipulate</span> <span class="pre">the</span> <span class="pre">text</span> <span class="pre">paging.</span> <span class="pre">Catch</span> <span class="pre">no-input</span> <span class="pre">with</span> <span class="pre">aliases.\n'}</span></em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">search_index_entry</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'aliases':</span> <span class="pre">'p</span> <span class="pre">a</span> <span class="pre">next</span> <span class="pre">quit</span> <span class="pre">abort</span> <span class="pre">t</span> <span class="pre">top</span> <span class="pre">q</span> <span class="pre">n</span> <span class="pre">e</span> <span class="pre">end</span> <span class="pre">previous',</span> <span class="pre">'category':</span> <span class="pre">'general',</span> <span class="pre">'key':</span> <span class="pre">'__noinput_command',</span> <span class="pre">'no_prefix':</span> <span class="pre">'</span> <span class="pre">p</span> <span class="pre">a</span> <span class="pre">next</span> <span class="pre">quit</span> <span class="pre">abort</span> <span class="pre">t</span> <span class="pre">top</span> <span class="pre">q</span> <span class="pre">n</span> <span class="pre">e</span> <span class="pre">end</span> <span class="pre">previous',</span> <span class="pre">'tags':</span> <span class="pre">'',</span> <span class="pre">'text':</span> <span class="pre">'\nManipulate</span> <span class="pre">the</span> <span class="pre">text</span> <span class="pre">paging.</span> <span class="pre">Catch</span> <span class="pre">no-input</span> <span class="pre">with</span> <span class="pre">aliases.\n'}</span></em><a class="headerlink" href="#evennia.utils.evmore.CmdMore.search_index_entry" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>