Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-06 07:57:16 +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

22
docs/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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/1.0-dev/_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>