<spanid="evennia-commands-default-unloggedin"></span><h1>evennia.commands.default.unloggedin<aclass="headerlink"href="#module-evennia.commands.default.unloggedin"title="Permalink to this headline">¶</a></h1>
<p>Commands that are available from the connect screen.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedConnect</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedConnect"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'connect'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['co', 'con', 'conn']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s.*?|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedConnect.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.func"title="Permalink to this definition">¶</a></dt>
<dd><p>Uses the Django admin api. Note that unlogged-in commands
have a unique position in that their func() receives
a session object instead of a source_object like all
other types of logged-in commands (this is because
there is no object yet before the account has logged in)</p>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'co con conn', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect "account name""pass word"\n\n Use the create command to first create an account before logging in.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedCreate</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedCreate"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'create'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['cr', 'cre']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">arg_regex</code><emclass="property"> = re.compile('\\s.*?|$', re.IGNORECASE)</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.arg_regex"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedCreate.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'cr cre', 'category': 'general', 'key': 'create', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create <accountname><password>\n create "account name""pass word"\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedQuit</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedQuit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'quit'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['q', 'qu']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedQuit.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\n quit when in unlogged-in state\n\n Usage:\n quit\n\n We maintain a different version of the quit command\n here for unconnected accounts for the sake of simplicity. The logged in\n version is a bit more complicated.\n '}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedLook</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedLook"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = '__unloggedin_look_command'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['l', 'look']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedLook.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'l look', 'category': 'general', 'key': '__unloggedin_look_command', 'tags': '', 'text': '\n look when in unlogged-in state\n\n Usage:\n look\n\n This is an unconnected version of the look command for simplicity.\n\n This is called by the server and kicks everything in gear.\n All it does is display the connect screen.\n '}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedLook.search_index_entry"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.commands.default.unloggedin.</code><codeclass="sig-name descname">CmdUnconnectedHelp</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedHelp"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">key</code><emclass="property"> = 'help'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.key"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">aliases</code><emclass="property"> = ['h', '?']</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.aliases"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">locks</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.locks"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">func</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/commands/default/unloggedin.html#CmdUnconnectedHelp.func"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.func"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">help_category</code><emclass="property"> = 'general'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.help_category"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">lock_storage</code><emclass="property"> = 'cmd:all()'</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.lock_storage"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">search_index_entry</code><emclass="property"> = {'aliases': 'h ?', 'category': 'general', 'key': 'help', 'tags': '', 'text': '\n get help when in unconnected-in state\n\n Usage:\n help\n\n This is an unconnected version of the help command,\n for simplicity. It shows a pane of info.\n '}</em><aclass="headerlink"href="#evennia.commands.default.unloggedin.CmdUnconnectedHelp.search_index_entry"title="Permalink to this definition">¶</a></dt>
