Namespace Eco.Gameplay.Holidays

Classes

HolidayConfig

Configuration model used by the HolidayPlugin instance loaded from the "Holiday.eco" file in the server's config directory.

HolidayEvent

Represents a configured holiday event that can be run on Eco Server.

HolidayManager

Singleton plugin class that manages holidays. This class is responsible for checking if holidays are enabled and swapping out the current holiday. To utilize this on the client create addressable override content following the name pattern of NormalName_HolidayName. For example if you wanted to create a holiday for "Christmas" that changed the elk to reindeer you would create a new addressable override content called "Elk_Christmas". When no override content is present the default content is used.

This system can also be utilized from Eco's modkit. Overridable content can also be loaded from a mod's AssetBundle. Create a GameObject with the same name scheme in the mod's objects scene.

HolidayPlugin

Singleton plugin class that manages holidays. This class is responsible for checking if holidays are enabled and swapping out the current holiday. To utilize this on the client create addressable override content following the name pattern of NormalName_HolidayName. For example if you wanted to create a holiday for "Christmas" that changed the elk to reindeer you would create a new addressable override content called "Elk_Christmas". When no override content is present the default content is used.

This system can also be utilized from Eco's modkit. Overridable content can also be loaded from a mod's AssetBundle. Create a GameObject with the same name scheme in the mod's objects scene.