holiday

Vars
always_celebrate	for christmas neverending, or testing. Forces a holiday to be celebrated.
begin_day	What day of begin_month does the holiday begin on?
begin_month	What month does the holiday begin on?
current_year	Held variable to better calculate when certain holidays may fall on, like easter.
end_day	What day of end_month does the holiday end? Default of 0 means the holiday lasts a single.
end_month	What month does the holiday end on?
holiday_colors	Color scheme for this holiday
holiday_hat	If this is defined, drones/assistants without a default hat will spawn with this item in their head clothing slot.
holiday_mail	The list of items we add to the mail pool. Can either be a weighted list or a normal list. Leave empty for nothing.
holiday_pattern	The default pattern of the holiday, if the requested pattern is null.
name	Name of the holiday itself. Visible to players.
no_mail_holiday	When this holiday is active, does this prevent mail from arriving to cargo? Overrides var/list/holiday_mail. Try not to use this for longer holidays.
timezones	Timezones this holiday is celebrated in (defaults to three timezones spanning a 50 hour window covering all timezones)
year_offset	How many years are you offsetting your calculations for begin_day and end_day on. Used for holidays like easter.
Procs
get_holiday_colors	Procs to return holiday themed colors for recoloring atoms

Var Details

var
always_celebrate
–

for christmas neverending, or testing. Forces a holiday to be celebrated.

var
begin_day
–

What day of begin_month does the holiday begin on?

var
begin_month
–

What month does the holiday begin on?

var
current_year
–

Held variable to better calculate when certain holidays may fall on, like easter.

var
end_day
–

What day of end_month does the holiday end? Default of 0 means the holiday lasts a single.

var
end_month
–

What month does the holiday end on?

var
holiday_colors
– /list

Color scheme for this holiday

var
holiday_hat
– /obj/item

If this is defined, drones/assistants without a default hat will spawn with this item in their head clothing slot.

var
holiday_mail
– /list

The list of items we add to the mail pool. Can either be a weighted list or a normal list. Leave empty for nothing.

var
holiday_pattern
–

The default pattern of the holiday, if the requested pattern is null.

var
name
–

Name of the holiday itself. Visible to players.

var
no_mail_holiday
–

When this holiday is active, does this prevent mail from arriving to cargo? Overrides var/list/holiday_mail. Try not to use this for longer holidays.

var
timezones
– /list

Timezones this holiday is celebrated in (defaults to three timezones spanning a 50 hour window covering all timezones)

var
year_offset
–

How many years are you offsetting your calculations for begin_day and end_day on. Used for holidays like easter.

Proc Details

proc
get_holiday_colors
(/atom/thing_to_color, pattern)

Procs to return holiday themed colors for recoloring atoms

holiday /datum/holiday

Vars

Procs

Var Details

var always_celebrate –

var begin_day –

var begin_month –

var current_year –

var end_day –

var end_month –

var holiday_colors – /list

var holiday_hat – /obj/item

var holiday_mail – /list

var holiday_pattern –

var name –

var no_mail_holiday –

var timezones – /list

var year_offset –