Skip to main content
Version: 2.0.x

Interface: CalendarData

SimpleCalendar.CalendarData

Interface for all information about a calendar

Hierarchy​

  • IDataItemBase

    ↳ CalendarData

Properties​

currentDate​

• Optional currentDate: CurrentDateData

The current date of the calendar.

general​

• Optional general: GeneralSettingsData

The general settings for the calendar.

generalSettings​

• Optional generalSettings: GeneralSettingsData

deprecated Please use CalendarData.general instead. This will be removed when Foundry v10 Stable is released.

id​

• id: string

The unique ID of the data item

Inherited from​

IDataItemBase.id

leapYear​

• Optional leapYear: LeapYearData

The leap year settings for the calendar.

leapYearSettings​

• Optional leapYearSettings: LeapYearData

deprecated Please use CalendarData.leapYear instead. This will be removed when Foundry v10 Stable is released.

monthSettings​

• Optional monthSettings: MonthData[]

deprecated Please use CalendarData.months instead. This will be removed when Foundry v10 Stable is released.

months​

• Optional months: MonthData[]

An array of month settings for each month of the calendar.

moonSettings​

• Optional moonSettings: MoonData[]

deprecated Please use CalendarData.moons instead. This will be removed when Foundry v10 Stable is released.

moons​

• Optional moons: MoonData[]

An array of moon settings for each moon of the calendar.

name​

• Optional name: string

The optional name of the data item

Inherited from​

IDataItemBase.name

noteCategories​

• Optional noteCategories: NoteCategory[]

An array of note categories for the calendar.

numericRepresentation​

• Optional numericRepresentation: number

The optional numeric representation of the data item

Inherited from​

IDataItemBase.numericRepresentation

seasonSettings​

• Optional seasonSettings: SeasonData[]

deprecated Please use CalendarData.seasons instead. This will be removed when Foundry v10 Stable is released.

seasons​

• Optional seasons: SeasonData[]

An array of season settings for each season of the calendar.

time​

• Optional time: TimeData

The time settings for the calendar.

timeSettings​

• Optional timeSettings: TimeData

deprecated Please use CalendarData.time instead. This will be removed when Foundry v10 Stable is released.

weekdaySettings​

• Optional weekdaySettings: WeekdayData[]

deprecated Please use CalendarData.weekdays instead. This will be removed when Foundry v10 Stable is released.

weekdays​

• Optional weekdays: WeekdayData[]

An array of weekday settings for each weekday of the calendar.

year​

• Optional year: YearData

The year settings for the calendar.

yearSettings​

• Optional yearSettings: YearData

deprecated Please use CalendarData.year instead. This will be removed when Foundry v10 Stable is released.