Annikka/evennia
1
0
Fork 0
Code Issues Pull requests 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

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.