Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

utils.delay docstring update

Browse source 
Updated docstring to show delay returns a TaskHandlerTask instance.
This commit is contained in:
davewiththenicehat 2021-05-11 16:46:19 -04:00
parent deb6194aaa
commit 1cc1731d54
1 changed files with 24 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

44
evennia/utils/utils.py
View file

@ -1021,34 +1021,38 @@ _TASK_HANDLER = None
def delay(timedelay, callback, *args, **kwargs): 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: Args:
timedelay (int or float): The delay in seconds timedelay (int or float): The delay in seconds.
callback (callable): Will be called as `callback(*args, **kwargs)` callback (callable): Will be called as `callback(*args, **kwargs)`
after `timedelay` seconds. after `timedelay` seconds.
args (any, optional): Will be used as arguments to callback args (any): Will be used as arguments to callback.
Keyword Args: Keyword Args:
persistent (bool, optional): should make the delay persistent persistent (bool, optional): If True the delay remains after a server restart.
over a reboot or reload persistent is False by default.
any (any, optional): Will be used as keyword arguments to callback. any (any): Will be used as keyword arguments to callback.
Returns: Returns:
task (TaskHandlerTask): A task instance. task (TaskHandlerTask): An instance of a task.
Reference: evennia.scripts.taskhandler.TaskHandlerTask Refer to, evennia.scripts.taskhandler.TaskHandlerTask
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 persistent tasks whose time delays have passed will be called on server startup.
""" """
global _TASK_HANDLER global _TASK_HANDLER