Interface: GeneralSettingsData
SimpleCalendar.GeneralSettingsData
Interface for all general settings for a calendar in the Simple Calendar module
Hierarchy
-
IDataItemBase↳
GeneralSettingsData
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.
Type declaration
| Name | Type | Description |
|---|---|---|
controlLayout | CompactViewDateTimeControlDisplay | How to display the date/time control buttons. |
dateFormat
• dateFormat: Object
Formats used for display date and time information
Type declaration
| Name | Type | Description |
|---|---|---|
chatTime | string | Date and time format used when displaying the in game timestamp on chat messages |
date | string | The format string used to display the date |
monthYear | string | The format string used to display the month and year at the top of a calendar display |
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