Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-02 22:17:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-10-13 00:23:58 +02:00
parent 7a765cf108
commit dc00b6bf65
278 changed files with 2426 additions and 1087 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/0.9.5/.buildinfo
View file

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7e3e18bbc03756854a014e3852a3143a
config: e258de0a9ea5aae1e053fbbac19ad3c4
tags: 645f666f9bcd5a90fca523b33c5a78b7

22
docs/0.9.5/_modules/evennia/accounts/accounts.html
View file

@ -449,7 +449,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks if a given username or IP is banned.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> ip (str, optional): IP address.</span>
<span class="sd"> username (str, optional): Username.</span>
@ -520,7 +520,7 @@
<span class="sd"> password (str): Password of account</span>
<span class="sd"> ip (str, optional): IP address of client</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> session (Session, optional): Session requesting authentication</span>
<span class="sd"> Returns:</span>
@ -650,7 +650,7 @@
<span class="sd"> Args:</span>
<span class="sd"> password (str): Password to validate</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> account (DefaultAccount, optional): Account object to validate the</span>
<span class="sd"> password for. Optional, but Django includes some validators to</span>
<span class="sd"> do things like making sure users aren&#39;t setting passwords to the</span>
@ -744,7 +744,7 @@
<span class="sd"> with default (or overridden) permissions and having joined them to the</span>
<span class="sd"> appropriate default channels.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> username (str): Username of Account owner</span>
<span class="sd"> password (str): Password of Account owner</span>
<span class="sd"> email (str, optional): Email address of Account owner</span>
@ -911,7 +911,7 @@
<span class="sd"> default send behavior for the current</span>
<span class="sd"> MULTISESSION_MODE.</span>
<span class="sd"> options (list): Protocol-specific options. Passed on to the protocol.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> any (dict): All other keywords are passed on to the protocol.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -959,7 +959,7 @@
<span class="sd"> session (Session, optional): The session to be responsible</span>
<span class="sd"> for the command-send</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Other keyword arguments will be added to the</span>
<span class="sd"> found command object instance as variables before it</span>
<span class="sd"> executes. This is unused by default Evennia but may be</span>
@ -1075,7 +1075,7 @@
<span class="sd"> no_superuser_bypass (bool, optional): Turn off superuser</span>
<span class="sd"> lock bypassing. Be careful with this one.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Passed to the at_access hook along with the result.</span>
<span class="sd"> Returns:</span>
@ -1219,7 +1219,7 @@
<span class="sd"> check.</span>
<span class="sd"> access_type (str): The type of access checked.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): These are passed on from the access check</span>
<span class="sd"> and can be used to relay custom instructions from the</span>
<span class="sd"> check mechanism.</span>
@ -1424,7 +1424,7 @@
<span class="sd"> text (str, optional): The message received.</span>
<span class="sd"> from_obj (any, optional): The object sending the message.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> This includes any keywords sent to the `msg` method.</span>
<span class="sd"> Returns:</span>
@ -1446,7 +1446,7 @@
<span class="sd"> text (str, optional): Text to send.</span>
<span class="sd"> to_obj (any, optional): The object to send to.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Keywords passed from msg()</span>
<span class="sd"> Notes:</span>
@ -1605,7 +1605,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets or creates a Guest account object.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> ip (str, optional): IP address of requestor; used for ban checking,</span>
<span class="sd"> throttling and logging</span>

6
docs/0.9.5/_modules/evennia/accounts/bots.html
View file

@ -317,7 +317,7 @@
<span class="sd"> Args:</span>
<span class="sd"> text (str, optional): Incoming text from channel.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> options (dict): Options dict with the following allowed keys:</span>
<span class="sd"> - from_channel (str): dbid of a channel this text originated from.</span>
<span class="sd"> - from_obj (list): list of objects sending this text.</span>
@ -347,7 +347,7 @@
<span class="sd"> session (Session, optional): Session responsible for this</span>
<span class="sd"> command. Note that this is the bot.</span>
<span class="sd"> txt (str, optional): Command string.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> user (str): The name of the user who sent the message.</span>
<span class="sd"> channel (str): The name of channel the message was sent to.</span>
<span class="sd"> type (str): Nature of message. Either &#39;msg&#39;, &#39;action&#39;, &#39;nicklist&#39;</span>
@ -557,7 +557,7 @@
<span class="sd"> Args:</span>
<span class="sd"> text (str, optional): Incoming text from channel.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> options (dict): Options dict with the following allowed keys:</span>
<span class="sd"> - from_channel (str): dbid of a channel this text originated from.</span>
<span class="sd"> - from_obj (list): list of objects sending this text.</span>

2
docs/0.9.5/_modules/evennia/commands/cmdhandler.html
View file

@ -592,7 +592,7 @@
<span class="sd"> is made available as `self.cmdstring` when the Command runs.</span>
<span class="sd"> If not given, the command will be assumed to be called as `cmdobj.key`.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): other keyword arguments will be assigned as named variables on the</span>
<span class="sd"> retrieved command object *before* it is executed. This is unused</span>
<span class="sd"> in default Evennia but may be used by code to set custom flags or</span>

8
docs/0.9.5/_modules/evennia/commands/command.html
View file

@ -391,7 +391,7 @@
<span class="sd"> session (Session, optional): Supply data only to a unique</span>
<span class="sd"> session (ignores the value of `self.msg_all_sessions`).</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> options (dict): Options to the protocol.</span>
<span class="sd"> any (any): All other keywords are interpreted as th</span>
<span class="sd"> name of send-instructions.</span>
@ -417,7 +417,7 @@
<span class="sd"> obj (Object or Account, optional): Object or Account on which to call the execute_cmd.</span>
<span class="sd"> If not given, self.caller will be used.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Other keyword arguments will be added to the found command</span>
<span class="sd"> object instace as variables before it executes. This is</span>
<span class="sd"> unused by default Evennia but may be used to set flags and</span>
@ -565,7 +565,7 @@
<span class="sd"> Args:</span>
<span class="sd"> *args (str): Column headers. If not colored explicitly, these will get colors</span>
<span class="sd"> from user options.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> any (str, int or dict): EvTable options, including, optionally a `table` dict</span>
<span class="sd"> detailing the contents of the table.</span>
<span class="sd"> Returns:</span>
@ -618,7 +618,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Helper for formatting a string into a pretty display, for a header, separator or footer.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> header_text (str): Text to include in header.</span>
<span class="sd"> fill_character (str): This single character will be used to fill the width of the</span>
<span class="sd"> display.</span>

2
docs/0.9.5/_modules/evennia/comms/comms.html
View file

@ -294,7 +294,7 @@
<span class="sd"> key (str): This must be unique.</span>
<span class="sd"> account (Account): Account to attribute this object to.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> aliases (list of str): List of alternative (likely shorter) keynames.</span>
<span class="sd"> description (str): A description of the channel, for use in listings.</span>
<span class="sd"> locks (str): Lockstring.</span>

2
docs/0.9.5/_modules/evennia/contrib/building_menu.html
View file

@ -214,7 +214,7 @@
<span class="sd"> Args:</span>
<span class="sd"> value (any): the value to obtain. It might be a callable (see note).</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> menu (BuildingMenu, optional): the building menu to pass to value</span>
<span class="sd"> if it is a callable.</span>
<span class="sd"> choice (Choice, optional): the choice to pass to value if a callable.</span>

6
docs/0.9.5/_modules/evennia/contrib/clothing.html
View file

@ -199,7 +199,7 @@
<span class="sd"> Args:</span>
<span class="sd"> character (obj): The character to get a list of worn clothes from.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> exclude_covered (bool): If True, excludes clothes covered by other</span>
<span class="sd"> clothing from the returned list.</span>
@ -276,7 +276,7 @@
<span class="sd"> wearer (obj): character object wearing this clothing object</span>
<span class="sd"> wearstyle (True or str): string describing the style of wear or True for none</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> quiet (bool): If false, does not message the room</span>
<span class="sd"> Notes:</span>
@ -315,7 +315,7 @@
<span class="sd"> Args:</span>
<span class="sd"> wearer (obj): character object wearing this clothing object</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> quiet (bool): If false, does not message the room</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">worn</span> <span class="o">=</span> <span class="kc">False</span>

4
docs/0.9.5/_modules/evennia/contrib/custom_gametime.html
View file

@ -134,7 +134,7 @@
<span class="sd"> in-game, you will be able to find the number of real-world seconds this</span>
<span class="sd"> corresponds to (hint: Interval events deal with real life seconds).</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> format (bool): Formatting the output.</span>
<span class="sd"> days, month etc (int): These are the names of time units that must</span>
<span class="sd"> match the `settings.TIME_UNITS` dict keys.</span>
@ -170,7 +170,7 @@
<span class="sd"> interval would correspond to. This is usually a lot less</span>
<span class="sd"> interesting than the other way around.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> times (int): The various components of the time.</span>
<span class="sd"> format (bool): Formatting the output.</span>

2
docs/0.9.5/_modules/evennia/contrib/ingame_python/callbackhandler.html
View file

@ -194,7 +194,7 @@
<span class="sd"> callback_name (str): the callback name to call.</span>
<span class="sd"> *args: additional variables for this callback.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> number (int, optional): call just a specific callback.</span>
<span class="sd"> parameters (str, optional): call a callback with parameters.</span>
<span class="sd"> locals (dict, optional): a locals replacement.</span>

2
docs/0.9.5/_modules/evennia/contrib/ingame_python/eventfuncs.html
View file

@ -67,7 +67,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return an object with the given search option or None if None is found.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Any searchable data or property (id, db_key, db_location...).</span>
<span class="sd"> Returns:</span>

2
docs/0.9.5/_modules/evennia/contrib/ingame_python/scripts.html
View file

@ -436,7 +436,7 @@
<span class="sd"> callback_name (str): the callback name to call.</span>
<span class="sd"> *args: additional variables for this callback.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> number (int, optional): call just a specific callback.</span>
<span class="sd"> parameters (str, optional): call a callback with parameters.</span>
<span class="sd"> locals (dict, optional): a locals replacement.</span>

4
docs/0.9.5/_modules/evennia/contrib/ingame_python/typeclasses.html
View file

@ -460,7 +460,7 @@
<span class="sd"> Args:</span>
<span class="sd"> message (str): The suggested say/whisper text spoken by self.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> whisper (bool): If True, this is a whisper rather than</span>
<span class="sd"> a say. This is sent by the whisper command by default.</span>
<span class="sd"> Other verbal commands could use this hook in similar</span>
@ -516,7 +516,7 @@
<span class="sd"> (by default only used by whispers).</span>
<span class="sd"> msg_receiver(str, optional): Specific message for receiver only.</span>
<span class="sd"> mapping (dict, optional): Additional mapping in messages.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> whisper (bool): If this is a whisper rather than a say. Kwargs</span>
<span class="sd"> can be used by other verbal commands in a similar way.</span>

6
docs/0.9.5/_modules/evennia/contrib/rpsystem.html
View file

@ -1460,7 +1460,7 @@
<span class="sd"> looker (TypedObject): The object or account that is looking</span>
<span class="sd"> at/getting inforamtion for this object.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> pose (bool): Include the pose (if available) in the return.</span>
<span class="sd"> Returns:</span>
@ -1548,7 +1548,7 @@
<span class="sd"> looker (TypedObject): The object or account that is looking</span>
<span class="sd"> at/getting inforamtion for this object.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> pose (bool): Include the pose (if available) in the return.</span>
<span class="sd"> Returns:</span>
@ -1597,7 +1597,7 @@
<span class="sd"> Args:</span>
<span class="sd"> message (str): The suggested say/whisper text spoken by self.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> whisper (bool): If True, this is a whisper rather than a say.</span>
<span class="sd"> &quot;&quot;&quot;</span>

6
docs/0.9.5/_modules/evennia/contrib/security/auditing/server.html
View file

@ -109,7 +109,7 @@
<span class="sd"> Extracts messages and system data from a Session object upon message</span>
<span class="sd"> send or receive.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> src (str): Source of data; &#39;client&#39; or &#39;server&#39;. Indicates direction.</span>
<span class="sd"> text (str or list): Client sends messages to server in the form of</span>
<span class="sd"> lists. Server sends messages to client as string.</span>
@ -255,7 +255,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Generic hook for sending data out through the protocol.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Other data to the protocol.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -273,7 +273,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Hook for protocols to send incoming data to the engine.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Other data from the protocol.</span>
<span class="sd"> &quot;&quot;&quot;</span>

2
docs/0.9.5/_modules/evennia/contrib/turnbattle/tb_basic.html
View file

@ -318,7 +318,7 @@
<span class="sd"> character (obj): Character spending the action</span>
<span class="sd"> actions (int) or &#39;all&#39;: Number of actions to spend, or &#39;all&#39; to spend all actions</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> action_name (str or None): If a string is given, sets character&#39;s last action in</span>
<span class="sd"> combat to provided string</span>
<span class="sd"> &quot;&quot;&quot;</span>

2
docs/0.9.5/_modules/evennia/contrib/turnbattle/tb_equip.html
View file

@ -369,7 +369,7 @@
<span class="sd"> character (obj): Character spending the action</span>
<span class="sd"> actions (int) or &#39;all&#39;: Number of actions to spend, or &#39;all&#39; to spend all actions</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> action_name (str or None): If a string is given, sets character&#39;s last action in</span>
<span class="sd"> combat to provided string</span>
<span class="sd"> &quot;&quot;&quot;</span>

2
docs/0.9.5/_modules/evennia/contrib/turnbattle/tb_items.html
View file

@ -387,7 +387,7 @@
<span class="sd"> character (obj): Character spending the action</span>
<span class="sd"> actions (int) or &#39;all&#39;: Number of actions to spend, or &#39;all&#39; to spend all actions</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> action_name (str or None): If a string is given, sets character&#39;s last action in</span>
<span class="sd"> combat to provided string</span>
<span class="sd"> &quot;&quot;&quot;</span>

2
docs/0.9.5/_modules/evennia/contrib/turnbattle/tb_magic.html
View file

@ -343,7 +343,7 @@
<span class="sd"> character (obj): Character spending the action</span>
<span class="sd"> actions (int) or &#39;all&#39;: Number of actions to spend, or &#39;all&#39; to spend all actions</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> action_name (str or None): If a string is given, sets character&#39;s last action in</span>
<span class="sd"> combat to provided string</span>
<span class="sd"> &quot;&quot;&quot;</span>

4
docs/0.9.5/_modules/evennia/contrib/turnbattle/tb_range.html
View file

@ -509,7 +509,7 @@
<span class="sd"> character (obj): Character spending the action</span>
<span class="sd"> actions (int) or &#39;all&#39;: Number of actions to spend, or &#39;all&#39; to spend all actions</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> action_name (str or None): If a string is given, sets character&#39;s last action in</span>
<span class="sd"> combat to provided string</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -681,7 +681,7 @@
<span class="sd"> Args:</span>
<span class="sd"> to_init (object): Object to initialize range field for.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> anchor_obj (object): Object to copy range values from, or None for a random object.</span>
<span class="sd"> add_distance (int): Distance to put between to_init object and anchor object.</span>

2
docs/0.9.5/_modules/evennia/contrib/unixcommand.html
View file

@ -137,7 +137,7 @@
<span class="sd"> epilog (str): the epilog to show below options.</span>
<span class="sd"> command (Command): the command calling the parser.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Additional keyword arguments are directly sent to</span>
<span class="sd"> `argparse.ArgumentParser`. You will find them on the</span>
<span class="sd"> [parser&#39;s documentation](https://docs.python.org/2/library/argparse.html).</span>

2
docs/0.9.5/_modules/evennia/locks/lockfuncs.html
View file

@ -594,6 +594,8 @@
<span class="sd"> want also nested objects to pass the lock, use the `insiderecursive`</span>
<span class="sd"> lockfunc.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">accessed_obj</span><span class="p">,</span> <span class="s2">&quot;obj&quot;</span><span class="p">):</span>
<span class="n">accessed_obj</span> <span class="o">=</span> <span class="n">accessed_obj</span><span class="o">.</span><span class="n">obj</span>
<span class="k">return</span> <span class="n">accessing_obj</span><span class="o">.</span><span class="n">location</span> <span class="o">==</span> <span class="n">accessed_obj</span></div>

36
docs/0.9.5/_modules/evennia/objects/objects.html
View file

@ -376,7 +376,7 @@
<span class="sd"> Args:</span>
<span class="sd"> count (int): Number of objects of this type</span>
<span class="sd"> looker (Object): Onlooker. Not used by default.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> key (str): Optional key to pluralize, if given, use this instead of the object&#39;s key.</span>
<span class="sd"> Returns:</span>
<span class="sd"> singular (str): The singular form to display.</span>
@ -629,7 +629,7 @@
<span class="sd"> session (Session, optional): Session to</span>
<span class="sd"> return results to</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Other keyword arguments will be added to the found command</span>
<span class="sd"> object instace as variables before it executes. This is</span>
<span class="sd"> unused by default Evennia but may be used to set flags and</span>
@ -675,7 +675,7 @@
<span class="sd"> depends on the MULTISESSION_MODE.</span>
<span class="sd"> options (dict, optional): Message-specific option-value</span>
<span class="sd"> pairs. These will be applied at the protocol level.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> any (string or tuples): All kwarg keys not listed above</span>
<span class="sd"> will be treated as send-command names and their arguments</span>
<span class="sd"> (which can be a string or a tuple).</span>
@ -726,7 +726,7 @@
<span class="sd"> exclude (list, optional): A list of object not to call the</span>
<span class="sd"> function on.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Keyword arguments will be passed to the function for all objects.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">contents</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">contents</span>
@ -758,7 +758,7 @@
<span class="sd"> for every looker in contents that receives the</span>
<span class="sd"> message. This allows for every object to potentially</span>
<span class="sd"> get its own customized string.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Keyword arguments will be passed on to `obj.msg()` for all</span>
<span class="sd"> messaged objects.</span>
@ -833,7 +833,7 @@
<span class="sd"> (at_before/after_move etc) with quiet=True, this is as quiet a move</span>
<span class="sd"> as can be done.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Passed on to announce_move_to and announce_move_from hooks.</span>
<span class="sd"> Returns:</span>
@ -1007,7 +1007,7 @@
<span class="sd"> key (str): Name of the new object.</span>
<span class="sd"> account (Account): Account to attribute this object to.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> description (str): Brief description for this object.</span>
<span class="sd"> ip (str): IP address of creator (for object auditing).</span>
@ -1173,7 +1173,7 @@
<span class="sd"> no_superuser_bypass (bool, optional): If `True`, don&#39;t skip</span>
<span class="sd"> lock check for superuser (be careful with this one).</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Passed on to the at_access hook along with the result of the access check.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -1332,7 +1332,7 @@
<span class="sd"> place to do it. This is called also if the object currently</span>
<span class="sd"> have no cmdsets.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> caller (Session, Object or Account): The caller requesting</span>
<span class="sd"> this cmdset.</span>
@ -1434,7 +1434,7 @@
<span class="sd"> accessing_obj (Object or Account): The entity trying to gain access.</span>
<span class="sd"> access_type (str): The type of access that was requested.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Not used by default, added for possible expandability in a</span>
<span class="sd"> game.</span>
@ -1685,7 +1685,7 @@
<span class="sd"> text (str, optional): The message received.</span>
<span class="sd"> from_obj (any, optional): The object sending the message.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> This includes any keywords sent to the `msg` method.</span>
<span class="sd"> Returns:</span>
@ -1707,7 +1707,7 @@
<span class="sd"> text (str, optional): Text to send.</span>
<span class="sd"> to_obj (any, optional): The object to send to.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Keywords passed from msg()</span>
<span class="sd"> Notes:</span>
@ -1949,7 +1949,7 @@
<span class="sd"> Args:</span>
<span class="sd"> message (str): The suggested say/whisper text spoken by self.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> whisper (bool): If True, this is a whisper rather than</span>
<span class="sd"> a say. This is sent by the whisper command by default.</span>
<span class="sd"> Other verbal commands could use this hook in similar</span>
@ -1989,7 +1989,7 @@
<span class="sd"> (by default only used by whispers).</span>
<span class="sd"> msg_receivers(str): Specific message to pass to the receiver(s). This will parsed</span>
<span class="sd"> with the {receiver} placeholder replaced with the given receiver.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> whisper (bool): If this is a whisper rather than a say. Kwargs</span>
<span class="sd"> can be used by other verbal commands in a similar way.</span>
<span class="sd"> mapping (dict): Pass an additional mapping to the message.</span>
@ -2131,7 +2131,7 @@
<span class="sd"> If unset supplying None-- it will</span>
<span class="sd"> change the default lockset and skip creator attribution.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> description (str): Brief description for this object.</span>
<span class="sd"> ip (str): IP address of creator (for object auditing).</span>
<span class="sd"> All other kwargs will be passed into the create_object call.</span>
@ -2391,7 +2391,7 @@
<span class="sd"> given, it will be given specific control/edit permissions to this</span>
<span class="sd"> object (along with normal Admin perms). If not given, default</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> description (str): Brief description for this object.</span>
<span class="sd"> ip (str): IP address of creator (for object auditing).</span>
@ -2595,7 +2595,7 @@
<span class="sd"> source (Room): The room to create this exit in.</span>
<span class="sd"> dest (Room): The room to which this exit should go.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> description (str): Brief description for this object.</span>
<span class="sd"> ip (str): IP address of creator (for object auditing).</span>
@ -2687,7 +2687,7 @@
<span class="sd"> place to do it. This is called also if the object currently</span>
<span class="sd"> has no cmdsets.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> force_init (bool): If `True`, force a re-build of the cmdset</span>
<span class="sd"> (for example to update aliases).</span>

12
docs/0.9.5/_modules/evennia/prototypes/menus.html
View file

@ -169,7 +169,7 @@
<span class="sd"> caller (Object, Account): The user of the wizard.</span>
<span class="sd"> raw_string (str): Input from user on given node - the new value to set.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> test_parse (bool): If set (default True), parse raw_string for protfuncs and obj-refs and</span>
<span class="sd"> try to run result through literal_eval. The parser will be run in &#39;testing&#39; mode and any</span>
<span class="sd"> parsing errors will shown to the user. Note that this is just for testing, the original</span>
@ -336,7 +336,7 @@
<span class="sd"> Args:</span>
<span class="sd"> actions (str): Available actions. The first letter of the action name will be assumed</span>
<span class="sd"> to be a shortcut.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> prefix (str): Default prefix to use.</span>
<span class="sd"> Returns:</span>
<span class="sd"> string (str): Formatted footer for adding to the node text.</span>
@ -1214,7 +1214,7 @@
<span class="sd"> attr = value</span>
<span class="sd"> attr;category = value</span>
<span class="sd"> attr;category;lockstring = value</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> delete (str): If this is set, attr_string is</span>
<span class="sd"> considered the name of the attribute to delete and</span>
<span class="sd"> no further parsing happens.</span>
@ -1401,7 +1401,7 @@
<span class="sd"> tagname;category</span>
<span class="sd"> tagname;category;data</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> delete (str): If this is set, tag_string is considered</span>
<span class="sd"> the name of the tag to delete.</span>
@ -1950,7 +1950,7 @@
<span class="sd"> caller (Object): Caller of menu.</span>
<span class="sd"> tag_string (str): Input from user - only tagname</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> delete (str): If this is set, tag_string is considered</span>
<span class="sd"> the name of the tag to delete.</span>
@ -2178,7 +2178,7 @@
<span class="sd"> diff (dict): A diff as produced by `prototype_diff`.</span>
<span class="sd"> minimal (bool, optional): Don&#39;t show KEEPs.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> any (any): Forwarded into the generated options as arguments to the callable.</span>
<span class="sd"> Returns:</span>

4
docs/0.9.5/_modules/evennia/prototypes/prototypes.html
View file

@ -369,7 +369,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Find prototypes based on key and/or tags, or all prototypes.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> key (str): An exact or partial key to query for.</span>
<span class="sd"> tags (str or list): Tag key or keys to query for. These</span>
<span class="sd"> will always be applied with the &#39;db_protototype&#39;</span>
@ -769,7 +769,7 @@
<span class="sd"> behave differently.</span>
<span class="sd"> stacktrace (bool, optional): If set, print the stack parsing process of the protfunc-parser.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> session (Session): Passed to protfunc. Session of the entity spawning the prototype.</span>
<span class="sd"> protototype (dict): Passed to protfunc. The dict this protfunc is a part of.</span>
<span class="sd"> current_key(str): Passed to protfunc. The key in the prototype that will hold this value.</span>

2
docs/0.9.5/_modules/evennia/prototypes/spawner.html
View file

@ -883,7 +883,7 @@
<span class="sd"> prototypes (str or dict): Each argument should either be a</span>
<span class="sd"> prototype_key (will be used to find the prototype) or a full prototype</span>
<span class="sd"> dictionary. These will be batched-spawned as one object each.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> prototype_modules (str or list): A python-path to a prototype</span>
<span class="sd"> module, or a list of such paths. These will be used to build</span>
<span class="sd"> the global protparents dictionary accessible by the input</span>

2
docs/0.9.5/_modules/evennia/scripts/monitorhandler.html
View file

@ -164,7 +164,7 @@
<span class="sd"> persistent (bool, optional): If False, the monitor will survive</span>
<span class="sd"> a server reload but not a cold restart. This is default.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> session (Session): If this keyword is given, the monitorhandler will</span>
<span class="sd"> correctly analyze it and remove the monitor if after a reload/reboot</span>
<span class="sd"> the session is no longer valid.</span>

2
docs/0.9.5/_modules/evennia/scripts/taskhandler.html
View file

@ -139,7 +139,7 @@
<span class="sd"> callback (function or instance method): the callback itself</span>
<span class="sd"> any (any): any additional positional arguments to send to the callback</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> persistent (bool, optional): persist the task (store it).</span>
<span class="sd"> any (any): additional keyword arguments to send to the callback</span>

2
docs/0.9.5/_modules/evennia/scripts/tickerhandler.html
View file

@ -222,7 +222,7 @@
<span class="sd"> store_key (str): Unique storage hash for this ticker subscription.</span>
<span class="sd"> args (any, optional): Arguments to call the hook method with.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> _start_delay (int): If set, this will be</span>
<span class="sd"> used to delay the start of the trigger instead of</span>
<span class="sd"> `interval`.</span>

6
docs/0.9.5/_modules/evennia/server/connection_wizard.html
View file

@ -96,7 +96,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Ask a yes/no question inline.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> prompt (str): The prompt to ask.</span>
<span class="sd"> default (str): &quot;yes&quot; or &quot;no&quot;, used if pressing return.</span>
<span class="sd"> Returns:</span>
@ -122,7 +122,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Ask multiple-choice question, get response inline.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> prompt (str): Input prompt.</span>
<span class="sd"> options (list): List of options. Will be indexable by sequence number 1...</span>
<span class="sd"> default (int): The list index+1 of the default choice, if any</span>
@ -153,7 +153,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get arbitrary input inline.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> prompt (str): The display prompt.</span>
<span class="sd"> default (str): If empty input, use this.</span>
<span class="sd"> validator (callable): If given, the input will be passed</span>

2
docs/0.9.5/_modules/evennia/server/evennia_launcher.html
View file

@ -1678,7 +1678,7 @@
<span class="sd"> python source files themselves). Best they fail already here</span>
<span class="sd"> before we get any further.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> show_warnings (bool): If non-fatal warning messages should be shown.</span>
<span class="sd"> &quot;&quot;&quot;</span>

14
docs/0.9.5/_modules/evennia/server/inputfuncs.html
View file

@ -203,7 +203,7 @@
<span class="sd"> This allows the client an OOB way to inform us about its name and capabilities.</span>
<span class="sd"> This will be integrated into the session settings</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> get (bool): If this is true, return the settings as a dict</span>
<span class="sd"> (ignore all other kwargs).</span>
<span class="sd"> client (str): A client identifier, like &quot;mushclient&quot;.</span>
@ -321,7 +321,7 @@
<span class="sd"> Peform a login. This only works if session is currently not logged</span>
<span class="sd"> in. This will also automatically throttle too quick attempts.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> name (str): Account name</span>
<span class="sd"> password (str): Plain-text password</span>
@ -347,7 +347,7 @@
<span class="sd"> Return the value of a given attribute or db_property on the</span>
<span class="sd"> session&#39;s current account or character.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> name (str): Name of info value to return. Only names</span>
<span class="sd"> in the _gettable dictionary earlier in this module</span>
<span class="sd"> are accepted.</span>
@ -364,7 +364,7 @@
<span class="sd"> This is a test function for using with the repeat</span>
<span class="sd"> inputfunc.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> session (Session): Session to return to.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">time</span>
@ -381,7 +381,7 @@
<span class="sd"> this is meant as an example of limiting the number of</span>
<span class="sd"> possible call functions.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> callback (str): The function to call. Only functions</span>
<span class="sd"> from the _repeatable dictionary earlier in this</span>
<span class="sd"> module are available.</span>
@ -442,7 +442,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Adds monitoring to a given property or Attribute.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> name (str): The name of the property or Attribute</span>
<span class="sd"> to report. No db_* prefix is needed. Only names</span>
<span class="sd"> in the _monitorable dict earlier in this module</span>
@ -524,7 +524,7 @@
<span class="sd"> If kwargs is not empty, the key/values stored in there will be persisted</span>
<span class="sd"> to the account object.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> &lt;option name&gt;: an option to save</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">account</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">account</span>

2
docs/0.9.5/_modules/evennia/server/portal/grapevine.html
View file

@ -342,7 +342,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Send data grapevine -&gt; Evennia</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> data (dict): Converted json data.</span>
<span class="sd"> &quot;&quot;&quot;</span>

6
docs/0.9.5/_modules/evennia/server/portal/irc.html
View file

@ -314,7 +314,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Data IRC -&gt; Server.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> text (str): Ingoing text.</span>
<span class="sd"> kwargs (any): Other data from protocol.</span>
@ -345,7 +345,7 @@
<span class="sd"> Args:</span>
<span class="sd"> text (str): Outgoing text.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> user (str): the nick to send</span>
<span class="sd"> privately to.</span>
@ -414,7 +414,7 @@
<span class="sd"> Args:</span>
<span class="sd"> sessionhandler (SessionHandler): Reference to the main Sessionhandler.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> uid (int): Bot user id.</span>
<span class="sd"> botname (str): Bot name (seen in IRC channel).</span>
<span class="sd"> channel (str): IRC channel to connect to.</span>

4
docs/0.9.5/_modules/evennia/server/portal/portalsessionhandler.html
View file

@ -428,7 +428,7 @@
<span class="sd"> Args:</span>
<span class="sd"> session (PortalSession): Session receiving data.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Other data from protocol.</span>
<span class="sd"> Notes:</span>
@ -486,7 +486,7 @@
<span class="sd"> Args:</span>
<span class="sd"> session (Session): Session sending data.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Each key is a command instruction to the</span>
<span class="sd"> protocol on the form key = [[args],{kwargs}]. This will</span>
<span class="sd"> call a method send_&lt;key&gt; on the protocol. If no such</span>

2
docs/0.9.5/_modules/evennia/server/portal/rss.html
View file

@ -127,7 +127,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Data RSS -&gt; Evennia.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> text (str): Incoming text</span>
<span class="sd"> kwargs (any): Options from protocol.</span>

4
docs/0.9.5/_modules/evennia/server/portal/ssh.html
View file

@ -303,7 +303,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Data Evennia -&gt; User</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Options to the protocol.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -316,7 +316,7 @@
<span class="sd"> Args:</span>
<span class="sd"> text (str): The first argument is always the text string to send. No other arguments</span>
<span class="sd"> are considered.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> options (dict): Send-option flags (booleans)</span>
<span class="sd"> - mxp: enforce mxp link support.</span>

6
docs/0.9.5/_modules/evennia/server/portal/telnet.html
View file

@ -401,7 +401,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Data User -&gt; Evennia</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Options from the protocol.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -414,7 +414,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Data Evennia -&gt; User</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Options to the protocol</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sessionhandler</span><span class="o">.</span><span class="n">data_out</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
@ -428,7 +428,7 @@
<span class="sd"> Args:</span>
<span class="sd"> text (str): The first argument is always the text string to send. No other arguments</span>
<span class="sd"> are considered.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> options (dict): Send-option flags</span>
<span class="sd"> - mxp: Enforce MXP link support.</span>

4
docs/0.9.5/_modules/evennia/server/portal/webclient.html
View file

@ -279,7 +279,7 @@
<span class="sd"> Args:</span>
<span class="sd"> text (str): Text to send.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> options (dict): Options-dict with the following keys understood:</span>
<span class="sd"> - raw (bool): No parsing at all (leave ansi-to-html markers unparsed).</span>
<span class="sd"> - nocolor (bool): Clean out all color.</span>
@ -332,7 +332,7 @@
<span class="sd"> cmdname (str): The first argument will always be the oob cmd name.</span>
<span class="sd"> *args (any): Remaining args will be arguments for `cmd`.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> options (dict): These are ignored for oob commands. Use command</span>
<span class="sd"> arguments (which can hold dicts) to send instructions to the</span>
<span class="sd"> client instead.</span>

8
docs/0.9.5/_modules/evennia/server/portal/webclient_ajax.html
View file

@ -421,7 +421,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Data User -&gt; Evennia</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Incoming data.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -431,7 +431,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Data Evennia -&gt; User</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Options to the protocol</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sessionhandler</span><span class="o">.</span><span class="n">data_out</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
@ -444,7 +444,7 @@
<span class="sd"> Args:</span>
<span class="sd"> text (str): Text to send.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> options (dict): Options-dict with the following keys understood:</span>
<span class="sd"> - raw (bool): No parsing at all (leave ansi-to-html markers unparsed).</span>
<span class="sd"> - nocolor (bool): Remove all color.</span>
@ -496,7 +496,7 @@
<span class="sd"> cmdname (str): The first argument will always be the oob cmd name.</span>
<span class="sd"> *args (any): Remaining args will be arguments for `cmd`.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> options (dict): These are ignored for oob commands. Use command</span>
<span class="sd"> arguments (which can hold dicts) to send instructions to the</span>
<span class="sd"> client instead.</span>

10
docs/0.9.5/_modules/evennia/server/serversession.html
View file

@ -268,7 +268,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Update the protocol_flags and sync them with Portal.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> protocol_flag (any): A key and value to set in the</span>
<span class="sd"> protocol_flags dictionary.</span>
@ -286,7 +286,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Sending data from Evennia-&gt;Client</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> text (str or tuple)</span>
<span class="sd"> any (str or tuple): Send-commands identified</span>
<span class="sd"> by their keys. Or &quot;options&quot;, carrying options</span>
@ -300,7 +300,7 @@
<span class="sd"> Receiving data from the client, sending it off to</span>
<span class="sd"> the respective inputfuncs.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Incoming data from protocol on</span>
<span class="sd"> the form `{&quot;commandname&quot;: ((args), {kwargs}),...}`</span>
<span class="sd"> Notes:</span>
@ -318,7 +318,7 @@
<span class="sd"> Args:</span>
<span class="sd"> text (str): String input.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> any (str or tuple): Send-commands identified</span>
<span class="sd"> by their keys. Or &quot;options&quot;, carrying options</span>
<span class="sd"> for the protocol(s).</span>
@ -346,7 +346,7 @@
<span class="sd"> session (Session): This is here to make API consistent with</span>
<span class="sd"> Account/Object.execute_cmd. If given, data is passed to</span>
<span class="sd"> that Session, otherwise use self.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Other keyword arguments will be added to the found command</span>
<span class="sd"> object instace as variables before it executes. This is</span>
<span class="sd"> unused by default Evennia but may be used to set flags and</span>

4
docs/0.9.5/_modules/evennia/server/session.html
View file

@ -196,7 +196,7 @@
<span class="sd"> protocols can use this right away. Portal sessions</span>
<span class="sd"> should overload this to format/handle the outgoing data as needed.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Other data to the protocol.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -206,7 +206,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Hook for protocols to send incoming data to the engine.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): Other data from the protocol.</span>
<span class="sd"> &quot;&quot;&quot;</span>

2
docs/0.9.5/_modules/evennia/server/sessionhandler.html
View file

@ -856,7 +856,7 @@
<span class="sd"> Args:</span>
<span class="sd"> sessions (Session): Session.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> any (tuple): Incoming data from protocol, each</span>
<span class="sd"> on the form `commandname=((args), {kwargs})`.</span>

2
docs/0.9.5/_modules/evennia/server/throttle.html
View file

@ -61,7 +61,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Allows setting of throttle parameters.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> limit (int): Max number of failures before imposing limiter</span>
<span class="sd"> timeout (int): number of timeout seconds after</span>
<span class="sd"> max number of tries has been reached.</span>

2
docs/0.9.5/_modules/evennia/typeclasses/attributes.html
View file

@ -1142,7 +1142,7 @@
<span class="sd"> - `(key, value, category, lockstring)`</span>
<span class="sd"> - `(key, value, category, lockstring, default_access)`</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> strattr (bool): If `True`, value must be a string. This</span>
<span class="sd"> will save the value without pickling which is less</span>
<span class="sd"> flexible but faster to search (not often used except</span>

10
docs/0.9.5/_modules/evennia/typeclasses/managers.html
View file

@ -297,7 +297,7 @@
<span class="sd"> this is either `None` (a normal Tag), `alias` or</span>
<span class="sd"> `permission`. This always apply to all queried tags.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> match (str): &quot;all&quot; (default) or &quot;any&quot;; determines whether the</span>
<span class="sd"> target object must be tagged with ALL of the provided</span>
<span class="sd"> tags/categories or ANY single one. ANY will perform a weighted</span>
@ -688,7 +688,7 @@
<span class="sd"> Args:</span>
<span class="sd"> args (any): These are passed on as arguments to the default</span>
<span class="sd"> django get method.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): These are passed on as normal arguments</span>
<span class="sd"> to the default django get method</span>
<span class="sd"> Returns:</span>
@ -710,7 +710,7 @@
<span class="sd"> Args:</span>
<span class="sd"> args (any): These are passed on as arguments to the default</span>
<span class="sd"> django filter method.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): These are passed on as normal arguments</span>
<span class="sd"> to the default django filter method.</span>
<span class="sd"> Returns:</span>
@ -833,7 +833,7 @@
<span class="sd"> Variation of get that not only returns the current typeclass</span>
<span class="sd"> but also all subclasses of that typeclass.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): These are passed on as normal arguments</span>
<span class="sd"> to the default django get method.</span>
<span class="sd"> Returns:</span>
@ -858,7 +858,7 @@
<span class="sd"> Args:</span>
<span class="sd"> args (any): These are passed on as arguments to the default</span>
<span class="sd"> django filter method.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwargs (any): These are passed on as normal arguments</span>
<span class="sd"> to the default django filter method.</span>
<span class="sd"> Returns:</span>

4
docs/0.9.5/_modules/evennia/typeclasses/models.html
View file

@ -330,7 +330,7 @@
<span class="sd"> Args:</span>
<span class="sd"> Passed through to parent.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Passed through to parent.</span>
<span class="sd"> Notes:</span>
@ -654,7 +654,7 @@
<span class="sd"> no_superuser_bypass (bool, optional): Turn off the</span>
<span class="sd"> superuser lock bypass (be careful with this one).</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> kwar (any): Ignored, but is there to make the api</span>
<span class="sd"> consistent with the object-typeclass method access, which</span>
<span class="sd"> use it to feed to its hook methods.</span>

8
docs/0.9.5/_modules/evennia/utils/create.html
View file

@ -109,7 +109,7 @@
<span class="sd"> Create a new in-game object.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> typeclass (class or str): Class or python path to a typeclass.</span>
<span class="sd"> key (str): Name of the new object. If not set, a name of</span>
<span class="sd"> `#dbref` will be set.</span>
@ -236,7 +236,7 @@
<span class="sd"> scripts. It&#39;s behaviour is similar to the game objects except</span>
<span class="sd"> scripts has a time component and are more limited in scope.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> typeclass (class or str): Class or python path to a typeclass.</span>
<span class="sd"> key (str): Name of the new object. If not set, a name of</span>
<span class="sd"> #dbref will be set.</span>
@ -469,7 +469,7 @@
<span class="sd"> Args:</span>
<span class="sd"> key (str): This must be unique.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> aliases (list of str): List of alternative (likely shorter) keynames.</span>
<span class="sd"> desc (str): A description of the channel, for use in listings.</span>
<span class="sd"> locks (str): Lockstring.</span>
@ -535,7 +535,7 @@
<span class="sd"> the empty string, will be set to None.</span>
<span class="sd"> password (str): Password in cleartext.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> typeclass (str): The typeclass to use for the account.</span>
<span class="sd"> is_superuser (bool): Wether or not this account is to be a superuser</span>
<span class="sd"> locks (str): Lockstring.</span>

2
docs/0.9.5/_modules/evennia/utils/evform.html
View file

@ -229,7 +229,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Initiate the form</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> filename (str): Path to template file.</span>
<span class="sd"> cells (dict): A dictionary mapping `{id: text}`</span>
<span class="sd"> tables (dict): A dictionary mapping `{id: EvTable}`.</span>

32
docs/0.9.5/_modules/evennia/utils/evtable.html
View file

@ -324,7 +324,7 @@
<span class="sd"> text (str): Text to wrap.</span>
<span class="sd"> width (int, optional): Width to wrap `text` to.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> See TextWrapper class for available keyword args to customize</span>
<span class="sd"> wrapping behaviour.</span>
@ -345,7 +345,7 @@
<span class="sd"> text (str): Text to fill.</span>
<span class="sd"> width (int, optional): Width of fill area.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> See TextWrapper class for available keyword args to customize</span>
<span class="sd"> filling behaviour.</span>
@ -370,7 +370,7 @@
<span class="sd"> Args:</span>
<span class="sd"> data (str): The un-padded data of the entry.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> width (int): Desired width of cell. It will pad</span>
<span class="sd"> to this size.</span>
<span class="sd"> height (int): Desired height of cell. it will pad</span>
@ -815,7 +815,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Reformat the EvCell with new options</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> The available keyword arguments are the same as for `EvCell.__init__`.</span>
<span class="sd"> Raises:</span>
@ -974,7 +974,7 @@
<span class="sd"> Args:</span>
<span class="sd"> Text for each row in the column</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> All `EvCell.__init_` keywords are available, these</span>
<span class="sd"> settings will be persistently applied to every Cell in the</span>
<span class="sd"> column.</span>
@ -989,7 +989,7 @@
<span class="sd"> coherent and lined-up column. Will enforce column-specific</span>
<span class="sd"> options to cells.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Extra keywords to modify the column setting. Same keywords</span>
<span class="sd"> as in `EvCell.__init__`.</span>
@ -1021,7 +1021,7 @@
<span class="sd"> use `ypos=0`. If not given, data will be inserted at the end</span>
<span class="sd"> of the column.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Available keywods as per `EvCell.__init__`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -1040,7 +1040,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Change the options for the column.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Keywords as per `EvCell.__init__`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -1055,7 +1055,7 @@
<span class="sd"> index (int): Index location of the cell in the column,</span>
<span class="sd"> starting from 0 for the first row to Nrows-1.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Keywords as per `EvCell.__init__`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -1095,7 +1095,7 @@
<span class="sd"> Args:</span>
<span class="sd"> Header texts for the table.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> table (list of lists or list of `EvColumns`, optional):</span>
<span class="sd"> This is used to build the table in a quick way. If not</span>
<span class="sd"> given, the table will start out empty and `add_` methods</span>
@ -1249,7 +1249,7 @@
<span class="sd"> nx (int): x size of table.</span>
<span class="sd"> ny (int): y size of table.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Keywords as per `EvTable.__init__`.</span>
<span class="sd"> Returns:</span>
@ -1576,7 +1576,7 @@
<span class="sd"> Args:</span>
<span class="sd"> args (str): These strings will be used as the header texts.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Same keywords as per `EvTable.__init__`. Will be applied</span>
<span class="sd"> to the new header&#39;s cells.</span>
@ -1600,7 +1600,7 @@
<span class="sd"> to input new column. If not given, column will be added to the end</span>
<span class="sd"> of the table. Uses Python indexing (so first column is `xpos=0`)</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Other keywords as per `Cell.__init__`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -1664,7 +1664,7 @@
<span class="sd"> input new row. If not given, will be added to the end of the table.</span>
<span class="sd"> Uses Python indexing (so first row is `ypos=0`)</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Other keywords are as per `EvCell.__init__`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -1703,7 +1703,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Force a re-shape of the entire table.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Table options as per `EvTable.__init__`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
@ -1739,7 +1739,7 @@
<span class="sd"> index (int): Which column to reformat. The column index is</span>
<span class="sd"> given from 0 to Ncolumns-1.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> Column options as per `EvCell.__init__`.</span>
<span class="sd"> Raises:</span>

10
docs/0.9.5/_modules/evennia/utils/inlinefuncs.html
View file

@ -176,7 +176,7 @@
<span class="sd"> fillchar (str, optional): Character used for padding. Defaults to a</span>
<span class="sd"> space.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> session (Session): Session performing the pad.</span>
<span class="sd"> Example:</span>
@ -206,7 +206,7 @@
<span class="sd"> crop in characters.</span>
<span class="sd"> suffix (str, optional): End string to mark the fact that a part</span>
<span class="sd"> of the string was cropped. Defaults to `[...]`.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> session (Session): Session performing the crop.</span>
<span class="sd"> Example:</span>
@ -231,7 +231,7 @@
<span class="sd"> Args:</span>
<span class="sd"> spaces (int, optional): The number of spaces to insert.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> session (Session): Session performing the crop.</span>
<span class="sd"> Example:</span>
@ -254,7 +254,7 @@
<span class="sd"> text (str, optional): Text</span>
<span class="sd"> endclr (str, optional): The color to use at the end of the string. Defaults</span>
<span class="sd"> to `|n` (reset-color).</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> session (Session): Session object triggering inlinefunc.</span>
<span class="sd"> Example:</span>
@ -411,7 +411,7 @@
<span class="sd"> available_funcs (dict, optional): Define an alternative source of functions to parse for.</span>
<span class="sd"> If unset, use the functions found through `settings.INLINEFUNC_MODULES`.</span>
<span class="sd"> stacktrace (bool, optional): If set, print the stacktrace to log.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> session (Session): This is sent to this function by Evennia when triggering</span>
<span class="sd"> it. It is passed to the inlinefunc.</span>
<span class="sd"> kwargs (any): All other kwargs are also passed on to the inlinefunc.</span>

4
docs/0.9.5/_modules/evennia/utils/optionclasses.html
View file

@ -152,7 +152,7 @@
<span class="sd"> where `kwargs` are a combination of those passed into this function and</span>
<span class="sd"> the ones specified by the `OptionHandler`.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> any (any): Not used by default. These are passed in from self.set</span>
<span class="sd"> and allows the option to let the caller customize saving by</span>
<span class="sd"> overriding or extend the default save kwargs</span>
@ -212,7 +212,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Renders the Option&#39;s value as something pretty to look at.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> any (any): These are options passed by the caller to potentially</span>
<span class="sd"> customize display dynamically.</span>

8
docs/0.9.5/_modules/evennia/utils/utils.html
View file

@ -1066,7 +1066,7 @@
<span class="sd"> callback (callable): Will be called as `callback(*args, **kwargs)`</span>
<span class="sd"> after `timedelay` seconds.</span>
<span class="sd"> *args: Will be used as arguments to callback</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> persistent (bool): Make the delay persistent over a reboot or reload.</span>
<span class="sd"> any: Any other keywords will be use as keyword arguments to callback.</span>
@ -1108,7 +1108,7 @@
<span class="sd"> executed with `*args` and non-reserved `**kwargs` as arguments.</span>
<span class="sd"> The callable will be executed using ProcPool, or in a thread</span>
<span class="sd"> if ProcPool is not available.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> at_return (callable): Should point to a callable with one</span>
<span class="sd"> argument. It will be called with the return value from</span>
<span class="sd"> to_execute.</span>
@ -2109,7 +2109,7 @@
<span class="sd"> query (str, optional): The search query used to produce `matches`.</span>
<span class="sd"> quiet (bool, optional): If `True`, no messages will be echoed to caller</span>
<span class="sd"> on errors.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> nofound_string (str): Replacement string to echo on a notfound error.</span>
<span class="sd"> multimatch_string (str): Replacement string to echo on a multimatch error.</span>
@ -2174,7 +2174,7 @@
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Limited-size ordered dict.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> size_limit (int): Use this to limit the number of elements</span>
<span class="sd"> alloweds to be in this list. By default the overshooting elements</span>
<span class="sd"> will be removed in FIFO order.</span>

2
docs/0.9.5/_modules/evennia/web/website/views.html
View file

@ -184,7 +184,7 @@
<span class="sd"> You can do whatever you want to it, but it must be returned at the end</span>
<span class="sd"> of this method.</span>
<span class="sd"> Keyword args:</span>
<span class="sd"> Keyword Args:</span>
<span class="sd"> any (any): Passed through.</span>
<span class="sd"> Returns:</span>

5
docs/0.9.5/_sources/api/evennia.accounts.rst.txt
View file

@ -6,10 +6,11 @@ evennia.accounts
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.accounts.accounts
evennia.accounts.admin

5
docs/0.9.5/_sources/api/evennia.commands.default.rst.txt
View file

@ -6,10 +6,11 @@ evennia.commands.default
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.commands.default.account
evennia.commands.default.admin

20
docs/0.9.5/_sources/api/evennia.commands.rst.txt
View file

@ -6,20 +6,22 @@ evennia.commands
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
evennia.commands.default
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.commands.cmdhandler
evennia.commands.cmdparser
evennia.commands.cmdset
evennia.commands.cmdsethandler
evennia.commands.command
Packages/folders
----------------
.. toctree::
:maxdepth: 6
evennia.commands.default

5
docs/0.9.5/_sources/api/evennia.comms.rst.txt
View file

@ -6,10 +6,11 @@ evennia.comms
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.comms.admin
evennia.comms.channelhandler

5
docs/0.9.5/_sources/api/evennia.contrib.ingame_python.rst.txt
View file

@ -6,10 +6,11 @@ evennia.contrib.ingame\_python
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.contrib.ingame_python.callbackhandler
evennia.contrib.ingame_python.commands

28
docs/0.9.5/_sources/api/evennia.contrib.rst.txt
View file

@ -6,21 +6,11 @@ evennia.contrib
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
evennia.contrib.ingame_python
evennia.contrib.security
evennia.contrib.turnbattle
evennia.contrib.tutorial_examples
evennia.contrib.tutorial_world
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.contrib.barter
evennia.contrib.building_menu
@ -48,3 +38,15 @@ Submodules
evennia.contrib.tree_select
evennia.contrib.unixcommand
evennia.contrib.wilderness
Packages/folders
----------------
.. toctree::
:maxdepth: 6
evennia.contrib.ingame_python
evennia.contrib.security
evennia.contrib.turnbattle
evennia.contrib.tutorial_examples
evennia.contrib.tutorial_world

5
docs/0.9.5/_sources/api/evennia.contrib.security.auditing.rst.txt
View file

@ -6,10 +6,11 @@ evennia.contrib.security.auditing
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.contrib.security.auditing.outputs
evennia.contrib.security.auditing.server

5
docs/0.9.5/_sources/api/evennia.contrib.security.rst.txt
View file

@ -6,9 +6,10 @@ evennia.contrib.security
:undoc-members:
:show-inheritance:
Subpackages
-----------
Packages/folders
----------------
.. toctree::
:maxdepth: 6
evennia.contrib.security.auditing

5
docs/0.9.5/_sources/api/evennia.contrib.turnbattle.rst.txt
View file

@ -6,10 +6,11 @@ evennia.contrib.turnbattle
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.contrib.turnbattle.tb_basic
evennia.contrib.turnbattle.tb_equip

5
docs/0.9.5/_sources/api/evennia.contrib.tutorial_examples.rst.txt
View file

@ -6,10 +6,11 @@ evennia.contrib.tutorial\_examples
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.contrib.tutorial_examples.bodyfunctions
evennia.contrib.tutorial_examples.cmdset_red_button

5
docs/0.9.5/_sources/api/evennia.contrib.tutorial_world.rst.txt
View file

@ -6,10 +6,11 @@ evennia.contrib.tutorial\_world
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.contrib.tutorial_world.intro_menu
evennia.contrib.tutorial_world.mob

5
docs/0.9.5/_sources/api/evennia.help.rst.txt
View file

@ -6,10 +6,11 @@ evennia.help
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.help.admin
evennia.help.manager

5
docs/0.9.5/_sources/api/evennia.locks.rst.txt
View file

@ -6,10 +6,11 @@ evennia.locks
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.locks.lockfuncs
evennia.locks.lockhandler

5
docs/0.9.5/_sources/api/evennia.objects.rst.txt
View file

@ -6,10 +6,11 @@ evennia.objects
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.objects.admin
evennia.objects.manager

5
docs/0.9.5/_sources/api/evennia.prototypes.rst.txt
View file

@ -6,10 +6,11 @@ evennia.prototypes
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.prototypes.menus
evennia.prototypes.protfuncs

20
docs/0.9.5/_sources/api/evennia.rst.txt
View file

@ -6,10 +6,19 @@ evennia
:undoc-members:
:show-inheritance:
Subpackages
-----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.settings_default
Packages/folders
----------------
.. toctree::
:maxdepth: 6
evennia.accounts
evennia.commands
@ -24,10 +33,3 @@ Subpackages
evennia.typeclasses
evennia.utils
evennia.web
Submodules
----------
.. toctree::
evennia.settings_default

5
docs/0.9.5/_sources/api/evennia.scripts.rst.txt
View file

@ -6,10 +6,11 @@ evennia.scripts
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.scripts.admin
evennia.scripts.manager

5
docs/0.9.5/_sources/api/evennia.server.game_index_client.rst.txt
View file

@ -6,10 +6,11 @@ evennia.server.game\_index\_client
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.server.game_index_client.client
evennia.server.game_index_client.service

5
docs/0.9.5/_sources/api/evennia.server.portal.rst.txt
View file

@ -6,10 +6,11 @@ evennia.server.portal
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.server.portal.amp
evennia.server.portal.amp_server

5
docs/0.9.5/_sources/api/evennia.server.profiling.rst.txt
View file

@ -6,10 +6,11 @@ evennia.server.profiling
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.server.profiling.dummyrunner
evennia.server.profiling.dummyrunner_settings

24
docs/0.9.5/_sources/api/evennia.server.rst.txt
View file

@ -6,19 +6,11 @@ evennia.server
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
evennia.server.game_index_client
evennia.server.portal
evennia.server.profiling
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.server.admin
evennia.server.amp_client
@ -37,3 +29,13 @@ Submodules
evennia.server.throttle
evennia.server.validators
evennia.server.webserver
Packages/folders
----------------
.. toctree::
:maxdepth: 6
evennia.server.game_index_client
evennia.server.portal
evennia.server.profiling

5
docs/0.9.5/_sources/api/evennia.typeclasses.rst.txt
View file

@ -6,10 +6,11 @@ evennia.typeclasses
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.typeclasses.admin
evennia.typeclasses.attributes

5
docs/0.9.5/_sources/api/evennia.utils.idmapper.rst.txt
View file

@ -6,10 +6,11 @@ evennia.utils.idmapper
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.utils.idmapper.manager
evennia.utils.idmapper.models

20
docs/0.9.5/_sources/api/evennia.utils.rst.txt
View file

@ -6,17 +6,11 @@ evennia.utils
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
evennia.utils.idmapper
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.utils.ansi
evennia.utils.batchprocessors
@ -39,3 +33,11 @@ Submodules
evennia.utils.text2html
evennia.utils.utils
evennia.utils.validatorfuncs
Packages/folders
----------------
.. toctree::
:maxdepth: 6
evennia.utils.idmapper

20
docs/0.9.5/_sources/api/evennia.web.rst.txt
View file

@ -6,18 +6,20 @@ evennia.web
:undoc-members:
:show-inheritance:
Subpackages
-----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.web.urls
Packages/folders
----------------
.. toctree::
:maxdepth: 6
evennia.web.utils
evennia.web.webclient
evennia.web.website
Submodules
----------
.. toctree::
evennia.web.urls

5
docs/0.9.5/_sources/api/evennia.web.utils.rst.txt
View file

@ -6,10 +6,11 @@ evennia.web.utils
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.web.utils.backends
evennia.web.utils.general_context

5
docs/0.9.5/_sources/api/evennia.web.webclient.rst.txt
View file

@ -6,10 +6,11 @@ evennia.web.webclient
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.web.webclient.urls
evennia.web.webclient.views

20
docs/0.9.5/_sources/api/evennia.web.website.rst.txt
View file

@ -6,19 +6,21 @@ evennia.web.website
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
evennia.web.website.templatetags
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.web.website.forms
evennia.web.website.tests
evennia.web.website.urls
evennia.web.website.views
Packages/folders
----------------
.. toctree::
:maxdepth: 6
evennia.web.website.templatetags

5
docs/0.9.5/_sources/api/evennia.web.website.templatetags.rst.txt
View file

@ -6,9 +6,10 @@ evennia.web.website.templatetags
:undoc-members:
:show-inheritance:
Submodules
----------
Modules
-------
.. toctree::
:maxdepth: 6
evennia.web.website.templatetags.addclass

168
docs/0.9.5/api/evennia-api.html
View file

@ -39,9 +39,13 @@
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.html">evennia</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.html#subpackages">Subpackages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.html#modules">Modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.settings_default.html">evennia.settings_default</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.html#packages-folders">Packages/folders</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.accounts.html">evennia.accounts</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.accounts.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.accounts.accounts.html">evennia.accounts.accounts</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.accounts.admin.html">evennia.accounts.admin</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.accounts.bots.html">evennia.accounts.bots</a></li>
@ -52,14 +56,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.html">evennia.commands</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.commands.default.html">evennia.commands.default</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.commands.default.html#submodules">Submodules</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.commands.cmdhandler.html">evennia.commands.cmdhandler</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.commands.cmdparser.html">evennia.commands.cmdparser</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.commands.cmdset.html">evennia.commands.cmdset</a></li>
@ -67,10 +64,17 @@
<li class="toctree-l5"><a class="reference internal" href="evennia.commands.command.html">evennia.commands.command</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.commands.html#packages-folders">Packages/folders</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.commands.default.html">evennia.commands.default</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.commands.default.html#modules">Modules</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.comms.html">evennia.comms</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.comms.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.comms.admin.html">evennia.comms.admin</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.comms.channelhandler.html">evennia.comms.channelhandler</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.comms.comms.html">evennia.comms.comms</a></li>
@ -81,30 +85,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.html">evennia.contrib</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.ingame_python.html">evennia.contrib.ingame_python</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.ingame_python.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.html">evennia.contrib.security</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.security.html#subpackages">Subpackages</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.turnbattle.html">evennia.contrib.turnbattle</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.turnbattle.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorial_examples.html">evennia.contrib.tutorial_examples</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorial_world.html">evennia.contrib.tutorial_world</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorial_world.html#submodules">Submodules</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.barter.html">evennia.contrib.barter</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.building_menu.html">evennia.contrib.building_menu</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.chargen.html">evennia.contrib.chargen</a></li>
@ -133,10 +114,33 @@
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.wilderness.html">evennia.contrib.wilderness</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.html#packages-folders">Packages/folders</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.ingame_python.html">evennia.contrib.ingame_python</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.ingame_python.html#modules">Modules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.html">evennia.contrib.security</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.security.html#packages-folders">Packages/folders</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.turnbattle.html">evennia.contrib.turnbattle</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.turnbattle.html#modules">Modules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorial_examples.html">evennia.contrib.tutorial_examples</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#modules">Modules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.tutorial_world.html">evennia.contrib.tutorial_world</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.contrib.tutorial_world.html#modules">Modules</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.help.html">evennia.help</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.help.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.help.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.help.admin.html">evennia.help.admin</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.help.manager.html">evennia.help.manager</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.help.models.html">evennia.help.models</a></li>
@ -145,7 +149,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.locks.html">evennia.locks</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.locks.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.locks.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.locks.lockfuncs.html">evennia.locks.lockfuncs</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.locks.lockfuncs.html#mux-name-affects-effect">MUX Name: Affects: Effect:</a></li>
</ul>
@ -156,7 +160,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.objects.html">evennia.objects</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.objects.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.objects.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.objects.admin.html">evennia.objects.admin</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.objects.manager.html">evennia.objects.manager</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.objects.models.html">evennia.objects.models</a></li>
@ -166,7 +170,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.prototypes.html">evennia.prototypes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.prototypes.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.prototypes.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.prototypes.menus.html">evennia.prototypes.menus</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.prototypes.protfuncs.html">evennia.prototypes.protfuncs</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.prototypes.prototypes.html">evennia.prototypes.prototypes</a></li>
@ -176,7 +180,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.scripts.html">evennia.scripts</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.scripts.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.scripts.admin.html">evennia.scripts.admin</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.scripts.manager.html">evennia.scripts.manager</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.scripts.models.html">evennia.scripts.models</a></li>
@ -190,22 +194,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.server.html">evennia.server</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.server.game_index_client.html">evennia.server.game_index_client</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.server.game_index_client.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.server.portal.html">evennia.server.portal</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.server.portal.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.server.profiling.html">evennia.server.profiling</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.server.profiling.html#submodules">Submodules</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.server.admin.html">evennia.server.admin</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.server.amp_client.html">evennia.server.amp_client</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.server.connection_wizard.html">evennia.server.connection_wizard</a></li>
@ -225,10 +214,25 @@
<li class="toctree-l5"><a class="reference internal" href="evennia.server.webserver.html">evennia.server.webserver</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.server.html#packages-folders">Packages/folders</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.server.game_index_client.html">evennia.server.game_index_client</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.server.game_index_client.html#modules">Modules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.server.portal.html">evennia.server.portal</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.server.portal.html#modules">Modules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.server.profiling.html">evennia.server.profiling</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.server.profiling.html#modules">Modules</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.typeclasses.html">evennia.typeclasses</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.typeclasses.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.typeclasses.admin.html">evennia.typeclasses.admin</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.typeclasses.attributes.html">evennia.typeclasses.attributes</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.typeclasses.managers.html">evennia.typeclasses.managers</a></li>
@ -239,14 +243,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.utils.html">evennia.utils</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.utils.idmapper.html">evennia.utils.idmapper</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.utils.idmapper.html#submodules">Submodules</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.utils.ansi.html">evennia.utils.ansi</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.utils.batchprocessors.html">evennia.utils.batchprocessors</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.utils.batchprocessors.html#batch-command-processor-file-syntax">Batch-command processor file syntax</a></li>
@ -277,35 +274,38 @@
<li class="toctree-l5"><a class="reference internal" href="evennia.utils.validatorfuncs.html">evennia.utils.validatorfuncs</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.utils.html#packages-folders">Packages/folders</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.utils.idmapper.html">evennia.utils.idmapper</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.utils.idmapper.html#modules">Modules</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="evennia.web.html">evennia.web</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.web.html#subpackages">Subpackages</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.web.utils.html">evennia.web.utils</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.web.utils.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.web.webclient.html">evennia.web.webclient</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.web.webclient.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.html">evennia.web.website</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.web.website.html#subpackages">Subpackages</a></li>
<li class="toctree-l6"><a class="reference internal" href="evennia.web.website.html#submodules">Submodules</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.web.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.web.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.web.urls.html">evennia.web.urls</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="evennia.web.html#packages-folders">Packages/folders</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.web.utils.html">evennia.web.utils</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.web.utils.html#modules">Modules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.web.webclient.html">evennia.web.webclient</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.web.webclient.html#modules">Modules</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="evennia.web.website.html">evennia.web.website</a><ul>
<li class="toctree-l6"><a class="reference internal" href="evennia.web.website.html#modules">Modules</a></li>
<li class="toctree-l6"><a class="reference internal" href="evennia.web.website.html#packages-folders">Packages/folders</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="evennia.html#submodules">Submodules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.settings_default.html">evennia.settings_default</a></li>
</ul>
</li>
</ul>

6
docs/0.9.5/api/evennia.accounts.html
View file

@ -39,8 +39,8 @@
<p>This sub-package defines the out-of-character entities known as
Accounts. These are equivalent to ‘accounts’ and can puppet one or
more Objects depending on settings. An Account has no in-game existence.</p>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
<div class="section" id="modules">
<h2>Modules<a class="headerlink" href="#modules" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.accounts.accounts.html">evennia.accounts.accounts</a></li>
@ -75,7 +75,7 @@ more Objects depending on settings. An Account has no in-game existence.</p>
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.accounts</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#modules">Modules</a></li>
</ul>
</li>
</ul>

4
docs/0.9.5/api/evennia.commands.default.account.html
View file

@ -67,7 +67,7 @@ method. Otherwise all text will be returned to all connected sessions.</p>
<dl class="attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -98,7 +98,7 @@ method. Otherwise all text will be returned to all connected sessions.</p>
<dl class="attribute">
<dt id="evennia.commands.default.account.CmdOOCLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look while out-of-character\n\n Usage:\n look\n\n Look in the ooc state.\n '}</em><a class="headerlink" href="#evennia.commands.default.account.CmdOOCLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

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

@ -251,7 +251,7 @@ to accounts respectively.</p>
<dl class="attribute">
<dt id="evennia.commands.default.admin.CmdEmit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['remit', 'pemit']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['pemit', 'remit']</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -282,7 +282,7 @@ to accounts respectively.</p>
<dl class="attribute">
<dt id="evennia.commands.default.admin.CmdEmit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'remit pemit', 'category': 'admin', 'key': 'emit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n remit [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n pemit [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'pemit remit', 'category': 'admin', 'key': 'emit', 'tags': '', 'text': '\n admin command for emitting message to multiple objects\n\n Usage:\n emit[/switches] [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n remit [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n pemit [&lt;obj&gt;, &lt;obj&gt;, ... =] &lt;message&gt;\n\n Switches:\n room - limit emits to rooms only (default)\n accounts - limit emits to accounts only\n contents - send to the contents of matched objects too\n\n Emits a message to the selected objects or to\n your immediate surroundings. If the object is a room,\n send to its contents. remit and pemit are just\n limited forms of emit, for sending to rooms and\n to accounts respectively.\n '}</em><a class="headerlink" href="#evennia.commands.default.admin.CmdEmit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

12
docs/0.9.5/api/evennia.commands.default.building.html
View file

@ -1265,7 +1265,7 @@ server settings.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdTypeclass.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['parent', 'type', 'swap', 'update']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['swap', 'type', 'update', 'parent']</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1296,7 +1296,7 @@ server settings.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdTypeclass.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'parent type swap update', 'category': 'building', 'key': 'typeclass', 'tags': '', 'text': &quot;\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] &lt;object&gt; [= typeclass.path]\n typeclass/prototype &lt;object&gt; = prototype_key\n\n typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object.\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'swap type update parent', 'category': 'building', 'key': 'typeclass', 'tags': '', 'text': &quot;\n set or change an object's typeclass\n\n Usage:\n typeclass[/switch] &lt;object&gt; [= typeclass.path]\n typeclass/prototype &lt;object&gt; = prototype_key\n\n typeclass/list/show [typeclass.path]\n swap - this is a shorthand for using /force/reset flags.\n update - this is a shorthand for using the /force/reload flag.\n\n Switch:\n show, examine - display the current typeclass of object (default) or, if\n given a typeclass path, show the docstring of that typeclass.\n update - *only* re-run at_object_creation on this object\n meaning locks or other properties set later may remain.\n reset - clean out *all* the attributes and properties on the\n object - basically making this a new clean object.\n force - change to the typeclass also if the object\n already has a typeclass of the same name.\n list - show available typeclasses. Only typeclasses in modules actually\n imported or used from somewhere in the code will show up here\n (those typeclasses are still available if you know the path)\n prototype - clean and overwrite the object with the specified\n prototype key - effectively making a whole new object.\n\n Example:\n type button = examples.red_button.RedButton\n type/prototype button=a red button\n\n If the typeclass_path is not given, the current object's typeclass is\n assumed.\n\n View or set an object's typeclass. If setting, the creation hooks of the\n new typeclass will be run on the object. If you have clashing properties on\n the old class, use /reset. By default you are protected from changing to a\n typeclass of the same name as the one you already have - use /force to\n override this protection.\n\n The given typeclass must be identified by its location using python\n dot-notation pointing to the correct module and class. If no typeclass is\n given (or a wrong typeclass is given). Errors in the path or new typeclass\n will lead to the old typeclass being kept. The location of the typeclass\n module is searched from the default typeclass directory, as defined in the\n server settings.\n\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.building.CmdTypeclass.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -1449,7 +1449,7 @@ If object is not specified, the current location is examined.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdExamine.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['exam', 'ex']</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['ex', 'exam']</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1546,7 +1546,7 @@ non-persistent data stored on object</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdExamine.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'exam ex', 'category': 'building', 'key': 'examine', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [&lt;object&gt;[/attrname]]\n examine [*&lt;account&gt;[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ex exam', 'category': 'building', 'key': 'examine', 'tags': '', 'text': '\n get detailed information about an object\n\n Usage:\n examine [&lt;object&gt;[/attrname]]\n examine [*&lt;account&gt;[/attrname]]\n\n Switch:\n account - examine an Account (same as adding *)\n object - examine an Object (useful when OOC)\n\n The examine command shows detailed game info about an\n object and optionally a specific attribute on it.\n If object is not specified, the current location is examined.\n\n Append a * before the search string to examine an account.\n\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdExamine.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -1580,7 +1580,7 @@ one is given.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdFind.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['locate', 'search']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['search', 'locate']</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -1611,7 +1611,7 @@ one is given.</p>
<dl class="attribute">
<dt id="evennia.commands.default.building.CmdFind.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'locate search', 'category': 'building', 'key': 'find', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] &lt;name or dbref or *account&gt; [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'search locate', 'category': 'building', 'key': 'find', 'tags': '', 'text': '\n search the database for objects\n\n Usage:\n find[/switches] &lt;name or dbref or *account&gt; [= dbrefmin[-dbrefmax]]\n locate - this is a shorthand for using the /loc switch.\n\n Switches:\n room - only look for rooms (location=None)\n exit - only look for exits (destination!=None)\n char - only look for characters (BASE_CHARACTER_TYPECLASS)\n exact - only exact matches are returned.\n loc - display object location if exists and match has one result\n startswith - search for names starting with the string, rather than containing\n\n Searches the database for an object of a particular name or exact #dbref.\n Use *accountname to search for an account. The switches allows for\n limiting object matches to certain game entities. Dbrefmin and dbrefmax\n limits matches to within the given dbrefs range, or above/below if only\n one is given.\n '}</em><a class="headerlink" href="#evennia.commands.default.building.CmdFind.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/0.9.5/api/evennia.commands.default.comms.html
View file

@ -231,7 +231,7 @@ Use addcom/delcom to join and leave channels</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdChannels.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['clist', 'comlist', 'chanlist', 'channellist', 'all channels']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['chanlist', 'all channels', 'clist', 'channellist', 'comlist']</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -262,7 +262,7 @@ Use addcom/delcom to join and leave channels</p>
<dl class="attribute">
<dt id="evennia.commands.default.comms.CmdChannels.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'clist comlist chanlist channellist all channels', 'category': 'comms', 'key': 'channels', 'tags': '', 'text': &quot;\n list all channels available to you\n\n Usage:\n channels\n clist\n comlist\n\n Lists all channels available to you, whether you listen to them or not.\n Use 'comlist' to only view your current channel subscriptions.\n Use addcom/delcom to join and leave channels\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'chanlist all channels clist channellist comlist', 'category': 'comms', 'key': 'channels', 'tags': '', 'text': &quot;\n list all channels available to you\n\n Usage:\n channels\n clist\n comlist\n\n Lists all channels available to you, whether you listen to them or not.\n Use 'comlist' to only view your current channel subscriptions.\n Use addcom/delcom to join and leave channels\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.comms.CmdChannels.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

12
docs/0.9.5/api/evennia.commands.default.general.html
View file

@ -109,7 +109,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a>&lt;account&g
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -140,7 +140,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a>&lt;account&g
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look &lt;obj&gt;\n look *&lt;account&gt;\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look at location or object\n\n Usage:\n look\n look &lt;obj&gt;\n look *&lt;account&gt;\n\n Observes your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -257,7 +257,7 @@ inv</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdInventory.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['inv', 'i']</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['i', 'inv']</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -288,7 +288,7 @@ inv</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdInventory.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.commands.default.general.CmdInventory.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -638,7 +638,7 @@ automatically begin with your name.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdPose.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['emote', ':']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = [':', 'emote']</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -674,7 +674,7 @@ space.</p>
<dl class="attribute">
<dt id="evennia.commands.default.general.CmdPose.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'emote :', 'category': 'general', 'key': 'pose', 'tags': '', 'text': &quot;\n strike a pose\n\n Usage:\n pose &lt;pose text&gt;\n pose's &lt;pose text&gt;\n\n Example:\n pose is standing by the wall, smiling.\n -&gt; others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': ': emote', 'category': 'general', 'key': 'pose', 'tags': '', 'text': &quot;\n strike a pose\n\n Usage:\n pose &lt;pose text&gt;\n pose's &lt;pose text&gt;\n\n Example:\n pose is standing by the wall, smiling.\n -&gt; others will see:\n Tom is standing by the wall, smiling.\n\n Describe an action being taken. The pose text will\n automatically begin with your name.\n &quot;}</em><a class="headerlink" href="#evennia.commands.default.general.CmdPose.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

6
docs/0.9.5/api/evennia.commands.default.html
View file

@ -37,8 +37,8 @@
<div class="section" id="module-evennia.commands.default">
<span id="evennia-commands-default"></span><h1>evennia.commands.default<a class="headerlink" href="#module-evennia.commands.default" title="Permalink to this headline"></a></h1>
<p>This package contains all default commands of Evennia, grouped after category.</p>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
<div class="section" id="modules">
<h2>Modules<a class="headerlink" href="#modules" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.default.account.html">evennia.commands.default.account</a></li>
@ -84,7 +84,7 @@
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.commands.default</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#modules">Modules</a></li>
</ul>
</li>
</ul>

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

@ -56,7 +56,7 @@ connect “account name” “pass word”</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['conn', 'co', 'con']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'conn', 'con']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -91,7 +91,7 @@ there is no object yet before the account has logged in)</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect &quot;account name&quot; &quot;pass word&quot;\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><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n connect to the game\n\n Usage (at login screen):\n connect accountname password\n connect &quot;account name&quot; &quot;pass word&quot;\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><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -115,7 +115,7 @@ create “account name” “pass word”</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['cr', 'cre']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['cre', 'cr']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -146,7 +146,7 @@ create “account name” “pass word”</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cr cre', 'category': 'general', 'key': 'create', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create &lt;accountname&gt; &lt;password&gt;\n create &quot;account name&quot; &quot;pass word&quot;\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'tags': '', 'text': '\n create a new account account\n\n Usage (at login screen):\n create &lt;accountname&gt; &lt;password&gt;\n create &quot;account name&quot; &quot;pass word&quot;\n\n This creates a new account account.\n\n If you have spaces in your name, enclose it in double quotes.\n '}</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -170,7 +170,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -196,7 +196,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', '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><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="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><a class="headerlink" href="#evennia.commands.default.unloggedin.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

34
docs/0.9.5/api/evennia.commands.html
View file

@ -41,12 +41,24 @@ everything related to parsing input from the account, building cmdsets
and executing the code associated with a found command class.</p>
<p>commands.default contains all the default “mux-like” commands of
Evennia.</p>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="section" id="modules">
<h2>Modules<a class="headerlink" href="#modules" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.cmdhandler.html">evennia.commands.cmdhandler</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.cmdparser.html">evennia.commands.cmdparser</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.cmdset.html">evennia.commands.cmdset</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.cmdsethandler.html">evennia.commands.cmdsethandler</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.command.html">evennia.commands.command</a></li>
</ul>
</div>
</div>
<div class="section" id="packages-folders">
<h2>Packages/folders<a class="headerlink" href="#packages-folders" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.default.html">evennia.commands.default</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.default.html#submodules">Submodules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.commands.default.html#modules">Modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.account.html">evennia.commands.default.account</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.admin.html">evennia.commands.default.admin</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.commands.default.batchprocess.html">evennia.commands.default.batchprocess</a></li>
@ -70,18 +82,6 @@ Evennia.</p>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.cmdhandler.html">evennia.commands.cmdhandler</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.cmdparser.html">evennia.commands.cmdparser</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.cmdset.html">evennia.commands.cmdset</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.cmdsethandler.html">evennia.commands.cmdsethandler</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.commands.command.html">evennia.commands.command</a></li>
</ul>
</div>
</div>
</div>
@ -106,8 +106,8 @@ Evennia.</p>
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.commands</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#modules">Modules</a></li>
<li><a class="reference internal" href="#packages-folders">Packages/folders</a></li>
</ul>
</li>
</ul>

6
docs/0.9.5/api/evennia.comms.html
View file

@ -39,8 +39,8 @@
<p>This sub-package contains Evennia’s comms-system, a set of models and
handlers for in-game communication via channels and messages as well
as code related to external communication like IRC or RSS.</p>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
<div class="section" id="modules">
<h2>Modules<a class="headerlink" href="#modules" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.comms.admin.html">evennia.comms.admin</a></li>
@ -75,7 +75,7 @@ as code related to external communication like IRC or RSS.</p>
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.comms</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#modules">Modules</a></li>
</ul>
</li>
</ul>

4
docs/0.9.5/api/evennia.contrib.chargen.html
View file

@ -74,7 +74,7 @@ at them with this command.</p>
<dl class="attribute">
<dt id="evennia.contrib.chargen.CmdOOCLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -106,7 +106,7 @@ that is checked by the &#64;ic command directly.</p>
<dl class="attribute">
<dt id="evennia.contrib.chargen.CmdOOCLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n ooc look\n\n Usage:\n look\n look &lt;character&gt;\n\n This is an OOC version of the look command. Since an Account doesn\'t\n have an in-game existence, there is no concept of location or\n &quot;self&quot;.\n\n If any characters are available for you to control, you may look\n at them with this command.\n '}</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n ooc look\n\n Usage:\n look\n look &lt;character&gt;\n\n This is an OOC version of the look command. Since an Account doesn\'t\n have an in-game existence, there is no concept of location or\n &quot;self&quot;.\n\n If any characters are available for you to control, you may look\n at them with this command.\n '}</em><a class="headerlink" href="#evennia.contrib.chargen.CmdOOCLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/0.9.5/api/evennia.contrib.clothing.html
View file

@ -625,7 +625,7 @@ inv</p>
<dl class="attribute">
<dt id="evennia.contrib.clothing.CmdInventory.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['inv', 'i']</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['i', 'inv']</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -656,7 +656,7 @@ inv</p>
<dl class="attribute">
<dt id="evennia.contrib.clothing.CmdInventory.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'inv i', 'category': 'general', 'key': 'inventory', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'i inv', 'category': 'general', 'key': 'inventory', 'tags': '', 'text': '\n view inventory\n\n Usage:\n inventory\n inv\n\n Shows your inventory.\n '}</em><a class="headerlink" href="#evennia.contrib.clothing.CmdInventory.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

12
docs/0.9.5/api/evennia.contrib.email_login.html
View file

@ -71,7 +71,7 @@ the module given by settings.CONNECTION_SCREEN_MODULE.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['conn', 'co', 'con']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['co', 'conn', 'con']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -101,7 +101,7 @@ there is no object yet before the account has logged in)</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'conn co con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect &lt;email&gt; &lt;password&gt;\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'co conn con', 'category': 'general', 'key': 'connect', 'tags': '', 'text': '\n Connect to the game.\n\n Usage (at login screen):\n connect &lt;email&gt; &lt;password&gt;\n\n Use the create command to first create an account before logging in.\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedConnect.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -123,7 +123,7 @@ there is no object yet before the account has logged in)</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['cr', 'cre']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['cre', 'cr']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -159,7 +159,7 @@ name enclosed in quotes:</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedCreate.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cr cre', 'category': 'general', 'key': 'create', 'tags': '', 'text': '\n Create a new account.\n\n Usage (at login screen):\n create &quot;accountname&quot; &lt;email&gt; &lt;password&gt;\n\n This creates a new account account.\n\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'cre cr', 'category': 'general', 'key': 'create', 'tags': '', 'text': '\n Create a new account.\n\n Usage (at login screen):\n create &quot;accountname&quot; &lt;email&gt; &lt;password&gt;\n\n This creates a new account account.\n\n '}</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedCreate.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@ -178,7 +178,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['qu', 'q']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['q', 'qu']</em><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -204,7 +204,7 @@ version is a bit more complicated.</p>
<dl class="attribute">
<dt id="evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'qu q', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\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><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'q qu', 'category': 'general', 'key': 'quit', 'tags': '', 'text': '\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><a class="headerlink" href="#evennia.contrib.email_login.CmdUnconnectedQuit.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

4
docs/0.9.5/api/evennia.contrib.extended_room.html
View file

@ -273,7 +273,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a>&lt;account&g
<dl class="attribute">
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.aliases">
<code class="sig-name descname">aliases</code><em class="property"> = ['l', 'ls']</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">aliases</code><em class="property"> = ['ls', 'l']</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.aliases" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
@ -293,7 +293,7 @@ look <a href="#id1"><span class="problematic" id="id2">*</span></a>&lt;account&g
<dl class="attribute">
<dt id="evennia.contrib.extended_room.CmdExtendedRoomLook.search_index_entry">
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'l ls', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look &lt;obj&gt;\n look &lt;room detail&gt;\n look *&lt;account&gt;\n\n Observes your location, details at your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.search_index_entry" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">search_index_entry</code><em class="property"> = {'aliases': 'ls l', 'category': 'general', 'key': 'look', 'tags': '', 'text': '\n look\n\n Usage:\n look\n look &lt;obj&gt;\n look &lt;room detail&gt;\n look *&lt;account&gt;\n\n Observes your location, details at your location or objects in your vicinity.\n '}</em><a class="headerlink" href="#evennia.contrib.extended_room.CmdExtendedRoomLook.search_index_entry" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>

144
docs/0.9.5/api/evennia.contrib.html
View file

@ -39,76 +39,8 @@
<p>This sub-package holds Evennia’s contributions - code that may be
useful but are deemed too game-specific to go into the core library.</p>
<p>See README.md for more info.</p>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.html">evennia.contrib.ingame_python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.html#submodules">Submodules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.callbackhandler.html">evennia.contrib.ingame_python.callbackhandler</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.commands.html">evennia.contrib.ingame_python.commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.eventfuncs.html">evennia.contrib.ingame_python.eventfuncs</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.scripts.html">evennia.contrib.ingame_python.scripts</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.tests.html">evennia.contrib.ingame_python.tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.typeclasses.html">evennia.contrib.ingame_python.typeclasses</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.utils.html">evennia.contrib.ingame_python.utils</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.security.html">evennia.contrib.security</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.security.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.security.auditing.html">evennia.contrib.security.auditing</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.security.auditing.html#submodules">Submodules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.outputs.html">evennia.contrib.security.auditing.outputs</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.server.html">evennia.contrib.security.auditing.server</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.tests.html">evennia.contrib.security.auditing.tests</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.turnbattle.html">evennia.contrib.turnbattle</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.turnbattle.html#submodules">Submodules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_basic.html">evennia.contrib.turnbattle.tb_basic</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_equip.html">evennia.contrib.turnbattle.tb_equip</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_items.html">evennia.contrib.turnbattle.tb_items</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_magic.html">evennia.contrib.turnbattle.tb_magic</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_range.html">evennia.contrib.turnbattle.tb_range</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorial_examples.html">evennia.contrib.tutorial_examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#submodules">Submodules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.bodyfunctions.html">evennia.contrib.tutorial_examples.bodyfunctions</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.cmdset_red_button.html">evennia.contrib.tutorial_examples.cmdset_red_button</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.example_batch_code.html">evennia.contrib.tutorial_examples.example_batch_code</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button.html">evennia.contrib.tutorial_examples.red_button</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button_scripts.html">evennia.contrib.tutorial_examples.red_button_scripts</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.tests.html">evennia.contrib.tutorial_examples.tests</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorial_world.html">evennia.contrib.tutorial_world</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_world.html#submodules">Submodules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.intro_menu.html">evennia.contrib.tutorial_world.intro_menu</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.mob.html">evennia.contrib.tutorial_world.mob</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.objects.html">evennia.contrib.tutorial_world.objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.rooms.html">evennia.contrib.tutorial_world.rooms</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
<div class="section" id="modules">
<h2>Modules<a class="headerlink" href="#modules" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.barter.html">evennia.contrib.barter</a></li>
@ -140,6 +72,74 @@ useful but are deemed too game-specific to go into the core library.</p>
</ul>
</div>
</div>
<div class="section" id="packages-folders">
<h2>Packages/folders<a class="headerlink" href="#packages-folders" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.ingame_python.html">evennia.contrib.ingame_python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.ingame_python.html#modules">Modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.callbackhandler.html">evennia.contrib.ingame_python.callbackhandler</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.commands.html">evennia.contrib.ingame_python.commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.eventfuncs.html">evennia.contrib.ingame_python.eventfuncs</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.scripts.html">evennia.contrib.ingame_python.scripts</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.tests.html">evennia.contrib.ingame_python.tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.typeclasses.html">evennia.contrib.ingame_python.typeclasses</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.ingame_python.utils.html">evennia.contrib.ingame_python.utils</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.security.html">evennia.contrib.security</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.security.html#packages-folders">Packages/folders</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.security.auditing.html">evennia.contrib.security.auditing</a><ul>
<li class="toctree-l4"><a class="reference internal" href="evennia.contrib.security.auditing.html#modules">Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.outputs.html">evennia.contrib.security.auditing.outputs</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.server.html">evennia.contrib.security.auditing.server</a></li>
<li class="toctree-l5"><a class="reference internal" href="evennia.contrib.security.auditing.tests.html">evennia.contrib.security.auditing.tests</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.turnbattle.html">evennia.contrib.turnbattle</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.turnbattle.html#modules">Modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_basic.html">evennia.contrib.turnbattle.tb_basic</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_equip.html">evennia.contrib.turnbattle.tb_equip</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_items.html">evennia.contrib.turnbattle.tb_items</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_magic.html">evennia.contrib.turnbattle.tb_magic</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.turnbattle.tb_range.html">evennia.contrib.turnbattle.tb_range</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorial_examples.html">evennia.contrib.tutorial_examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_examples.html#modules">Modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.bodyfunctions.html">evennia.contrib.tutorial_examples.bodyfunctions</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.cmdset_red_button.html">evennia.contrib.tutorial_examples.cmdset_red_button</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.example_batch_code.html">evennia.contrib.tutorial_examples.example_batch_code</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button.html">evennia.contrib.tutorial_examples.red_button</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.red_button_scripts.html">evennia.contrib.tutorial_examples.red_button_scripts</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_examples.tests.html">evennia.contrib.tutorial_examples.tests</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.contrib.tutorial_world.html">evennia.contrib.tutorial_world</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.contrib.tutorial_world.html#modules">Modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.intro_menu.html">evennia.contrib.tutorial_world.intro_menu</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.mob.html">evennia.contrib.tutorial_world.mob</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.objects.html">evennia.contrib.tutorial_world.objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="evennia.contrib.tutorial_world.rooms.html">evennia.contrib.tutorial_world.rooms</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
@ -164,8 +164,8 @@ useful but are deemed too game-specific to go into the core library.</p>
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.contrib</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#modules">Modules</a></li>
<li><a class="reference internal" href="#packages-folders">Packages/folders</a></li>
</ul>
</li>
</ul>

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

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

Some files were not shown because too many files have changed in this diff Show more