Skip to content

Reference

tilttek/seasonal-events

Every public type of the package, with its role.

TypeRole
SeasonScheduleWhen a season comes, in its timezone: once, or each year by a yearly rule.
PeriodOne time a season comes, with its code, the date of its first day.
SeasonA season: its identifier, schedule, contents and events.
SeasonalEventAn event inside a season, with its contents, announcement and multiplier.
ContentOne thing a season or an event brings: a kind and a reference.
ContentKindQuest, Item or Decoration.
MultiplierA multiplier of the gains of a ledger, in percent, rounded down.
SeasonalEventsThe questions of a moment: what is on, what is announced, the next time of a season; implements ActiveContent.
SnapshotWhat is on at one moment.
ActiveSeasonA season in the time it is on.
ActiveEventAn event in one time of its season, with when it runs and when it is announced.
DaysThe calendar arithmetic of the library: dates as numbers of days, and the start of a day in a timezone.
SeasonReaderSeasons read from plain arrays and written back.
Contract\SeasonCatalogueWhere the seasons come from.
Contract\ActiveContentThe port the other packages read what is on through.
Store\InMemorySeasonCatalogueSeasons given once, in code or read from a configuration.
Bridge\Quests\SeasonQuestScheduleThe schedule of a tilttek/quests quest that opens with a season or an event.
Bridge\Collections\SeasonalItemsThe tilttek/collections items the seasons bring at a moment.
Exception\SeasonalEventsExceptionEvery exception of the library.
Exception\InvalidSeasonA value the library refuses, with the reason.