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

delay docstring update

Browse source 
delay docstring update

The old one had not been properly updated or formatted.
This commit is contained in:
davewiththenicehat 2021-05-10 12:38:47 -04:00
parent 76c1e09c84
commit deb6194aaa
1 changed files with 19 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

48
evennia/utils/utils.py
View file

@ -1021,44 +1021,34 @@ _TASK_HANDLER = None
def delay(timedelay, callback, *args, **kwargs):
"""
Delay the calling of a callback (function).
"""Delay the calling of a callback (function).
The task handler (`evennia.scripts.taskhandler.TaskHandler`) will
be called for persistent or non-persistent tasks.
If persistent is set to True.
The callback, its arguments and other keyword arguments will be saved
(serialized) in the database, assuming they can be. The callback will
be executed even after a server restart/reload, taking into account the
specified delay (and server down time).
Keep in mind that persistent tasks arguments and callback should not
use memory references.
All task's whose time delays have passed will be called on server startup.
Args:
timedelay (int or float): The delay in seconds
callback (callable): Will be called as `callback(*args, **kwargs)`
after `timedelay` seconds.
args (any, optional): Will be used as arguments to callback
Keyword Args:
persistent (bool, optional): Should make the delay persistent
over a reboot or reload. Defaults to False.
any (any): Will be used as keyword arguments to callback.
persistent (bool, optional): should make the delay persistent
over a reboot or reload
any (any, optional): Will be used as keyword arguments to callback.
Returns:
deferred or int: If ``persistent`` kwarg is `False`, return deferred
that will fire with callback after `timedelay` seconds. Note that
if `timedelay()` is used in the commandhandler callback chain, the
callback chain can be defined directly in the command body and
don't need to be specified here. Reference twisted.internet.defer.Deferred.
If persistent kwarg is set, return the task's ID as an integer. This is
intended for use with ``evennia.scripts.taskhandler.TASK_HANDLER``
`.do_task` and `.remove` methods.
Note:
The task handler (`evennia.scripts.taskhandler.TASK_HANDLER`) will
be called for persistent or non-persistent tasks.
If persistent is set to True, the callback, its arguments
and other keyword arguments will be saved (serialized) in the database,
assuming they can be. The callback will be executed even after
a server restart/reload, taking into account the specified delay
(and server down time).
Keep in mind that persistent tasks arguments and callback should not
use memory references.
If persistent is set to True the delay function will return an int
which is the task's id itended for use with TASK_HANDLER's do_task
and remove methods.
All task's whose time delays have passed will be called on server startup.
task (TaskHandlerTask): A task instance.
Reference: evennia.scripts.taskhandler.TaskHandlerTask
"""
global _TASK_HANDLER