SS1984 - Modules - TypesVar Details - Proc Details

holiday

Vars

end_dayDefault of 0 means the holiday lasts a single day
lobby_musicList of youtube URLs for lobby music to use during this holiday

Procs

celebrateThis proc gets run before the game starts when the holiday is activated. Important note: it runs before mapping subsystem init, do not place/alter objects in world using this proc.
getStationPrefixReturns special prefixes for the station name on certain days. You wind up with names like "Christmas Object Epsilon". See new_station_name()
greetWhen the round starts, this proc is ran to get a text message to display to everyone to wish them a happy holiday
handle_eventUsed for special holiday events. Called only after Master Controller has been loaded. (a.k.a initializations complete.) Use this proc to manipulate objects and systems after MC load or mapload.
shouldCelebrateReturn 1 if this holiday should be celebrated today

Var Details

end_day

Default of 0 means the holiday lasts a single day

lobby_music

List of youtube URLs for lobby music to use during this holiday

Proc Details

celebrate

This proc gets run before the game starts when the holiday is activated. Important note: it runs before mapping subsystem init, do not place/alter objects in world using this proc.

getStationPrefix

Returns special prefixes for the station name on certain days. You wind up with names like "Christmas Object Epsilon". See new_station_name()

greet

When the round starts, this proc is ran to get a text message to display to everyone to wish them a happy holiday

handle_event

Used for special holiday events. Called only after Master Controller has been loaded. (a.k.a initializations complete.) Use this proc to manipulate objects and systems after MC load or mapload.

shouldCelebrate

Return 1 if this holiday should be celebrated today