<spanid="evennia-commands-default-system"></span><h1>evennia.commands.default.system<aclass="headerlink"href="#module-evennia.commands.default.system"title="Link to this heading">¶</a></h1>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdAccounts</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdAccounts"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdAccounts"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@accounts'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAccounts.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">['@account']</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAccounts.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">switch_options</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">('delete',)</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAccounts.switch_options"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(listaccounts)</span><spanclass="pre">or</span><spanclass="pre">perm(Admin)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAccounts.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAccounts.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdAccounts.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdAccounts.func"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(listaccounts)</span><spanclass="pre">or</span><spanclass="pre">perm(Admin)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAccounts.lock_storage"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">search_index_entry</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'aliases':</span><spanclass="pre">'@account',</span><spanclass="pre">'category':</span><spanclass="pre">'system',</span><spanclass="pre">'key':</span><spanclass="pre">'@accounts',</span><spanclass="pre">'no_prefix':</span><spanclass="pre">'accounts</span><spanclass="pre">account',</span><spanclass="pre">'tags':</span><spanclass="pre">'',</span><spanclass="pre">'text':</span><spanclass="pre">'\nManage</span><spanclass="pre">registered</span><spanclass="pre">accounts\n\nUsage:\n</span> <spanclass="pre">accounts</span><spanclass="pre">[nr]\n</span> <spanclass="pre">accounts/delete</span><spanclass="pre"><name</span><spanclass="pre">or</span><spanclass="pre">#id></span><spanclass="pre">[:</span><spanclass="pre">reason]\n\nSwitches:\n</span> <spanclass="pre">delete</span>   <spanclass="pre">-</span><spanclass="pre">delete</span><spanclass="pre">an</span><spanclass="pre">account</span><spanclass="pre">from</span><spanclass="pre">the</span><spanclass="pre">server\n\nBy</span><spanclass="pre">default,</span><spanclass="pre">lists</span><spanclass="pre">statistics</span><spanclass="pre">about</span><spanclass="pre">the</span><spanclass="pre">Accounts</span><spanclass="pre">registered</span><spanclass="pre">with</span><spanclass="pre">the</span><spanclass="pre">game.\nIt</span><spanclass="pre">will</span><spanclass="pre">list</span><spanclass="pre">the</span><spanclass="pre"><nr></span><spanclass="pre">amount</span><spanclass="pre">of</span><spanclass="pre">latest</span><spanclass="pre">registered</span><spanclass="pre">accounts\nIf</span><spanclass="pre">not</span><spanclass="pre">given,</span><spanclass="pre"><nr></span><spanclass="pre">defaults</span><spanclass="pre">to</span><spanclass="pre">10.\n'}</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAccounts.search_index_entry"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdReload</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdReload"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdReload"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@reload'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">['@restart']</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(reload)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdReload.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.func"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(reload)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.lock_storage"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">search_index_entry</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'aliases':</span><spanclass="pre">'@restart',</span><spanclass="pre">'category':</span><spanclass="pre">'system',</span><spanclass="pre">'key':</span><spanclass="pre">'@reload',</span><spanclass="pre">'no_prefix':</span><spanclass="pre">'reload</span><spanclass="pre">restart',</span><spanclass="pre">'tags':</span><spanclass="pre">'',</span><spanclass="pre">'text':</span><spanclass="pre">'\nreload</span><spanclass="pre">the</span><spanclass="pre">server\n\nUsage:\n</span> <spanclass="pre">reload</span><spanclass="pre">[reason]\n\nThis</span><spanclass="pre">restarts</span><spanclass="pre">the</span><spanclass="pre">server.</span><spanclass="pre">The</span><spanclass="pre">Portal</span><spanclass="pre">is</span><spanclass="pre">not\naffected.</span><spanclass="pre">Non-persistent</span><spanclass="pre">scripts</span><spanclass="pre">will</span><spanclass="pre">survive</span><spanclass="pre">a</span><spanclass="pre">reload</span><spanclass="pre">(use\nreset</span><spanclass="pre">to</span><spanclass="pre">purge)</span><spanclass="pre">and</span><spanclass="pre">at_reload()</span><spanclass="pre">hooks</span><spanclass="pre">will</span><spanclass="pre">be</span><spanclass="pre">called.\n'}</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReload.search_index_entry"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdReset</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdReset"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdReset"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@reset'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(reload)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdReset.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.func"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">[]</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(reload)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.lock_storage"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">search_index_entry</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'aliases':</span><spanclass="pre">'',</span><spanclass="pre">'category':</span><spanclass="pre">'system',</span><spanclass="pre">'key':</span><spanclass="pre">'@reset',</span><spanclass="pre">'no_prefix':</span><spanclass="pre">'reset</span><spanclass="pre">',</span><spanclass="pre">'tags':</span><spanclass="pre">'',</span><spanclass="pre">'text':</span><spanclass="pre">'\nreset</span><spanclass="pre">and</span><spanclass="pre">reboot</span><spanclass="pre">the</span><spanclass="pre">server\n\nUsage:\n</span> <spanclass="pre">reset\n\nNotes:\n</span> <spanclass="pre">For</span><spanclass="pre">normal</span><spanclass="pre">updating</span><spanclass="pre">you</span><spanclass="pre">are</span><spanclass="pre">recommended</span><spanclass="pre">to</span><spanclass="pre">use</span><spanclass="pre">reload</span><spanclass="pre">rather\n</span> <spanclass="pre">than</span><spanclass="pre">this</span><spanclass="pre">command.</span><spanclass="pre">Use</span><spanclass="pre">shutdown</span><spanclass="pre">for</span><spanclass="pre">a</span><spanclass="pre">complete</span><spanclass="pre">stop</span><spanclass="pre">of\n</span> <spanclass="pre">everything.\n\nThis</span><spanclass="pre">emulates</span><spanclass="pre">a</span><spanclass="pre">cold</span><spanclass="pre">reboot</span><spanclass="pre">of</span><spanclass="pre">the</span><spanclass="pre">Server</span><spanclass="pre">component</span><spanclass="pre">of</span><spanclass="pre">Evennia.\nThe</span><spanclass="pre">difference</span><spanclass="pre">to</span><spanclass="pre">shutdown</span><spanclass="pre">is</span><spanclass="pre">that</span><spanclass="pre">the</span><spanclass="pre">Server</span><spanclass="pre">will</span><spanclass="pre">auto-reboot\nand</span><spanclass="pre">that</span><spanclass="pre">it</span><spanclass="pre">does</span><spanclass="pre">not</span><spanclass="pre">affect</span><spanclass="pre">the</span><spanclass="pre">Portal,</span><spanclass="pre">so</span><spanclass="pre">no</span><spanclass="pre">users</span><spanclass="pre">will</span><spanclass="pre">be\ndisconnected.</span><spanclass="pre">Contrary</span><spanclass="pre">to</span><spanclass="pre">reload</span><spanclass="pre">however,</span><spanclass="pre">all</span><spanclass="pre">shutdown</span><spanclass="pre">hooks</span><spanclass="pre">will\nbe</span><spanclass="pre">called</span><spanclass="pre">and</span><spanclass="pre">any</span><spanclass="pre">non-database</span><spanclass="pre">saved</span><spanclass="pre">scripts,</span><spanclass="pre">ndb-attributes,\ncmdsets</span><spanclass="pre">etc</span><spanclass="pre">will</span><spanclass="pre">be</span><spanclass="pre">wiped.\n\n'}</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdReset.search_index_entry"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdShutdown</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdShutdown"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@shutdown'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(shutdown)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdShutdown.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.func"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">[]</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(shutdown)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.lock_storage"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">search_index_entry</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'aliases':</span><spanclass="pre">'',</span><spanclass="pre">'category':</span><spanclass="pre">'system',</span><spanclass="pre">'key':</span><spanclass="pre">'@shutdown',</span><spanclass="pre">'no_prefix':</span><spanclass="pre">'shutdown</span><spanclass="pre">',</span><spanclass="pre">'tags':</span><spanclass="pre">'',</span><spanclass="pre">'text':</span><spanclass="pre">'\nstop</span><spanclass="pre">the</span><spanclass="pre">server</span><spanclass="pre">completely\n\nUsage:\n</span> <spanclass="pre">shutdown</span><spanclass="pre">[announcement]\n\nGracefully</span><spanclass="pre">shut</span><spanclass="pre">down</span><spanclass="pre">both</span><spanclass="pre">Server</span><spanclass="pre">and</span><spanclass="pre">Portal.\n'}</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdShutdown.search_index_entry"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdPy</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdPy"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdPy"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@py'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">['@!']</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">switch_options</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">('time',</span><spanclass="pre">'edit',</span><spanclass="pre">'clientraw',</span><spanclass="pre">'noecho')</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.switch_options"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(py)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">arg_regex</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">re.compile('',</span><spanclass="pre">re.IGNORECASE)</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.arg_regex"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdPy.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.func"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(py)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdPy.lock_storage"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdService</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdService"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdService"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@service'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">['@services']</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">switch_options</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">('list',</span><spanclass="pre">'start',</span><spanclass="pre">'stop',</span><spanclass="pre">'delete')</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.switch_options"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(service)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdService.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdService.func"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(service)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.lock_storage"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">search_index_entry</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'aliases':</span><spanclass="pre">'@services',</span><spanclass="pre">'category':</span><spanclass="pre">'system',</span><spanclass="pre">'key':</span><spanclass="pre">'@service',</span><spanclass="pre">'no_prefix':</span><spanclass="pre">'service</span><spanclass="pre">services',</span><spanclass="pre">'tags':</span><spanclass="pre">'',</span><spanclass="pre">'text':</span><spanclass="pre">'\nmanage</span><spanclass="pre">system</span><spanclass="pre">services\n\nUsage:\n</span> <spanclass="pre">service[/switch]</span><spanclass="pre"><service>\n\nSwitches:\n</span> <spanclass="pre">list</span>  <spanclass="pre">-</span><spanclass="pre">shows</span><spanclass="pre">all</span><spanclass="pre">available</span><spanclass="pre">services</span><spanclass="pre">(default)\n</span> <spanclass="pre">start</span> <spanclass="pre">-</span><spanclass="pre">activates</span><spanclass="pre">or</span><spanclass="pre">reactivate</span><spanclass="pre">a</span><spanclass="pre">service\n</span> <spanclass="pre">stop</span>  <spanclass="pre">-</span><spanclass="pre">stops/inactivate</span><spanclass="pre">a</span><spanclass="pre">service</span><spanclass="pre">(can</span><spanclass="pre">often</span><spanclass="pre">be</span><spanclass="pre">restarted)\n</span> <spanclass="pre">delete</span><spanclass="pre">-</span><spanclass="pre">tries</span><spanclass="pre">to</span><spanclass="pre">permanently</span><spanclass="pre">remove</span><spanclass="pre">a</span><spanclass="pre">service\n\nService</span><spanclass="pre">management</span><spanclass="pre">system.</span><spanclass="pre">Allows</span><spanclass="pre">for</span><spanclass="pre">the</span><spanclass="pre">listing,\nstarting,</span><spanclass="pre">and</span><spanclass="pre">stopping</span><spanclass="pre">of</span><spanclass="pre">services.</span><spanclass="pre">If</span><spanclass="pre">no</span><spanclass="pre">switches\nare</span><spanclass="pre">given,</span><spanclass="pre">services</span><spanclass="pre">will</span><spanclass="pre">be</span><spanclass="pre">listed.</span><spanclass="pre">Note</span><spanclass="pre">that</span><spanclass="pre">to</span><spanclass="pre">operate</span><spanclass="pre">on</span><spanclass="pre">the\nservice</span><spanclass="pre">you</span><spanclass="pre">have</span><spanclass="pre">to</span><spanclass="pre">supply</span><spanclass="pre">the</span><spanclass="pre">full</span><spanclass="pre">(green</span><spanclass="pre">or</span><spanclass="pre">red)</span><spanclass="pre">name</span><spanclass="pre">as</span><spanclass="pre">given\nin</span><spanclass="pre">the</span><spanclass="pre">list.\n'}</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdService.search_index_entry"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdAbout</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdAbout"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@about'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">['@version']</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:all()'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdAbout.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.func"title="Link to this definition">¶</a></dt>
<dd><p>Display information about server or target</p>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:all()'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.lock_storage"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">search_index_entry</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'aliases':</span><spanclass="pre">'@version',</span><spanclass="pre">'category':</span><spanclass="pre">'system',</span><spanclass="pre">'key':</span><spanclass="pre">'@about',</span><spanclass="pre">'no_prefix':</span><spanclass="pre">'about</span><spanclass="pre">version',</span><spanclass="pre">'tags':</span><spanclass="pre">'',</span><spanclass="pre">'text':</span><spanclass="pre">'\nshow</span><spanclass="pre">Evennia</span><spanclass="pre">info\n\nUsage:\n</span> <spanclass="pre">about\n\nDisplay</span><spanclass="pre">info</span><spanclass="pre">about</span><spanclass="pre">the</span><spanclass="pre">game</span><spanclass="pre">engine.\n'}</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdAbout.search_index_entry"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdTime</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTime"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTime"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@time'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">['@uptime']</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(time)</span><spanclass="pre">or</span><spanclass="pre">perm(Player)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTime.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.func"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(time)</span><spanclass="pre">or</span><spanclass="pre">perm(Player)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.lock_storage"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">search_index_entry</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'aliases':</span><spanclass="pre">'@uptime',</span><spanclass="pre">'category':</span><spanclass="pre">'system',</span><spanclass="pre">'key':</span><spanclass="pre">'@time',</span><spanclass="pre">'no_prefix':</span><spanclass="pre">'time</span><spanclass="pre">uptime',</span><spanclass="pre">'tags':</span><spanclass="pre">'',</span><spanclass="pre">'text':</span><spanclass="pre">'\nshow</span><spanclass="pre">server</span><spanclass="pre">time</span><spanclass="pre">statistics\n\nUsage:\n</span> <spanclass="pre">time\n\nList</span><spanclass="pre">Server</span><spanclass="pre">time</span><spanclass="pre">statistics</span><spanclass="pre">such</span><spanclass="pre">as</span><spanclass="pre">uptime\nand</span><spanclass="pre">the</span><spanclass="pre">current</span><spanclass="pre">time</span><spanclass="pre">stamp.\n'}</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTime.search_index_entry"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdServerLoad</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdServerLoad"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@server'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">['@serverload']</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">switch_options</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">('mem',</span><spanclass="pre">'flushmem')</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.switch_options"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(list)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdServerLoad.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.func"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(list)</span><spanclass="pre">or</span><spanclass="pre">perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdServerLoad.lock_storage"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdTasks</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTasks"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks"title="Link to this definition">¶</a></dt>
<p>Display or terminate active tasks (delays).</p>
<dlclass="simple">
<dt>Usage:</dt><dd><p>tasks[/switch] [task_id or function_name]</p>
</dd>
<dt>Switches:</dt><dd><p>pause - Pause the callback of a task.
unpause - Process all callbacks made since pause() was called.
do_task - Execute the task (call its callback).
call - Call the callback of this task.
remove - Remove a task without executing it.
cancel - Stop a task from automatically executing.</p>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>A task is a single use method of delaying the call of a function. Calls are created
in code, using <strong>evennia.utils.delay</strong>.
See <ahref="#id11"><spanclass="problematic"id="id12">|</span></a>luhttps://www.evennia.com/docs/latest/Command-Duration.html|ltthe docs|le for help.</p>
<p>By default, tasks that are canceled and never called are cleaned up after one minute.</p>
<pclass="rubric">Examples</p>
<ulclass="simple">
<li><dlclass="simple">
<dt><strong>tasks/cancel move_callback</strong> - Cancels all movement delays from the slow_exit contrib.</dt><dd><p>In this example slow exits creates it’s tasks with
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@tasks'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">['@delays',</span><spanclass="pre">'@task']</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">switch_options</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">('pause',</span><spanclass="pre">'unpause',</span><spanclass="pre">'do_task',</span><spanclass="pre">'call',</span><spanclass="pre">'remove',</span><spanclass="pre">'cancel')</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks.switch_options"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:all();perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks.help_category"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">static</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">coll_date_func</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">task</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTasks.coll_date_func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks.coll_date_func"title="Link to this definition">¶</a></dt>
<dd><p>Replace regex characters in date string and collect deferred function name.</p>
<spanclass="sig-name descname"><spanclass="pre">do_task_action</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTasks.do_task_action"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks.do_task_action"title="Link to this definition">¶</a></dt>
<dd><p>Process the action of a tasks command.</p>
<p>This exists to gain support with yes or no function from EvMenu.</p>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTasks.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks.func"title="Link to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>This is the hook function that actually does all the work. It is called</dt><dd><p>by the cmdhandler right after self.parser() finishes, and so has access
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:all();cmd:perm(Developer)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTasks.lock_storage"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">CmdTickers</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTickers"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTickers"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">key</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'@tickers'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTickers.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">help_category</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'system'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTickers.help_category"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">locks</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(tickers)</span><spanclass="pre">or</span><spanclass="pre">perm(Builder)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTickers.locks"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">func</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#CmdTickers.func"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.CmdTickers.func"title="Link to this definition">¶</a></dt>
<dd><dlclass="simple">
<dt>This is the hook function that actually does all the work. It is called</dt><dd><p>by the cmdhandler right after self.parser() finishes, and so has access
<spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">[]</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTickers.aliases"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">lock_storage</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'cmd:perm(tickers)</span><spanclass="pre">or</span><spanclass="pre">perm(Builder)'</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTickers.lock_storage"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">search_index_entry</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'aliases':</span><spanclass="pre">'',</span><spanclass="pre">'category':</span><spanclass="pre">'system',</span><spanclass="pre">'key':</span><spanclass="pre">'@tickers',</span><spanclass="pre">'no_prefix':</span><spanclass="pre">'tickers</span><spanclass="pre">',</span><spanclass="pre">'tags':</span><spanclass="pre">'',</span><spanclass="pre">'text':</span><spanclass="pre">'\nView</span><spanclass="pre">running</span><spanclass="pre">tickers\n\nUsage:\n</span> <spanclass="pre">tickers\n\nNote:</span><spanclass="pre">Tickers</span><spanclass="pre">are</span><spanclass="pre">created,</span><spanclass="pre">stopped</span><spanclass="pre">and</span><spanclass="pre">manipulated</span><spanclass="pre">in</span><spanclass="pre">Python</span><spanclass="pre">code\nusing</span><spanclass="pre">the</span><spanclass="pre">TickerHandler.</span><spanclass="pre">This</span><spanclass="pre">is</span><spanclass="pre">merely</span><spanclass="pre">a</span><spanclass="pre">convenience</span><spanclass="pre">function</span><spanclass="pre">for\ninspecting</span><spanclass="pre">the</span><spanclass="pre">current</span><spanclass="pre">status.\n\n'}</span></em><aclass="headerlink"href="#evennia.commands.default.system.CmdTickers.search_index_entry"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">AccountDB</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/models.html#AccountDB"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.AccountDB"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">exception</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">DoesNotExist</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.DoesNotExist"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">exception</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">MultipleObjectsReturned</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.MultipleObjectsReturned"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">account_subscription_set</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.account_subscription_set"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">cmdset_storage</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.cmdset_storage"title="Link to this definition">¶</a></dt>
<dd><p>Getter. Allows for value = self.name. Returns a list of cmdset_storage.</p>
<spanclass="sig-name descname"><spanclass="pre">date_joined</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.date_joined"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">db_attributes</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.db_attributes"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<spanclass="sig-name descname"><spanclass="pre">db_cmdset_storage</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.db_cmdset_storage"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">db_date_created</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.db_date_created"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">db_is_bot</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.db_is_bot"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">db_is_connected</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.db_is_connected"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">db_key</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.db_key"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">db_lock_storage</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.db_lock_storage"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">db_tags</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.db_tags"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<spanclass="sig-name descname"><spanclass="pre">db_typeclass_path</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.db_typeclass_path"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">email</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.email"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">first_name</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.first_name"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">get_next_by_date_joined</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">*</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">field=<django.db.models.fields.DateTimeField:</span><spanclass="pre">date_joined></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">is_next=True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">**kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.get_next_by_date_joined"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_next_by_db_date_created</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">*</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">field=<django.db.models.fields.DateTimeField:</span><spanclass="pre">db_date_created></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">is_next=True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">**kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.get_next_by_db_date_created"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_previous_by_date_joined</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">*</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">field=<django.db.models.fields.DateTimeField:</span><spanclass="pre">date_joined></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">is_next=False</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">**kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.get_previous_by_date_joined"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_previous_by_db_date_created</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">*</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">field=<django.db.models.fields.DateTimeField:</span><spanclass="pre">db_date_created></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">is_next=False</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">**kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.get_previous_by_db_date_created"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">groups</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.groups"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<spanclass="sig-name descname"><spanclass="pre">hide_from_accounts_set</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.hide_from_accounts_set"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<spanclass="sig-name descname"><spanclass="pre">id</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.id"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">is_active</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.is_active"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">is_bot</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.is_bot"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <strong>db_is_bot</strong>.</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">is_connected</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.is_connected"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for getting database field <strong>db_is_connected</strong>.</p>
<spanclass="sig-name descname"><spanclass="pre">is_staff</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.is_staff"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">is_superuser</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.is_superuser"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">key</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.key"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">last_login</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.last_login"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">last_name</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.last_name"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">logentry_set</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.logentry_set"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">name</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.name"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">objectdb_set</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.objectdb_set"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<spanclass="sig-name descname"><spanclass="pre">objects</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre"><evennia.accounts.manager.AccountDBManager</span><spanclass="pre">object></span></em><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.objects"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">password</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.password"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-name descname"><spanclass="pre">path</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'evennia.accounts.models.AccountDB'</span></em><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.path"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">receiver_account_set</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.receiver_account_set"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<spanclass="sig-name descname"><spanclass="pre">scriptdb_set</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.scriptdb_set"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<spanclass="sig-name descname"><spanclass="pre">sender_account_set</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.sender_account_set"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<spanclass="sig-name descname"><spanclass="pre">typename</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">'SharedMemoryModelBase'</span></em><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.typename"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">uid</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.uid"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">user_permissions</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.user_permissions"title="Link to this definition">¶</a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<spanclass="sig-name descname"><spanclass="pre">username</span></span><aclass="headerlink"href="#evennia.commands.default.system.AccountDB.username"title="Link to this definition">¶</a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">COMMAND_DEFAULT_CLASS</span></span><aclass="headerlink"href="#evennia.commands.default.system.COMMAND_DEFAULT_CLASS"title="Link to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="evennia.commands.default.muxcommand.html#evennia.commands.default.muxcommand.MuxCommand"title="evennia.commands.default.muxcommand.MuxCommand"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MuxCommand</span></code></a></p>
<spanclass="sig-name descname"><spanclass="pre">decrease_indent</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.decrease_indent"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.decrease_indent"title="Link to this definition">¶</a></dt>
<dd><p>Decrease automatic indentation by 1 level.</p>
<spanclass="sig-name descname"><spanclass="pre">deduce_indent</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">line</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">buffer</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.deduce_indent"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.deduce_indent"title="Link to this definition">¶</a></dt>
<dd><p>Try to deduce the level of indentation of the given line.</p>
<spanclass="sig-name descname"><spanclass="pre">display_buffer</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">buf</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">offset</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">0</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">linenums</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">options</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">{'raw':</span><spanclass="pre">False}</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.display_buffer"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.display_buffer"title="Link to this definition">¶</a></dt>
<dd><p>This displays the line editor buffer, or selected parts of it.</p>
<spanclass="sig-name descname"><spanclass="pre">display_help</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.display_help"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.display_help"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_buffer</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.get_buffer"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.get_buffer"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">increase_indent</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.increase_indent"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.increase_indent"title="Link to this definition">¶</a></dt>
<dd><p>Increase automatic indentation by 1 level.</p>
<spanclass="sig-name descname"><spanclass="pre">load_buffer</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.load_buffer"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.load_buffer"title="Link to this definition">¶</a></dt>
<dd><p>Load the buffer using the load function hook.</p>
<spanclass="sig-name descname"><spanclass="pre">quit</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.quit"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.quit"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">save_buffer</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.save_buffer"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.save_buffer"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">swap_autoindent</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.swap_autoindent"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.swap_autoindent"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">update_buffer</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">buf</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.update_buffer"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.update_buffer"title="Link to this definition">¶</a></dt>
<dd><p>This should be called when the buffer has been changed
somehow. It will handle unsaved flag and undo updating.</p>
<spanclass="sig-name descname"><spanclass="pre">update_undo</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">step</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/eveditor.html#EvEditor.update_undo"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvEditor.update_undo"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">EvTable</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/evtable.html#EvTable"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvTable"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">__init__</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/evtable.html#EvTable.__init__"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvTable.__init__"title="Link to this definition">¶</a></dt>
<li><p><strong>table</strong> (list of lists or list of <strong>EvColumns</strong>, optional) – This is used to build the table in a quick way. If not
given, the table will start out empty and <strong>add_</strong> methods
need to be used to add rows/columns.</p></li>
<li><p><strong>header</strong> (<em>bool</em><em>, </em><em>optional</em>) –<strong>True</strong>/<strong>False</strong> - turn off the
header texts (<strong>*args</strong>) being treated as a header (such as
not adding extra underlining)</p></li>
<li><p><strong>pad_width</strong> (<em>int</em><em>, </em><em>optional</em>) – How much empty space to pad your cells with
(default is 1)</p></li>
<li><p><strong>border</strong> (<em>str</em><em>, </em><em>optional</em><em>)</em>) – The border style to use. This is one of
- <strong>None</strong> - No border drawing at all.
- “table” - only a border around the whole table.
- “tablecols” - table and column borders. (default)
- “header” - only border under header.
- “cols” - only vertical borders.
- “incols” - vertical borders, no outer edges.
- “rows” - only borders between rows.
- “cells” - border around all cells.</p></li>
<li><p><strong>border_width</strong> (<em>int</em><em>, </em><em>optional</em>) – Width of table borders, if border is active.
Note that widths wider than 1 may give artifacts in the corners. Default is 1.</p></li>
<li><p><strong>corner_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character to use in corners when border is active.
Default is <strong>+</strong>.</p></li>
<li><p><strong>corner_top_left_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character used for “nw” corner of table.
Defaults to <strong>corner_char</strong>.</p></li>
<li><p><strong>corner_top_right_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character used for “ne” corner of table.
Defaults to <strong>corner_char</strong>.</p></li>
<li><p><strong>corner_bottom_left_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character used for “sw” corner of table.
Defaults to <strong>corner_char</strong>.</p></li>
<li><p><strong>corner_bottom_right_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character used for “se” corner of table.
Defaults to <strong>corner_char</strong>.</p></li>
<li><p><strong>pretty_corners</strong> (<em>bool</em><em>, </em><em>optional</em>) – Use custom characters to
make the table corners look “rounded”. Uses UTF-8
characters. Defaults to <strong>False</strong> for maximum compatibility with various displays
that may occationally have issues with UTF-8 characters.</p></li>
<li><p><strong>header_line_char</strong> (<em>str</em><em>, </em><em>optional</em>) – Character to use for underlining
the header row (default is ‘~’). Requires <strong>border</strong> to not be <strong>None</strong>.</p></li>
<li><p><strong>width</strong> (<em>int</em><em>, </em><em>optional</em>) – Fixed width of table. If not set,
width is set by the total width of each column. This will
resize individual columns in the vertical direction to fit.</p></li>
<li><p><strong>height</strong> (<em>int</em><em>, </em><em>optional</em>) – Fixed height of table. Defaults to being unset. Width is
still given precedence. If given, table cells will crop text rather
than expand vertically.</p></li>
<li><p><strong>evenwidth</strong> (<em>bool</em><em>, </em><em>optional</em>) – Used with the <strong>width</strong> keyword. Adjusts columns to have as
even width as possible. This often looks best also for mixed-length tables. Default
is <strong>False</strong>.</p></li>
<li><p><strong>maxwidth</strong> (<em>int</em><em>, </em><em>optional</em>) – This will set a maximum width
of the table while allowing it to be smaller. Only if it grows wider than this
size will it be resized by expanding horizontally (or crop <strong>height</strong> is given).
This keyword has no meaning if <strong>width</strong> is set.</p></li>
<spanclass="sig-name descname"><spanclass="pre">add_column</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/evtable.html#EvTable.add_column"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvTable.add_column"title="Link to this definition">¶</a></dt>
<dd><p>Add a column to table. If there are more rows in new column
than there are rows in the current table, the table will
expand with empty rows in the other columns. If too few, the
new column with get new empty rows. All filling rows are added
<spanclass="sig-name descname"><spanclass="pre">add_header</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/evtable.html#EvTable.add_header"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvTable.add_header"title="Link to this definition">¶</a></dt>
<dd><p>Add header to table. This is a number of texts to be put at
the top of the table. They will replace an existing header.</p>
<spanclass="sig-name descname"><spanclass="pre">add_row</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/evtable.html#EvTable.add_row"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvTable.add_row"title="Link to this definition">¶</a></dt>
<dd><p>Add a row to table (not a header). If there are more cells in
the given row than there are cells in the current table the
table will be expanded with empty columns to match. These will
be added to the end of the table. In the same way, adding a
line with too few cells will lead to the last ones getting
<spanclass="sig-name descname"><spanclass="pre">get</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/evtable.html#EvTable.get"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvTable.get"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">reformat</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/evtable.html#EvTable.reformat"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvTable.reformat"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">reformat_column</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">index</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/evtable.html#EvTable.reformat_column"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvTable.reformat_column"title="Link to this definition">¶</a></dt>
<dd><p>Sends custom options to a specific column in the table.</p>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">EvenniaPythonConsole</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#EvenniaPythonConsole"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvenniaPythonConsole"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">__init__</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#EvenniaPythonConsole.__init__"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvenniaPythonConsole.__init__"title="Link to this definition">¶</a></dt>
<dd><p>Constructor.</p>
<p>The optional locals argument will be passed to the
InteractiveInterpreter base class.</p>
<p>The optional filename argument should specify the (file)name
of the input stream; it will show up in tracebacks.</p>
<spanclass="sig-name descname"><spanclass="pre">write</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#EvenniaPythonConsole.write"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvenniaPythonConsole.write"title="Link to this definition">¶</a></dt>
<dd><p>Don’t send to stderr, send to self.caller.</p>
<spanclass="sig-name descname"><spanclass="pre">push</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">line</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#EvenniaPythonConsole.push"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.EvenniaPythonConsole.push"title="Link to this definition">¶</a></dt>
<dd><p>Push some code, whether complete or not.</p>
<emclass="property"><spanclass="k"><spanclass="pre">exception</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">PrintRecursionError</span></span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#PrintRecursionError"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.PrintRecursionError"title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">TaskHandlerTask</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">task_id</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">pause</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.pause"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.pause"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">unpause</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.unpause"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.unpause"title="Link to this definition">¶</a></dt>
<dd><p>Process all callbacks made since pause() was called.</p>
<spanclass="sig-name descname"><spanclass="pre">do_task</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.do_task"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.do_task"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">call</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.call"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.call"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">remove</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.remove"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.remove"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">cancel</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.cancel"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.cancel"title="Link to this definition">¶</a></dt>
<dd><p>Stop a task from automatically executing.</p>
<spanclass="sig-name descname"><spanclass="pre">active</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.active"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.active"title="Link to this definition">¶</a></dt>
<dd><p>Check if a task is active (has not been called yet).</p>
<spanclass="sig-name descname"><spanclass="pre">exists</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.exists"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.exists"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_id</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.get_id"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.get_id"title="Link to this definition">¶</a></dt>
<dd><p>Returns the global id for this task. For use with</p>
<spanclass="sig-name descname"><spanclass="pre">__init__</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">task_id</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.__init__"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.__init__"title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtclass="sig sig-object py"id="id0">
<spanclass="sig-name descname"><spanclass="pre">active</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.active"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#id0"title="Link to this definition">¶</a></dt>
<dd><p>Check if a task is active (has not been called yet).</p>
<dt>True if a task is active (has not been called yet). False if</dt><dd><p>it is not (has been called) or if the task does not exist.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtclass="sig sig-object py"id="id13">
<spanclass="sig-name descname"><spanclass="pre">call</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.call"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#id13"title="Link to this definition">¶</a></dt>
<dd><p>Call the callback of a task.
Leave the task unaffected otherwise.
This does not use the task’s deferred instance.
The only requirement is that the task exist in task handler.</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">called</span></span><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.called"title="Link to this definition">¶</a></dt>
<dd><p>A task attribute to check if the deferred instance of a task has been called.</p>
<p>This exists to mock usage of a twisted deferred object.
It will not set to True if Task.call has been called. This only happens if
<dt>True if the deferred instance of this task has called the callback.</dt><dd><p>False if the deferred instnace of this task has not called the callback.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtclass="sig sig-object py"id="id14">
<spanclass="sig-name descname"><spanclass="pre">cancel</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.cancel"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#id14"title="Link to this definition">¶</a></dt>
<dt>True if the cancel completed successfully.</dt><dd><p>False if the cancel did not complete successfully.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtclass="sig sig-object py"id="id15">
<spanclass="sig-name descname"><spanclass="pre">do_task</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.do_task"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#id15"title="Link to this definition">¶</a></dt>
<dd><p>Execute the task (call its callback).
If calling before timedelay, cancel the deferred instance affliated to this task.
Remove the task from the dictionary of current tasks on a successful
<ddclass="field-odd"><p><em>bool or any</em>– Set to <strong>False</strong> if the task does not exist in task
handler. Otherwise it will be the return of the task’s callback.</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtclass="sig sig-object py"id="id16">
<spanclass="sig-name descname"><spanclass="pre">exists</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.exists"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#id16"title="Link to this definition">¶</a></dt>
<dd><p>Check if a task exists.
Most task handler methods check for existence for you.</p>
<spanclass="sig-name descname"><spanclass="pre">get_deferred</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.get_deferred"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.get_deferred"title="Link to this definition">¶</a></dt>
<dd><p>Return the instance of the deferred the task id is using.</p>
<ddclass="field-odd"><p><p><em>bool or deferred</em>–</p>
<dlclass="simple">
<dt>An instance of a deferred or False if there is no task with the id.</dt><dd><p>None is returned if there is no deferred affiliated with this id.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtclass="sig sig-object py"id="id17">
<spanclass="sig-name descname"><spanclass="pre">get_id</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.get_id"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#id17"title="Link to this definition">¶</a></dt>
<dd><p>Returns the global id for this task. For use with
<ddclass="field-odd"><p><em>task_id (int)</em>– global task id for this task.</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtclass="sig sig-object py"id="id18">
<spanclass="sig-name descname"><spanclass="pre">pause</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.pause"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#id18"title="Link to this definition">¶</a></dt>
<dd><p>Pause the callback of a task.
To resume use <strong>TaskHandlerTask.unpause</strong>.</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">paused</span></span><aclass="headerlink"href="#evennia.commands.default.system.TaskHandlerTask.paused"title="Link to this definition">¶</a></dt>
<dd><p>A task attribute to check if the deferred instance of a task has been paused.</p>
<p>This exists to mock usage of a twisted deferred object.</p>
<ddclass="field-odd"><p><p><em>bool or None</em>–</p>
<dlclass="simple">
<dt>True if the task was properly paused. None if the task does not have</dt><dd><p>a deferred instance.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtclass="sig sig-object py"id="id19">
<spanclass="sig-name descname"><spanclass="pre">remove</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.remove"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#id19"title="Link to this definition">¶</a></dt>
<ddclass="field-even"><p><em>bool</em>– True if the removal completed successfully.</p>
</dd>
</dl>
</dd></dl>
<dlclass="py method">
<dtclass="sig sig-object py"id="id20">
<spanclass="sig-name descname"><spanclass="pre">unpause</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/scripts/taskhandler.html#TaskHandlerTask.unpause"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#id20"title="Link to this definition">¶</a></dt>
<dd><p>Unpause a task, run the task if it has passed delay time.</p>
<li><p><strong>caller</strong> (<em>Object</em>) – The entity being asked.</p></li>
<li><p><strong>prompt</strong> (<em>str</em>) – The yes/no question to ask. This takes an optional formatting
marker <strong>{options}</strong> which will be filled with ‘Y/N’, ‘[Y]/N’ or
‘Y/[N]’ depending on the setting of <strong>default</strong>. If <strong>allow_abort</strong> is set,
then the ‘A(bort)’ option will also be available.</p></li>
<li><p><strong>yes_action</strong> (<em>callable</em><em> or </em><em>str</em>) – If a callable, this will be called
with <strong>(caller, *args, **kwargs)</strong> when the Yes-choice is made.
If a string, this string will be echoed back to the caller.</p></li>
<li><p><strong>no_action</strong> (<em>callable</em><em> or </em><em>str</em>) – If a callable, this will be called
with <strong>(caller, *args, **kwargs)</strong> when the No-choice is made.
If a string, this string will be echoed back to the caller.</p></li>
<li><p><strong>default</strong> (<em>str optional</em>) – This is what the user will get if they just press the
return key without giving any input. One of ‘N’, ‘Y’, ‘A’ or <strong>None</strong>
for no default (an explicit choice must be given). If ‘A’ (abort)
is given, <strong>allow_abort</strong> kwarg is ignored and assumed set.</p></li>
<li><p><strong>allow_abort</strong> (<em>bool</em><em>, </em><em>optional</em>) – If set, the ‘A(bort)’ option is available
(a third option meaning neither yes or no but just exits the prompt).</p></li>
<li><p><strong>session</strong> (<aclass="reference internal"href="evennia.server.session.html#evennia.server.session.Session"title="evennia.server.session.Session"><em>Session</em></a><em>, </em><em>optional</em>) – This allows to specify the
session to send the prompt to. It’s usually only needed if <strong>caller</strong>
is an Account in multisession modes greater than 2. The session is
then updated by the command and is available (for example in
callbacks) through <strong>caller.ndb._yes_no_question.session</strong>.</p></li>
<li><p><strong>*args</strong>– Additional arguments passed on into callables.</p></li>
<li><p><strong>**kwargs</strong>– Additional keyword args passed on into callables.</p></li>
<ddclass="field-even"><p><strong>RuntimeError</strong><strong>, </strong><strong>FooError</strong>– If default and <strong>allow_abort</strong> clashes.</p>
</dd>
</dl>
<pclass="rubric">Example</p>
<divclass="highlight-default notranslate"><divclass="highlight"><pre><span></span><spanclass="c1"># just returning strings</span>
<spanclass="n">ask_yes_no</span><spanclass="p">(</span><spanclass="n">caller</span><spanclass="p">,</span><spanclass="s2">"Are you happy </span><spanclass="si">{options}</span><spanclass="s2">?"</span><spanclass="p">,</span>
<spanclass="n">ask_yes_no</span><spanclass="p">(</span><spanclass="n">caller</span><spanclass="p">,</span><spanclass="s2">"Are you sad </span><spanclass="si">{options}</span><spanclass="s2">?"</span><spanclass="p">,</span>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">class_from_module</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">path</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">defaultpaths</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">fallback</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/utils.html#class_from_module"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.class_from_module"title="Link to this definition">¶</a></dt>
<dd><p>Return a class from a module, given the class’ full python path. This is
primarily used to convert db_typeclass_path:s to classes.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">evennia_local_vars</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">caller</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/system.html#evennia_local_vars"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.evennia_local_vars"title="Link to this definition">¶</a></dt>
<dd><p>Return Evennia local variables usable in the py command as a dictionary.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">evennia.commands.default.system.</span></span><spanclass="sig-name descname"><spanclass="pre">iter_to_str</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">iterable</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">sep</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">','</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">endsep</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">',</span><spanclass="pre">and'</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">addquote</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">False</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/utils/utils.html#iter_to_str"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#evennia.commands.default.system.iter_to_str"title="Link to this definition">¶</a></dt>
<dd><p>This pretty-formats an iterable list as string output, adding an optional
alternative separator to the second to last entry. If <strong>addquote</strong>
is <strong>True</strong>, the outgoing strings will be surrounded by quotes.</p>
