diff --git a/evennia/utils/utils.py b/evennia/utils/utils.py index 88ad8002c5..4aadc02768 100644 --- a/evennia/utils/utils.py +++ b/evennia/utils/utils.py @@ -1021,34 +1021,38 @@ _TASK_HANDLER = None def delay(timedelay, callback, *args, **kwargs): - """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. + """ + Delay the calling of a callback (function). 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)` after `timedelay` seconds. - args (any, optional): Will be used as arguments to callback + args (any): Will be used as arguments to callback. Keyword Args: - persistent (bool, optional): should make the delay persistent - over a reboot or reload - any (any, optional): Will be used as keyword arguments to callback. + persistent (bool, optional): If True the delay remains after a server restart. + persistent is False by default. + any (any): Will be used as keyword arguments to callback. Returns: - task (TaskHandlerTask): A task instance. - Reference: evennia.scripts.taskhandler.TaskHandlerTask + task (TaskHandlerTask): An instance of a task. + 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