Skip to main content
Version: Next

Interface: GeneralSettingsData

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

Extends​

  • IDataItemBase

Properties​

abbreviation?​

optional abbreviation: string

The abbreviated name of the data item.

Inherited from​

IDataItemBase.abbreviation

compactViewOptions​

compactViewOptions: object

The different display options tied to the compact view.

controlLayout​

controlLayout: CompactViewDateTimeControlDisplay

How to display the date/time control buttons.

dateFormat​

dateFormat: object

Formats used for display date and time information

chatTime​

chatTime: string

Date and time format used when displaying the in game timestamp on chat messages

date​

date: string

The format string used to display the date

monthYear​

monthYear: string

The format string used to display the month and year at the top of a calendar display

time​

time: string

The format string used to display the time

description?​

optional description: string

The optional description of the data item

Inherited from​

IDataItemBase.description

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

showAdvanced?​

optional showAdvanced: boolean

If to show the advanced options, this is not saved

Inherited from​

IDataItemBase.showAdvanced

showClock​

showClock: boolean

If to show the clock below the calendar