Skip to main content
Version: 2.0.x

Interface: GeneralSettingsData

SimpleCalendar.GeneralSettingsData

Interface for all general settings for a calendar in the Simple Calendar module

Hierarchy​

  • IDataItemBase

    ↳ GeneralSettingsData

Properties​

dateFormat​

• dateFormat: Object

Formats used for display date and time information

Type declaration​

NameTypeDescription
datestringThe format string used to display the date
monthYearstringThe format string used to display the month and year at the top of a calendar display
timestringThe format string used to display the time

gameWorldTimeIntegration​

• gameWorldTimeIntegration: GameWorldTimeIntegrations

How Simple Calendar interacts with the game world time

id​

• id: string

The unique ID of the data item

Inherited from​

IDataItemBase.id

name​

• Optional name: string

The optional name of the data item

Inherited from​

IDataItemBase.name

noteDefaultVisibility​

• noteDefaultVisibility: boolean

The default visibility for new notes added to the calendar

numericRepresentation​

• Optional numericRepresentation: number

The optional numeric representation of the data item

Inherited from​

IDataItemBase.numericRepresentation

pf2eSync​

• pf2eSync: boolean

If the Pathfinder 2e world clock sync is turned on

playersAddNotes​

• Optional playersAddNotes: boolean

deprecated Old 'Players Can Add Notes' permission setting, only used for very old setting files

postNoteRemindersOnFoundryLoad​

• postNoteRemindersOnFoundryLoad: boolean

If note reminders should be PM'd to players when they log into foundry

showClock​

• showClock: boolean

If to show the clock below the calendar