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

Rename convert_gamescript to custom_gamescript to reflect its new function. Change names of the settings variables used to TIME_* to better match the settings naming style elsewhere. Add updated docstring to module; pertains to #1217.

Browse source
This commit is contained in:
Griatch 2017-02-16 00:04:01 +01:00
parent b91e12db20
commit 1b3fb8fca9
2 changed files with 27 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

5
evennia/contrib/README.md
View file

@ -19,9 +19,8 @@ things you want from here into your game folder and change them there.
for any game. Allows safe trading of any godds (including coin) for any game. Allows safe trading of any godds (including coin)
* CharGen (Griatch 2011) - A simple Character creator for OOC mode. * CharGen (Griatch 2011) - A simple Character creator for OOC mode.
Meant as a starting point for a more fleshed-out system. Meant as a starting point for a more fleshed-out system.
* Convert_gametime (Griatch 2017) - converter routines broken out * Custom gametime (Griatch, vlgeoff 2017) - Implements Evennia's
of evennia.utils.gametime. Converts seconds to parts of years with gametime module but for custom game world-specific calendars.
an arbitrary number of weeks/months etc.
* Dice (Griatch 2012) - A fully featured dice rolling system. * Dice (Griatch 2012) - A fully featured dice rolling system.
* Email-login (Griatch 2012) - A variant of the standard login system * Email-login (Griatch 2012) - A variant of the standard login system
that requires an email to login rather then just name+password. that requires an email to login rather then just name+password.

42
evennia/contrib/convert_gametime.py → evennia/contrib/custom_gametime.py
View file

@ -1,18 +1,25 @@
""" """
Convert gametime Custom gametime
Contrib - Griatch 2017 Contrib - Griatch 2017, vlgeoff 2017
This is the game-dependent part of the evennia.utils.gametime module This implements the evennia.utils.gametime module but supporting
that used to be settable from the settings file. Since this was just a custom calendar for your game world. It allows for scheduling
a bunch of conversion routines, it is now moved to a contrib since it events to happen at given in-game times, taking this custom
is highly unlikely its use is of general game use. The utils.gametime calendar into account.
module deals in seconds, and you can use this contrib to convert
that to fit the calendar of your game.
Usage: Usage:
Import and use as-is or copy this module to mygame/world and
modify it to your needs there. Use as the normal gametime module, that is by importing and using the
helper functions in this module in your own code. The calendar can be
specified in your settings file by adding and setting custom values
for one or more of the variables `TIME_SECS_PER_MIN`,
`TIME_MINS_PER_HOUR`, `TIME_DAYS_PER_WEEK`, `TIME_WEEKS_PER_MONTH` and
`TIME_MONTHS_PER_YEAR`. These are all given in seconds and whereas
they are called "week", "month" etc these names could represent
whatever fits your game. You can also set `TIME_UNITS` to a dict
mapping the name of a unit to its length in seconds (like `{"min":
60, ...}. If not given, sane defaults will be used.
""" """
@ -30,12 +37,13 @@ TIMEFACTOR = settings.TIME_FACTOR
# when defining in-game events. The words month, week and year can be # when defining in-game events. The words month, week and year can be
# used to mean whatever units of time are used in your game. # used to mean whatever units of time are used in your game.
SEC = 1 SEC = 1
MIN = getattr(settings, "SECS_PER_MIN", 60) MIN = getattr(settings, "TIME_SECS_PER_MIN", 60)
HOUR = getattr(settings, "MINS_PER_HOUR", 60) * MIN HOUR = getattr(settings, "TIME_MINS_PER_HOUR", 60) * MIN
DAY = getattr(settings, "HOURS_PER_DAY", 24) * HOUR DAY = getattr(settings, "TIME_HOURS_PER_DAY", 24) * HOUR
WEEK = getattr(settings, "DAYS_PER_WEEK", 7) * DAY WEEK = getattr(settings, "TIME_DAYS_PER_WEEK", 7) * DAY
MONTH = getattr(settings, "WEEKS_PER_MONTH", 4) * WEEK MONTH = getattr(settings, "TIME_WEEKS_PER_MONTH", 4) * WEEK
YEAR = getattr(settings, "MONTHS_PER_YEAR", 12) * MONTH YEAR = getattr(settings, "TIME_MONTHS_PER_YEAR", 12) * MONTH
# these are the unit names understood by the scheduler.
UNITS = getattr(settings, "TIME_UNITS", { UNITS = getattr(settings, "TIME_UNITS", {
"sec": SEC, "sec": SEC,
"min": MIN, "min": MIN,
@ -246,7 +254,7 @@ def schedule(callback, repeat=False, **kwargs):
""" """
seconds = real_seconds_until(**kwargs) seconds = real_seconds_until(**kwargs)
script = create_script("evennia.contrib.convert_gametime.GametimeScript", script = create_script("evennia.contrib.custom_gametime.GametimeScript",
key="GametimeScript", desc="A timegame-sensitive script", key="GametimeScript", desc="A timegame-sensitive script",
interval=seconds, start_delay=True, interval=seconds, start_delay=True,
repeats=-1 if repeat else 1) repeats=-1 if repeat else 1)