Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-29 20:17:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update the documentation of the contrib convert_gametime

Browse source
This commit is contained in:
Vincent Le Goff 2017-02-14 17:29:31 -08:00 • committed by Griatch
parent 7cd7d68a5a
commit e867b343cf
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
evennia/contrib/convert_gametime.py
View file

@ -143,7 +143,7 @@ def realtime_to_gametime(secs=0, mins=0, hrs=0, days=0, weeks=0,
def custom_gametime(absolute=False):
"""
Return the game time as a tuple of units, as defined in settings.
Return the custom game time as a tuple of units, as defined in settings.
Args:
absolute (bool, optional): return the relative or absolute time.
@ -172,7 +172,7 @@ def real_seconds_until(**kwargs):
times (str: int): the time units.
Example:
real_seconds_until(hour-5, min=10)
real_seconds_until(hour=5, min=10, sec=0)
Returns:
The number of real seconds before the given game time is up.
@ -230,8 +230,8 @@ def schedule(callback, repeat=False, **kwargs):
delay. If `repeat` is set to True, the callback will be called
again next time the game time matches the given time. The time
is given in units as keyword arguments. For instance:
>>> schedule(func, min=5) # Will call next hour at :05.
>>> schedule(func, hour=2, min=30) # Will call the next day at 02:30.
>>> schedule(func, min=5, sec=0) # Will call next hour at :05.
>>> schedule(func, hour=2, min=30, sec=0) # Will call the next day at 02:30.
Args:
callback (function): the callback function that will be called [1].