Show / Hide Table of Contents

Class 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.

Inheritance
System.Object
HolidayPlugin
Implements
IThreadedPlugin
IShutdownablePlugin
IServerPlugin
IInitializablePlugin
Namespace: Eco.Gameplay.Holidays
Assembly: Eco.Gameplay.dll
Syntax
public sealed class HolidayPlugin : EditablePlugin<HolidayManager, HolidayConfig>, IThreadedPlugin, IShutdownablePlugin, IServerPlugin, IInitializablePlugin

Constructors

HolidayPlugin()

Declaration
public HolidayPlugin()

Methods

Initialize(TimedTask)

Declaration
public void Initialize(TimedTask timer)
Parameters
Type Name Description
TimedTask timer

Run()

Declaration
public void Run()

ShutdownAsync()

Declaration
public Task ShutdownAsync()
Returns
Type Description
System.Threading.Tasks.Task

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

IThreadedPlugin
IShutdownablePlugin
IServerPlugin
IInitializablePlugin

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾