Class HolidayEvent

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

Inheritance
System.Object
HolidayEvent
Namespace: Eco.Gameplay.Holidays
Assembly: Eco.Gameplay.dll
Syntax
public sealed class HolidayEvent : ValueType

Constructors

HolidayEvent()

Declaration
public HolidayEvent()

HolidayEvent(HolidayEvent)

Declaration
public HolidayEvent(HolidayEvent holidayEvent)
Parameters
Type Name Description
HolidayEvent holidayEvent

HolidayEvent(String, Boolean, DateTime, DateTime)

Declaration
public HolidayEvent(string holidayName, bool enabled, DateTime startDate, DateTime endDate)
Parameters
Type Name Description
System.String holidayName
System.Boolean enabled
System.DateTime startDate
System.DateTime endDate

Properties

Enabled

Flag for enabling/disabling this holiday without removing it from the server's configuration. This is useful for holidays the server operator does not want to run.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

EndDate

Defines the end date of the holiday event. Years are automatically adjusted to match the current date.

Declaration
public DateTime EndDate { get; set; }
Property Value
Type Description
System.DateTime

HolidayName

The name of the holiday event. This name is also used for creating override content for the holiday on Eco Client. Example supplying "Christmas" here will look for override content called "OriginalName_Christmas".

Declaration
public string HolidayName { get; set; }
Property Value
Type Description
System.String

StartDate

Defines the start date of the holiday event. Years are automatically adjusted to match the current date.

Declaration
public DateTime StartDate { get; set; }
Property Value
Type Description
System.DateTime

Extension Methods