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

Update docstring: Better describes the limits of the callables possible to use with TickerHandler.

Browse source
This commit is contained in:
Griatch 2016-09-01 15:14:53 +02:00
parent c8909b4b67
commit 949aeee806
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
evennia/scripts/tickerhandler.py
View file

@ -18,8 +18,15 @@ Example:
TICKER_HANDLER.add(15, myobj.at_tick, *args, **kwargs) TICKER_HANDLER.add(15, myobj.at_tick, *args, **kwargs)
``` ```
You supply the interval to tick and a callable to call regularly You supply the interval to tick and a callable to call regularly with
with any extra args/kwargs. The handler will transparently set any extra args/kwargs. The callable should either be a stand-alone
function in a module *or* the method on a *typeclassed* entity (that
is, on an object that can be safely and stably returned from the
database). Functions that are dynamically created or sits on
in-memory objects cannot be used by the tickerhandler (there is no way
to reference them safely across reboots and saves).
The handler will transparently set
up and add new timers behind the scenes to tick at given intervals, up and add new timers behind the scenes to tick at given intervals,
using a TickerPool - all callables with the same interval will share using a TickerPool - all callables with the same interval will share
the interval ticker. the interval ticker.
@ -470,7 +477,8 @@ class TickerHandler(object):
a server reload. If this is unset, the ticker will be a server reload. If this is unset, the ticker will be
deleted by a server shutdown. deleted by a server shutdown.
args, kwargs (optional): These will be passed into the args, kwargs (optional): These will be passed into the
callback every time it is called. callback every time it is called. This must be data possible
to pickle!
Notes: Notes:
The callback will be identified by type and stored either as The callback will be identified by type and stored either as