Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Start add docs again

Browse source
This commit is contained in:
Griatch 2020-10-08 21:45:18 +02:00
parent b7fc975379
commit d414cc3ccd
61 changed files with 235 additions and 236 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CODING_STYLE.md
View file

@ -101,7 +101,7 @@ def funcname(a, b, c, d=False, **kwargs):
c (list): A list argument.
d (bool, optional): An optional keyword argument.
Kwargs:
Keyword Args:
test (list): A test keyword.
Returns:
@ -165,13 +165,13 @@ Args:
and
```
Kwargs:
Keyword Args:
argname (type): text
```
mean the same thing! Which one is used depends on the function or
method documented, but there are no hard rules; If there is a large
`**kwargs` block in the function, using the `Kwargs:` block may be a
`**kwargs` block in the function, using the `Keyword Args:` block may be a
good idea, for a small number of arguments though, just using `Args:`
and marking keywords as `optional` will shorten the docstring and make
it easier to read.

2
docs/source/TextTags.md
View file

@ -190,7 +190,7 @@ def crop(*args, **kwargs):
crop in characters.
suffix (str, optional): End string to mark the fact that a part
of the string was cropped. Defaults to `[...]`.
Kwargs:
Keyword Args:
session (Session): Session performing the crop.
Example:
`$crop(text, 50, [...])`

1
docs/source/api/evennia.contrib.tutorial_world.rst
View file

@ -12,6 +12,7 @@ Submodules
.. toctree::
:maxdepth: 6
evennia.contrib.tutorial_world.intro_menu
evennia.contrib.tutorial_world.mob
evennia.contrib.tutorial_world.objects
evennia.contrib.tutorial_world.rooms

22
evennia/accounts/accounts.py
View file

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

6
evennia/accounts/bots.py
View file

@ -278,7 +278,7 @@ class IRCBot(Bot):
Args:
text (str, optional): Incoming text from channel.
Kwargs:
Keyword Args:
options (dict): Options dict with the following allowed keys:
- from_channel (str): dbid of a channel this text originated from.
- from_obj (list): list of objects sending this text.
@ -308,7 +308,7 @@ class IRCBot(Bot):
session (Session, optional): Session responsible for this
command. Note that this is the bot.
txt (str, optional): Command string.
Kwargs:
Keyword Args:
user (str): The name of the user who sent the message.
channel (str): The name of channel the message was sent to.
type (str): Nature of message. Either 'msg', 'action', 'nicklist'
@ -518,7 +518,7 @@ class GrapevineBot(Bot):
Args:
text (str, optional): Incoming text from channel.
Kwargs:
Keyword Args:
options (dict): Options dict with the following allowed keys:
- from_channel (str): dbid of a channel this text originated from.
- from_obj (list): list of objects sending this text.

2
evennia/commands/cmdhandler.py
View file

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

8
evennia/commands/command.py
View file

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

2
evennia/comms/comms.py
View file

@ -255,7 +255,7 @@ class DefaultChannel(ChannelDB, metaclass=TypeclassBase):
key (str): This must be unique.
account (Account): Account to attribute this object to.
Kwargs:
Keyword Args:
aliases (list of str): List of alternative (likely shorter) keynames.
description (str): A description of the channel, for use in listings.
locks (str): Lockstring.

2
evennia/contrib/building_menu.py
View file

@ -175,7 +175,7 @@ def _call_or_get(value, menu=None, choice=None, string=None, obj=None, caller=No
Args:
value (any): the value to obtain. It might be a callable (see note).
Kwargs:
Keyword Args:
menu (BuildingMenu, optional): the building menu to pass to value
if it is a callable.
choice (Choice, optional): the choice to pass to value if a callable.

6
evennia/contrib/clothing.py
View file

@ -160,7 +160,7 @@ def get_worn_clothes(character, exclude_covered=False):
Args:
character (obj): The character to get a list of worn clothes from.
Kwargs:
Keyword Args:
exclude_covered (bool): If True, excludes clothes covered by other
clothing from the returned list.
@ -237,7 +237,7 @@ class Clothing(DefaultObject):
wearer (obj): character object wearing this clothing object
wearstyle (True or str): string describing the style of wear or True for none
Kwargs:
Keyword Args:
quiet (bool): If false, does not message the room
Notes:
@ -276,7 +276,7 @@ class Clothing(DefaultObject):
Args:
wearer (obj): character object wearing this clothing object
Kwargs:
Keyword Args:
quiet (bool): If false, does not message the room
"""
self.db.worn = False

4
evennia/contrib/custom_gametime.py
View file

@ -95,7 +95,7 @@ def gametime_to_realtime(format=False, **kwargs):
in-game, you will be able to find the number of real-world seconds this
corresponds to (hint: Interval events deal with real life seconds).
Kwargs:
Keyword Args:
format (bool): Formatting the output.
days, month etc (int): These are the names of time units that must
match the `settings.TIME_UNITS` dict keys.
@ -131,7 +131,7 @@ def realtime_to_gametime(secs=0, mins=0, hrs=0, days=0, weeks=0, months=0, yrs=0
interval would correspond to. This is usually a lot less
interesting than the other way around.
Kwargs:
Keyword Args:
times (int): The various components of the time.
format (bool): Formatting the output.

2
evennia/contrib/evscaperoom/state.py
View file

@ -219,7 +219,7 @@ class BaseState(object):
"""
This is a convenience-wrapper for quickly building EvscapeRoom objects.
Kwargs:
Keyword Args:
typeclass (str): This can take just the class-name in the evscaperoom's
objects.py module. Otherwise, a full path or the actual class
is needed (for custom state objects, just give the class directly).

4
evennia/contrib/evscaperoom/utils.py
View file

@ -27,7 +27,7 @@ def create_evscaperoom_object(
Note that for the purpose of the Evscaperoom, we only allow one instance
of each *name*, deleting the old version if it already exists.
Kwargs:
Keyword Args:
typeclass (str): This can take just the class-name in the evscaperoom's
objects.py module. Otherwise, a full path is needed.
key (str): Name of object.
@ -69,7 +69,7 @@ def create_fantasy_word(length=5, capitalize=True):
"""
Create a random semi-pronouncable 'word'.
Kwargs:
Keyword Args:
length (int): The desired length of the 'word'.
capitalize (bool): If the return should be capitalized or not
Returns:

2
evennia/contrib/ingame_python/callbackhandler.py
View file

@ -155,7 +155,7 @@ class CallbackHandler(object):
callback_name (str): the callback name to call.
*args: additional variables for this callback.
Kwargs:
Keyword Args:
number (int, optional): call just a specific callback.
parameters (str, optional): call a callback with parameters.
locals (dict, optional): a locals replacement.

2
evennia/contrib/ingame_python/eventfuncs.py
View file

@ -28,7 +28,7 @@ def get(**kwargs):
"""
Return an object with the given search option or None if None is found.
Kwargs:
Keyword Args:
Any searchable data or property (id, db_key, db_location...).
Returns:

2
evennia/contrib/ingame_python/scripts.py
View file

@ -397,7 +397,7 @@ class EventHandler(DefaultScript):
callback_name (str): the callback name to call.
*args: additional variables for this callback.
Kwargs:
Keyword Args:
number (int, optional): call just a specific callback.
parameters (str, optional): call a callback with parameters.
locals (dict, optional): a locals replacement.

4
evennia/contrib/ingame_python/typeclasses.py
View file

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

6
evennia/contrib/rpsystem.py
View file

@ -1420,7 +1420,7 @@ class ContribRPObject(DefaultObject):
looker (TypedObject): The object or account that is looking
at/getting inforamtion for this object.
Kwargs:
Keyword Args:
pose (bool): Include the pose (if available) in the return.
Returns:
@ -1508,7 +1508,7 @@ class ContribRPCharacter(DefaultCharacter, ContribRPObject):
looker (TypedObject): The object or account that is looking
at/getting inforamtion for this object.
Kwargs:
Keyword Args:
pose (bool): Include the pose (if available) in the return.
Returns:
@ -1557,7 +1557,7 @@ class ContribRPCharacter(DefaultCharacter, ContribRPObject):
Args:
message (str): The suggested say/whisper text spoken by self.
Kwargs:
Keyword Args:
whisper (bool): If True, this is a whisper rather than a say.
"""

6
evennia/contrib/security/auditing/server.py
View file

@ -70,7 +70,7 @@ class AuditedServerSession(ServerSession):
Extracts messages and system data from a Session object upon message
send or receive.
Kwargs:
Keyword Args:
src (str): Source of data; 'client' or 'server'. Indicates direction.
text (str or list): Client sends messages to server in the form of
lists. Server sends messages to client as string.
@ -216,7 +216,7 @@ class AuditedServerSession(ServerSession):
"""
Generic hook for sending data out through the protocol.
Kwargs:
Keyword Args:
kwargs (any): Other data to the protocol.
"""
@ -234,7 +234,7 @@ class AuditedServerSession(ServerSession):
"""
Hook for protocols to send incoming data to the engine.
Kwargs:
Keyword Args:
kwargs (any): Other data from the protocol.
"""

2
evennia/contrib/turnbattle/tb_basic.py
View file

@ -279,7 +279,7 @@ def spend_action(character, actions, action_name=None):
character (obj): Character spending the action
actions (int) or 'all': Number of actions to spend, or 'all' to spend all actions
Kwargs:
Keyword Args:
action_name (str or None): If a string is given, sets character's last action in
combat to provided string
"""

2
evennia/contrib/turnbattle/tb_equip.py
View file

@ -330,7 +330,7 @@ def spend_action(character, actions, action_name=None):
character (obj): Character spending the action
actions (int) or 'all': Number of actions to spend, or 'all' to spend all actions
Kwargs:
Keyword Args:
action_name (str or None): If a string is given, sets character's last action in
combat to provided string
"""

2
evennia/contrib/turnbattle/tb_items.py
View file

@ -348,7 +348,7 @@ def spend_action(character, actions, action_name=None):
character (obj): Character spending the action
actions (int) or 'all': Number of actions to spend, or 'all' to spend all actions
Kwargs:
Keyword Args:
action_name (str or None): If a string is given, sets character's last action in
combat to provided string
"""

2
evennia/contrib/turnbattle/tb_magic.py
View file

@ -304,7 +304,7 @@ def spend_action(character, actions, action_name=None):
character (obj): Character spending the action
actions (int) or 'all': Number of actions to spend, or 'all' to spend all actions
Kwargs:
Keyword Args:
action_name (str or None): If a string is given, sets character's last action in
combat to provided string
"""

4
evennia/contrib/turnbattle/tb_range.py
View file

@ -470,7 +470,7 @@ def spend_action(character, actions, action_name=None):
character (obj): Character spending the action
actions (int) or 'all': Number of actions to spend, or 'all' to spend all actions
Kwargs:
Keyword Args:
action_name (str or None): If a string is given, sets character's last action in
combat to provided string
"""
@ -643,7 +643,7 @@ class TBRangeTurnHandler(DefaultScript):
Args:
to_init (object): Object to initialize range field for.
Kwargs:
Keyword Args:
anchor_obj (object): Object to copy range values from, or None for a random object.
add_distance (int): Distance to put between to_init object and anchor object.

2
evennia/contrib/unixcommand.py
View file

@ -98,7 +98,7 @@ class UnixCommandParser(argparse.ArgumentParser):
epilog (str): the epilog to show below options.
command (Command): the command calling the parser.
Kwargs:
Keyword Args:
Additional keyword arguments are directly sent to
`argparse.ArgumentParser`. You will find them on the
[parser's documentation](https://docs.python.org/2/library/argparse.html).

2
evennia/game_template/server/conf/at_search.py
View file

@ -42,7 +42,7 @@ def at_search_result(matches, caller, query="", quiet=False, **kwargs):
quiet (bool, optional): If `True`, no messages will be echoed to caller
on errors.
Kwargs:
Keyword Args:
nofound_string (str): Replacement string to echo on a notfound error.
multimatch_string (str): Replacement string to echo on a multimatch error.

36
evennia/objects/objects.py
View file

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

12
evennia/prototypes/menus.py
View file

@ -130,7 +130,7 @@ def _set_property(caller, raw_string, **kwargs):
caller (Object, Account): The user of the wizard.
raw_string (str): Input from user on given node - the new value to set.
Kwargs:
Keyword Args:
test_parse (bool): If set (default True), parse raw_string for protfuncs and obj-refs and
try to run result through literal_eval. The parser will be run in 'testing' mode and any
parsing errors will shown to the user. Note that this is just for testing, the original
@ -297,7 +297,7 @@ def _format_list_actions(*args, **kwargs):
Args:
actions (str): Available actions. The first letter of the action name will be assumed
to be a shortcut.
Kwargs:
Keyword Args:
prefix (str): Default prefix to use.
Returns:
string (str): Formatted footer for adding to the node text.
@ -1175,7 +1175,7 @@ def _add_attr(caller, attr_string, **kwargs):
attr = value
attr;category = value
attr;category;lockstring = value
Kwargs:
Keyword Args:
delete (str): If this is set, attr_string is
considered the name of the attribute to delete and
no further parsing happens.
@ -1362,7 +1362,7 @@ def _add_tag(caller, tag_string, **kwargs):
tagname;category
tagname;category;data
Kwargs:
Keyword Args:
delete (str): If this is set, tag_string is considered
the name of the tag to delete.
@ -1911,7 +1911,7 @@ def _add_prototype_tag(caller, tag_string, **kwargs):
caller (Object): Caller of menu.
tag_string (str): Input from user - only tagname
Kwargs:
Keyword Args:
delete (str): If this is set, tag_string is considered
the name of the tag to delete.
@ -2139,7 +2139,7 @@ def _format_diff_text_and_options(diff, minimal=True, **kwargs):
diff (dict): A diff as produced by `prototype_diff`.
minimal (bool, optional): Don't show KEEPs.
Kwargs:
Keyword Args:
any (any): Forwarded into the generated options as arguments to the callable.
Returns:

4
evennia/prototypes/prototypes.py
View file

@ -330,7 +330,7 @@ def search_prototype(key=None, tags=None, require_single=False, return_iterators
"""
Find prototypes based on key and/or tags, or all prototypes.
Kwargs:
Keyword Args:
key (str): An exact or partial key to query for.
tags (str or list): Tag key or keys to query for. These
will always be applied with the 'db_protototype'
@ -730,7 +730,7 @@ def protfunc_parser(value, available_functions=None, testing=False, stacktrace=F
behave differently.
stacktrace (bool, optional): If set, print the stack parsing process of the protfunc-parser.
Kwargs:
Keyword Args:
session (Session): Passed to protfunc. Session of the entity spawning the prototype.
protototype (dict): Passed to protfunc. The dict this protfunc is a part of.
current_key(str): Passed to protfunc. The key in the prototype that will hold this value.

2
evennia/prototypes/spawner.py
View file

@ -844,7 +844,7 @@ def spawn(*prototypes, **kwargs):
prototypes (str or dict): Each argument should either be a
prototype_key (will be used to find the prototype) or a full prototype
dictionary. These will be batched-spawned as one object each.
Kwargs:
Keyword Args:
prototype_modules (str or list): A python-path to a prototype
module, or a list of such paths. These will be used to build
the global protparents dictionary accessible by the input

2
evennia/scripts/monitorhandler.py
View file

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

2
evennia/scripts/taskhandler.py
View file

@ -100,7 +100,7 @@ class TaskHandler(object):
callback (function or instance method): the callback itself
any (any): any additional positional arguments to send to the callback
Kwargs:
Keyword Args:
persistent (bool, optional): persist the task (store it).
any (any): additional keyword arguments to send to the callback

2
evennia/scripts/tickerhandler.py
View file

@ -183,7 +183,7 @@ class Ticker(object):
store_key (str): Unique storage hash for this ticker subscription.
args (any, optional): Arguments to call the hook method with.
Kwargs:
Keyword Args:
_start_delay (int): If set, this will be
used to delay the start of the trigger instead of
`interval`.

6
evennia/server/connection_wizard.py
View file

@ -57,7 +57,7 @@ class ConnectionWizard(object):
"""
Ask a yes/no question inline.
Kwargs:
Keyword Args:
prompt (str): The prompt to ask.
default (str): "yes" or "no", used if pressing return.
Returns:
@ -83,7 +83,7 @@ class ConnectionWizard(object):
"""
Ask multiple-choice question, get response inline.
Kwargs:
Keyword Args:
prompt (str): Input prompt.
options (list): List of options. Will be indexable by sequence number 1...
default (int): The list index+1 of the default choice, if any
@ -114,7 +114,7 @@ class ConnectionWizard(object):
"""
Get arbitrary input inline.
Kwargs:
Keyword Args:
prompt (str): The display prompt.
default (str): If empty input, use this.
validator (callable): If given, the input will be passed

2
evennia/server/evennia_launcher.py
View file

@ -1639,7 +1639,7 @@ def error_check_python_modules(show_warnings=False):
python source files themselves). Best they fail already here
before we get any further.
Kwargs:
Keyword Args:
show_warnings (bool): If non-fatal warning messages should be shown.
"""

14
evennia/server/inputfuncs.py
View file

@ -164,7 +164,7 @@ def client_options(session, *args, **kwargs):
This allows the client an OOB way to inform us about its name and capabilities.
This will be integrated into the session settings
Kwargs:
Keyword Args:
get (bool): If this is true, return the settings as a dict
(ignore all other kwargs).
client (str): A client identifier, like "mushclient".
@ -282,7 +282,7 @@ def login(session, *args, **kwargs):
Peform a login. This only works if session is currently not logged
in. This will also automatically throttle too quick attempts.
Kwargs:
Keyword Args:
name (str): Account name
password (str): Plain-text password
@ -308,7 +308,7 @@ def get_value(session, *args, **kwargs):
Return the value of a given attribute or db_property on the
session's current account or character.
Kwargs:
Keyword Args:
name (str): Name of info value to return. Only names
in the _gettable dictionary earlier in this module
are accepted.
@ -325,7 +325,7 @@ def _testrepeat(**kwargs):
This is a test function for using with the repeat
inputfunc.
Kwargs:
Keyword Args:
session (Session): Session to return to.
"""
import time
@ -342,7 +342,7 @@ def repeat(session, *args, **kwargs):
this is meant as an example of limiting the number of
possible call functions.
Kwargs:
Keyword Args:
callback (str): The function to call. Only functions
from the _repeatable dictionary earlier in this
module are available.
@ -403,7 +403,7 @@ def monitor(session, *args, **kwargs):
"""
Adds monitoring to a given property or Attribute.
Kwargs:
Keyword Args:
name (str): The name of the property or Attribute
to report. No db_* prefix is needed. Only names
in the _monitorable dict earlier in this module
@ -485,7 +485,7 @@ def webclient_options(session, *args, **kwargs):
If kwargs is not empty, the key/values stored in there will be persisted
to the account object.
Kwargs:
Keyword Args:
<option name>: an option to save
"""
account = session.account

2
evennia/server/portal/grapevine.py
View file

@ -303,7 +303,7 @@ class GrapevineClient(WebSocketClientProtocol, Session):
"""
Send data grapevine -> Evennia
Kwargs:
Keyword Args:
data (dict): Converted json data.
"""

6
evennia/server/portal/irc.py
View file

@ -275,7 +275,7 @@ class IRCBot(irc.IRCClient, Session):
"""
Data IRC -> Server.
Kwargs:
Keyword Args:
text (str): Ingoing text.
kwargs (any): Other data from protocol.
@ -306,7 +306,7 @@ class IRCBot(irc.IRCClient, Session):
Args:
text (str): Outgoing text.
Kwargs:
Keyword Args:
user (str): the nick to send
privately to.
@ -375,7 +375,7 @@ class IRCBotFactory(protocol.ReconnectingClientFactory):
Args:
sessionhandler (SessionHandler): Reference to the main Sessionhandler.
Kwargs:
Keyword Args:
uid (int): Bot user id.
botname (str): Bot name (seen in IRC channel).
channel (str): IRC channel to connect to.

4
evennia/server/portal/portalsessionhandler.py
View file

@ -375,7 +375,7 @@ class PortalSessionHandler(SessionHandler):
Args:
session (PortalSession): Session receiving data.
Kwargs:
Keyword Args:
kwargs (any): Other data from protocol.
Notes:
@ -433,7 +433,7 @@ class PortalSessionHandler(SessionHandler):
Args:
session (Session): Session sending data.
Kwargs:
Keyword Args:
kwargs (any): Each key is a command instruction to the
protocol on the form key = [[args],{kwargs}]. This will
call a method send_<key> on the protocol. If no such

2
evennia/server/portal/rss.py
View file

@ -88,7 +88,7 @@ class RSSReader(Session):
"""
Data RSS -> Evennia.
Kwargs:
Keyword Args:
text (str): Incoming text
kwargs (any): Options from protocol.

24
evennia/server/portal/ssh.py
View file

@ -263,7 +263,7 @@ class SshProtocol(Manhole, session.Session):
"""
Data Evennia -> User
Kwargs:
Keyword Args:
kwargs (any): Options to the protocol.
"""
@ -276,18 +276,18 @@ class SshProtocol(Manhole, session.Session):
Args:
text (str): The first argument is always the text string to send. No other arguments
are considered.
Kwargs:
Keyword Args:
options (dict): Send-option flags
- mxp: Enforce MXP link support.
- ansi: Enforce no ANSI colors.
- xterm256: Enforce xterm256 colors, regardless of TTYPE setting.
- nocolor: Strip all colors.
- raw: Pass string through without any ansi processing
(i.e. include Evennia ansi markers but do not
convert them into ansi tokens)
- echo: Turn on/off line echo on the client. Turn
off line echo for client, for example for password.
Note that it must be actively turned back on again!
- mxp: Enforce MXP link support.
- ansi: Enforce no ANSI colors.
- xterm256: Enforce xterm256 colors, regardless of TTYPE setting.
- nocolor: Strip all colors.
- raw: Pass string through without any ansi processing
(i.e. include Evennia ansi markers but do not
convert them into ansi tokens)
- echo: Turn on/off line echo on the client. Turn
off line echo for client, for example for password.
Note that it must be actively turned back on again!
"""
# print "telnet.send_text", args,kwargs # DEBUG

28
evennia/server/portal/telnet.py
View file

@ -360,7 +360,7 @@ class TelnetProtocol(Telnet, StatefulTelnetProtocol, Session):
"""
Data User -> Evennia
Kwargs:
Keyword Args:
kwargs (any): Options from the protocol.
"""
@ -373,7 +373,7 @@ class TelnetProtocol(Telnet, StatefulTelnetProtocol, Session):
"""
Data Evennia -> User
Kwargs:
Keyword Args:
kwargs (any): Options to the protocol
"""
self.sessionhandler.data_out(self, **kwargs)
@ -387,19 +387,19 @@ class TelnetProtocol(Telnet, StatefulTelnetProtocol, Session):
Args:
text (str): The first argument is always the text string to send. No other arguments
are considered.
Kwargs:
Keyword Args:
options (dict): Send-option flags
- mxp: Enforce MXP link support.
- ansi: Enforce no ANSI colors.
- xterm256: Enforce xterm256 colors, regardless of TTYPE.
- noxterm256: Enforce no xterm256 color support, regardless of TTYPE.
- nocolor: Strip all Color, regardless of ansi/xterm256 setting.
- raw: Pass string through without any ansi processing
(i.e. include Evennia ansi markers but do not
convert them into ansi tokens)
- echo: Turn on/off line echo on the client. Turn
off line echo for client, for example for password.
Note that it must be actively turned back on again!
- mxp: Enforce MXP link support.
- ansi: Enforce no ANSI colors.
- xterm256: Enforce xterm256 colors, regardless of TTYPE.
- noxterm256: Enforce no xterm256 color support, regardless of TTYPE.
- nocolor: Strip all Color, regardless of ansi/xterm256 setting.
- raw: Pass string through without any ansi processing
(i.e. include Evennia ansi markers but do not
convert them into ansi tokens)
- echo: Turn on/off line echo on the client. Turn
off line echo for client, for example for password.
Note that it must be actively turned back on again!
"""
text = args[0] if args else ""

74
evennia/server/portal/telnet_oob.py
View file

@ -11,8 +11,8 @@ instruct the client to play sounds or to update a graphical health
bar.
> Note that in Evennia's Web client, all send commands are "OOB commands",
(including the "text" one), there is no equivalence to MSDP/GMCP for the
webclient since it doesn't need it.
(including the "text" one), there is no equivalence to MSDP/GMCP for the
webclient since it doesn't need it.
This implements the following telnet OOB communication protocols:
@ -159,14 +159,15 @@ class TelnetOOB(object):
Notes:
The output of this encoding will be
MSDP structures on these forms:
```
[cmdname, [], {}] -> VAR cmdname VAL ""
[cmdname, [arg], {}] -> VAR cmdname VAL arg
[cmdname, [args],{}] -> VAR cmdname VAL ARRAYOPEN VAL arg VAL arg ... ARRAYCLOSE
[cmdname, [], {kwargs}] -> VAR cmdname VAL TABLEOPEN VAR key VAL val ... TABLECLOSE
[cmdname, [args], {kwargs}] -> VAR cmdname VAL ARRAYOPEN VAL arg VAL arg ... ARRAYCLOSE
VAR cmdname VAL TABLEOPEN VAR key VAL val ... TABLECLOSE
```
::
[cmdname, [], {}] -> VAR cmdname VAL ""
[cmdname, [arg], {}] -> VAR cmdname VAL arg
[cmdname, [args],{}] -> VAR cmdname VAL ARRAYOPEN VAL arg VAL arg ... ARRAYCLOSE
[cmdname, [], {kwargs}] -> VAR cmdname VAL TABLEOPEN VAR key VAL val ... TABLECLOSE
[cmdname, [args], {kwargs}] -> VAR cmdname VAL ARRAYOPEN VAL arg VAL arg ... ARRAYCLOSE
VAR cmdname VAL TABLEOPEN VAR key VAL val ... TABLECLOSE
Further nesting is not supported, so if an array argument consists
of an array (for example), that array will be json-converted to a
string.
@ -233,25 +234,24 @@ class TelnetOOB(object):
to have adopted). A cmdname without Package will end
up in the Core package, while Core package names will
be stripped on the Evennia side.
::
```
[cmd.name, [], {}] -> Cmd.Name
[cmd.name, [arg], {}] -> Cmd.Name arg
[cmd.name, [args],{}] -> Cmd.Name [args]
[cmd.name, [], {kwargs}] -> Cmd.Name {kwargs}
[cmdname, [args, {kwargs}] -> Core.Cmdname [[args],{kwargs}]
```
[cmd.name, [], {}] -> Cmd.Name
[cmd.name, [arg], {}] -> Cmd.Name arg
[cmd.name, [args],{}] -> Cmd.Name [args]
[cmd.name, [], {kwargs}] -> Cmd.Name {kwargs}
[cmdname, [args, {kwargs}] -> Core.Cmdname [[args],{kwargs}]
Notes:
There are also a few default mappings between evennia outputcmds and
GMCP:
```
client_options -> Core.Supports.Get
get_inputfuncs -> Core.Commands.Get
get_value -> Char.Value.Get
repeat -> Char.Repeat.Update
monitor -> Char.Monitor.Update
```
::
client_options -> Core.Supports.Get
get_inputfuncs -> Core.Commands.Get
get_value -> Char.Value.Get
repeat -> Char.Repeat.Update
monitor -> Char.Monitor.Update
"""
@ -287,14 +287,13 @@ class TelnetOOB(object):
Notes:
Clients should always send MSDP data on
one of the following forms:
::
```
cmdname '' -> [cmdname, [], {}]
cmdname val -> [cmdname, [val], {}]
cmdname array -> [cmdname, [array], {}]
cmdname table -> [cmdname, [], {table}]
cmdname array cmdname table -> [cmdname, [array], {table}]
```
cmdname '' -> [cmdname, [], {}]
cmdname val -> [cmdname, [val], {}]
cmdname array -> [cmdname, [array], {}]
cmdname table -> [cmdname, [], {table}]
cmdname array cmdname table -> [cmdname, [array], {table}]
Observe that all MSDP_VARS are used to identify cmdnames,
so if there are multiple arrays with the same cmdname
@ -388,14 +387,13 @@ class TelnetOOB(object):
We assume the structure is valid JSON.
The following is parsed into Evennia's formal structure:
::
```
Core.Name -> [name, [], {}]
Core.Name string -> [name, [string], {}]
Core.Name [arg, arg,...] -> [name, [args], {}]
Core.Name {key:arg, key:arg, ...} -> [name, [], {kwargs}]
Core.Name [[args], {kwargs}] -> [name, [args], {kwargs}]
```
Core.Name -> [name, [], {}]
Core.Name string -> [name, [string], {}]
Core.Name [arg, arg,...] -> [name, [args], {}]
Core.Name {key:arg, key:arg, ...} -> [name, [], {kwargs}]
Core.Name [[args], {kwargs}] -> [name, [args], {kwargs}]
"""
if isinstance(data, list):

4
evennia/server/portal/webclient.py
View file

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

8
evennia/server/portal/webclient_ajax.py
View file

@ -382,7 +382,7 @@ class AjaxWebClientSession(session.Session):
"""
Data User -> Evennia
Kwargs:
Keyword Args:
kwargs (any): Incoming data.
"""
@ -392,7 +392,7 @@ class AjaxWebClientSession(session.Session):
"""
Data Evennia -> User
Kwargs:
Keyword Args:
kwargs (any): Options to the protocol
"""
self.sessionhandler.data_out(self, **kwargs)
@ -405,7 +405,7 @@ class AjaxWebClientSession(session.Session):
Args:
text (str): Text to send.
Kwargs:
Keyword Args:
options (dict): Options-dict with the following keys understood:
- raw (bool): No parsing at all (leave ansi-to-html markers unparsed).
- nocolor (bool): Remove all color.
@ -457,7 +457,7 @@ class AjaxWebClientSession(session.Session):
cmdname (str): The first argument will always be the oob cmd name.
*args (any): Remaining args will be arguments for `cmd`.
Kwargs:
Keyword Args:
options (dict): These are ignored for oob commands. Use command
arguments (which can hold dicts) to send instructions to the
client instead.

23
evennia/server/server.py
View file

@ -399,17 +399,18 @@ class Evennia(object):
"""
Shuts down the server from inside it.
mode - sets the server restart mode.
'reload' - server restarts, no "persistent" scripts
are stopped, at_reload hooks called.
'reset' - server restarts, non-persistent scripts stopped,
at_shutdown hooks called but sessions will not
be disconnected.
'shutdown' - like reset, but server will not auto-restart.
_reactor_stopping - this is set if server is stopped by a kill
command OR this method was already called
once - in both cases the reactor is
dead/stopping already.
Keyword Args:
mode (str): Sets the server restart mode:
- 'reload': server restarts, no "persistent" scripts
are stopped, at_reload hooks called.
- 'reset' - server restarts, non-persistent scripts stopped,
at_shutdown hooks called but sessions will not
be disconnected.
-'shutdown' - like reset, but server will not auto-restart.
_reactor_stopping: This is set if server is stopped by a kill
command OR this method was already called
once - in both cases the reactor is dead/stopping already.
"""
if _reactor_stopping and hasattr(self, "shutdown_complete"):
# this means we have already passed through this method

15
evennia/server/serversession.py
View file

@ -343,7 +343,7 @@ class ServerSession(Session):
"""
Update the protocol_flags and sync them with Portal.
Kwargs:
Keyword Args:
key, value - A key:value pair to set in the
protocol_flags dictionary.
@ -361,7 +361,7 @@ class ServerSession(Session):
"""
Sending data from Evennia->Client
Kwargs:
Keyword Args:
text (str or tuple)
any (str or tuple): Send-commands identified
by their keys. Or "options", carrying options
@ -375,14 +375,15 @@ class ServerSession(Session):
Receiving data from the client, sending it off to
the respective inputfuncs.
Kwargs:
kwargs (any): Incoming data from protocol on
Keyword Args:
any: Incoming data from protocol on
the form `{"commandname": ((args), {kwargs}),...}`
Notes:
This method is here in order to give the user
a single place to catch and possibly process all incoming data from
the client. It should usually always end by sending
this data off to `self.sessionhandler.call_inputfuncs(self, **kwargs)`.
"""
self.sessionhandler.call_inputfuncs(self, **kwargs)
@ -392,9 +393,7 @@ class ServerSession(Session):
Args:
text (str): String input.
Kwargs:
any (str or tuple): Send-commands identified
kwargs (str or tuple): Send-commands identified
by their keys. Or "options", carrying options
for the protocol(s).
@ -421,7 +420,7 @@ class ServerSession(Session):
session (Session): This is here to make API consistent with
Account/Object.execute_cmd. If given, data is passed to
that Session, otherwise use self.
Kwargs:
Keyword Args:
Other keyword arguments will be added to the found command
object instace as variables before it executes. This is
unused by default Evennia but may be used to set flags and

4
evennia/server/session.py
View file

@ -177,7 +177,7 @@ class Session(object):
protocols can use this right away. Portal sessions
should overload this to format/handle the outgoing data as needed.
Kwargs:
Keyword Args:
kwargs (any): Other data to the protocol.
"""
@ -187,7 +187,7 @@ class Session(object):
"""
Hook for protocols to send incoming data to the engine.
Kwargs:
Keyword Args:
kwargs (any): Other data from the protocol.
"""

2
evennia/server/sessionhandler.py
View file

@ -834,7 +834,7 @@ class ServerSessionHandler(SessionHandler):
Args:
sessions (Session): Session.
Kwargs:
Keyword Args:
kwargs (any): Incoming data from protocol on
the form `{"commandname": ((args), {kwargs}),...}`

2
evennia/server/throttle.py
View file

@ -22,7 +22,7 @@ class Throttle(object):
"""
Allows setting of throttle parameters.
Kwargs:
Keyword Args:
limit (int): Max number of failures before imposing limiter
timeout (int): number of timeout seconds after
max number of tries has been reached.

2
evennia/typeclasses/attributes.py
View file

@ -601,7 +601,7 @@ class AttributeHandler(object):
- `(key, value, category, lockstring)`
- `(key, value, category, lockstring, default_access)`
Kwargs:
Keyword Args:
strattr (bool): If `True`, value must be a string. This
will save the value without pickling which is less
flexible but faster to search (not often used except

10
evennia/typeclasses/managers.py
View file

@ -260,7 +260,7 @@ class TypedObjectManager(idmapper.manager.SharedMemoryManager):
this is either `None` (a normal Tag), `alias` or
`permission`. This always apply to all queried tags.
Kwargs:
Keyword Args:
match (str): "all" (default) or "any"; determines whether the
target object must be tagged with ALL of the provided
tags/categories or ANY single one. ANY will perform a weighted
@ -651,7 +651,7 @@ class TypeclassManager(TypedObjectManager):
Args:
args (any): These are passed on as arguments to the default
django get method.
Kwargs:
Keyword Args:
kwargs (any): These are passed on as normal arguments
to the default django get method
Returns:
@ -673,7 +673,7 @@ class TypeclassManager(TypedObjectManager):
Args:
args (any): These are passed on as arguments to the default
django filter method.
Kwargs:
Keyword Args:
kwargs (any): These are passed on as normal arguments
to the default django filter method.
Returns:
@ -796,7 +796,7 @@ class TypeclassManager(TypedObjectManager):
Variation of get that not only returns the current typeclass
but also all subclasses of that typeclass.
Kwargs:
Keyword Args:
kwargs (any): These are passed on as normal arguments
to the default django get method.
Returns:
@ -821,7 +821,7 @@ class TypeclassManager(TypedObjectManager):
Args:
args (any): These are passed on as arguments to the default
django filter method.
Kwargs:
Keyword Args:
kwargs (any): These are passed on as normal arguments
to the default django filter method.
Returns:

4
evennia/typeclasses/models.py
View file

@ -311,7 +311,7 @@ class TypedObject(SharedMemoryModel):
Args:
Passed through to parent.
Kwargs:
Keyword Args:
Passed through to parent.
Notes:
@ -635,7 +635,7 @@ class TypedObject(SharedMemoryModel):
no_superuser_bypass (bool, optional): Turn off the
superuser lock bypass (be careful with this one).
Kwargs:
Keyword Args:
kwargs (any): Ignored, but is there to make the api
consistent with the object-typeclass method access, which
use it to feed to its hook methods.

8
evennia/utils/create.py
View file

@ -78,7 +78,7 @@ def create_object(
Create a new in-game object.
Kwargs:
Keyword Args:
typeclass (class or str): Class or python path to a typeclass.
key (str): Name of the new object. If not set, a name of
#dbref will be set.
@ -206,7 +206,7 @@ def create_script(
scripts. It's behaviour is similar to the game objects except
scripts has a time component and are more limited in scope.
Kwargs:
Keyword Args:
typeclass (class or str): Class or python path to a typeclass.
key (str): Name of the new object. If not set, a name of
#dbref will be set.
@ -439,7 +439,7 @@ def create_channel(
Args:
key (str): This must be unique.
Kwargs:
Keyword Args:
aliases (list of str): List of alternative (likely shorter) keynames.
desc (str): A description of the channel, for use in listings.
locks (str): Lockstring.
@ -505,7 +505,7 @@ def create_account(
the empty string, will be set to None.
password (str): Password in cleartext.
Kwargs:
Keyword Args:
typeclass (str): The typeclass to use for the account.
is_superuser (bool): Wether or not this account is to be a superuser
locks (str): Lockstring.

2
evennia/utils/evform.py
View file

@ -188,7 +188,7 @@ class EvForm(object):
"""
Initiate the form
Kwargs:
Keyword Args:
filename (str): Path to template file.
cells (dict): A dictionary mapping of {id:text}
tables (dict): A dictionary mapping of {id:EvTable}.

4
evennia/utils/evmenu.py
View file

@ -538,7 +538,7 @@ class EvMenu:
the menu. Deactivate for production use! When the debug flag is active, the
`persistent` flag is deactivated.
Kwargs:
Keyword Args:
any (any): All kwargs will become initialization variables on `caller.ndb._evmenu`,
to be available at run.
@ -943,7 +943,7 @@ class EvMenu:
raw_string (str): The raw default string entered on the
previous node (only used if the node accepts it as an
argument)
Kwargs:
Keyword Args:
any: Extra arguments to goto callables.
"""

32
evennia/utils/evtable.py
View file

@ -282,7 +282,7 @@ def wrap(text, width=_DEFAULT_WIDTH, **kwargs):
text (str): Text to wrap.
width (int, optional): Width to wrap `text` to.
Kwargs:
Keyword Args:
See TextWrapper class for available keyword args to customize
wrapping behaviour.
@ -303,7 +303,7 @@ def fill(text, width=_DEFAULT_WIDTH, **kwargs):
text (str): Text to fill.
width (int, optional): Width of fill area.
Kwargs:
Keyword Args:
See TextWrapper class for available keyword args to customize
filling behaviour.
@ -328,7 +328,7 @@ class EvCell(object):
Args:
data (str): The un-padded data of the entry.
Kwargs:
Keyword Args:
width (int): Desired width of cell. It will pad
to this size.
height (int): Desired height of cell. it will pad
@ -773,7 +773,7 @@ class EvCell(object):
"""
Reformat the EvCell with new options
Kwargs:
Keyword Args:
The available keyword arguments are the same as for `EvCell.__init__`.
Raises:
@ -932,7 +932,7 @@ class EvColumn(object):
Args:
Text for each row in the column
Kwargs:
Keyword Args:
All `EvCell.__init_` keywords are available, these
settings will be persistently applied to every Cell in the
column.
@ -947,7 +947,7 @@ class EvColumn(object):
coherent and lined-up column. Will enforce column-specific
options to cells.
Kwargs:
Keyword Args:
Extra keywords to modify the column setting. Same keywords
as in `EvCell.__init__`.
@ -979,7 +979,7 @@ class EvColumn(object):
use `ypos=0`. If not given, data will be inserted at the end
of the column.
Kwargs:
Keyword Args:
Available keywods as per `EvCell.__init__`.
"""
@ -998,7 +998,7 @@ class EvColumn(object):
"""
Change the options for the column.
Kwargs:
Keyword Args:
Keywords as per `EvCell.__init__`.
"""
@ -1013,7 +1013,7 @@ class EvColumn(object):
index (int): Index location of the cell in the column,
starting from 0 for the first row to Nrows-1.
Kwargs:
Keyword Args:
Keywords as per `EvCell.__init__`.
"""
@ -1053,7 +1053,7 @@ class EvTable(object):
Args:
Header texts for the table.
Kwargs:
Keyword Args:
table (list of lists or list of `EvColumns`, optional):
This is used to build the table in a quick way. If not
given, the table will start out empty and `add_` methods
@ -1207,7 +1207,7 @@ class EvTable(object):
nx (int): x size of table.
ny (int): y size of table.
Kwargs:
Keyword Args:
Keywords as per `EvTable.__init__`.
Returns:
@ -1534,7 +1534,7 @@ class EvTable(object):
Args:
args (str): These strings will be used as the header texts.
Kwargs:
Keyword Args:
Same keywords as per `EvTable.__init__`. Will be applied
to the new header's cells.
@ -1558,7 +1558,7 @@ class EvTable(object):
to input new column. If not given, column will be added to the end
of the table. Uses Python indexing (so first column is `xpos=0`)
Kwargs:
Keyword Args:
Other keywords as per `Cell.__init__`.
"""
@ -1622,7 +1622,7 @@ class EvTable(object):
input new row. If not given, will be added to the end of the table.
Uses Python indexing (so first row is `ypos=0`)
Kwargs:
Keyword Args:
Other keywords are as per `EvCell.__init__`.
"""
@ -1661,7 +1661,7 @@ class EvTable(object):
"""
Force a re-shape of the entire table.
Kwargs:
Keyword Args:
Table options as per `EvTable.__init__`.
"""
@ -1697,7 +1697,7 @@ class EvTable(object):
index (int): Which column to reformat. The column index is
given from 0 to Ncolumns-1.
Kwargs:
Keyword Args:
Column options as per `EvCell.__init__`.
Raises:

10
evennia/utils/inlinefuncs.py
View file

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

4
evennia/utils/optionclasses.py
View file

@ -113,7 +113,7 @@ class BaseOption(object):
where kwargs are a combination of those passed into this function and the
ones specified by the OptionHandler.
Kwargs:
Keyword Args:
any (any): Not used by default. These are passed in from self.set
and allows the option to let the caller customize saving by
overriding or extend the default save kwargs
@ -173,7 +173,7 @@ class BaseOption(object):
"""
Renders the Option's value as something pretty to look at.
Kwargs:
Keyword Args:
any (any): These are options passed by the caller to potentially
customize display dynamically.

8
evennia/utils/utils.py
View file

@ -1029,7 +1029,7 @@ def delay(timedelay, callback, *args, **kwargs):
callback (callable): Will be called as `callback(*args, **kwargs)`
after `timedelay` seconds.
args (any, optional): Will be used as arguments to callback
Kwargs:
Keyword Args:
persistent (bool, optional): should make the delay persistent
over a reboot or reload
any (any): Will be used as keyword arguments to callback.
@ -1073,7 +1073,7 @@ def run_async(to_execute, *args, **kwargs):
The callable will be executed using ProcPool, or in a thread
if ProcPool is not available.
Kwargs:
Keyword Args:
at_return (callable): Should point to a callable with one
argument. It will be called with the return value from
to_execute.
@ -1888,7 +1888,7 @@ def at_search_result(matches, caller, query="", quiet=False, **kwargs):
quiet (bool, optional): If `True`, no messages will be echoed to caller
on errors.
Kwargs:
Keyword Args:
nofound_string (str): Replacement string to echo on a notfound error.
multimatch_string (str): Replacement string to echo on a multimatch error.
@ -1953,7 +1953,7 @@ class LimitedSizeOrderedDict(OrderedDict):
"""
Limited-size ordered dict.
Kwargs:
Keyword Args:
size_limit (int): Use this to limit the number of elements
alloweds to be in this list. By default the overshooting elements
will be removed in FIFO order.

2
evennia/web/website/views.py
View file

@ -145,7 +145,7 @@ class EvenniaIndexView(TemplateView):
You can do whatever you want to it, but it must be returned at the end
of this method.
Kwargs:
Keyword Args:
any (any): Passed through.
Returns: