Hooks

Here are all the hooks that Simple Calendar emits and when they are emitted.

How to Listen for a Hook

The global Simple Calendar object comes with a variable called hooks which will list all the available hooks that can be listened for.

Example:

SimpleCalendar.Hooks.DateTimeChange

The current hooks that are emitted are:

Hook Name	Value	Description
DateTimeChange	"simple-calendar-date-time-change"	This hook is emitted any time the current date is updated.
ClockStartStop	"simple-calendar-clock-start-stop"	This hook is emitted any time the clock is started/stopped or paused.

Date/Time Change

When it is emitted

This hook is emitted any time the current date is updated. The current date can be updated by several means:

• When the GM clicks on the "Set Current Date" button after adjusting the current date.
• When the Set Date/Time macro is called.
• When the Change Date/Time macro is called.
• When importing settings from about-time or Calendar/Weather.
• When the game world time has changed and Simple Calendar is configured to update when that changes.

What is passed

When this hook is emitted it will pass a data object that contains information about the new current day. The object will have these top level properties:

Property Name	Default Value	Description
year	{} - Empty Object	This property will contain all information about the current year. For a breakdown of that information see below.
month	{} - Empty Object	This property will contain all information about the current month. For a breakdown of that information see below.
day	{} - Empty Object	This property will contain all information about the current day. For a breakdown of that information see below.
time	{} - Empty Object	This property will contain all information about the current time. For a breakdown of that information see below.
season	{} - Empty Object	This property will contain all information about the current season. For a breakdown of that information see below.
moons	[] - Empty Array	This property will contain all information about the current moons. For a breakdown of that information see below.

Year Properties

Property Name	Value Type	Description
number	number	This is the current years numerical representation.
prefix	string	This is the text that appears before the years numerical representation.
postfix	string	This is the test that appears after the years numerical representation.
isLeapYear	boolean	If this year is a leap year.

Month Properties

Property Name	Value Type	Description
number	number	The months numerical representation.
name	string	The name of the month.
numberOfDays	number	How many days are in this month.
numberOfLeapYearDays	number	How many days are in this month during a leap year.
intercalary	boolean	If this month is considered an intercalary month or not.

Day Properties

Property Name	Value Type	Description
number	number	The days numerical representation.

Time Properties

Property Name	Value Type	Description
hour	string	The number of hours into the day it currently is. This result is 0 padded.
minute	string	The number of minutes into the day it currently is. This result is 0 padded.
second	string	The number of seconds into the day it currently is. This result is 0 padded.

Season Properties

Property Name	Value Type	Description
name	string	The name of the season.
color	string	The hex color representation of the season.

Moon Properties

The moon properties is an array of moon objects, one for every moon in the calendar. The moon object is detailed below:

Property Name	Value Type	Description
name	string	The name of the moon.
color	string	The hex color representation of the moon.
cycleLength	number	The number of calendar days for 1 cycle of the moon.
cycleDayAdjust	number	A entered adjustment used when calculating the current day of a cycle.
currentPhase	object	An object containing details about the phase the moon is in on this day.

Moon Phase Properties

Property Name	Value Type	Description
name	string	The name of this moon phase.
icon	string	The css class associated with this moons phase to give the proper icon.
length	number	How many days of the cycle this phase lasts.
singleDay	boolean	If this phase should only happen on one day.

Examples

Hooking to

This is an example of how to listen for the hook:

Hooks.on(SimpleCalendar.Hooks.DateTimeChange, (data) => {
    console.log(data);
});

Response Data

This is an example of the data that is passed with this hook:

{
    "year": {
        "number": 2021,
        "prefix": "",
        "postfix": "",
        "isLeapYear": false
    },
    "month": {
        "name": "April",
        "number": 4,
        "intercalary": false,
        "numberOfDays": 30,
        "numberOfLeapYearDays": 30
    },
    "day": {
        "number": 13
    },
    "time": {
        "hour": "00",
        "minute": "00",
        "second": "56"
    },
    "season": {
        "name": "Spring",
        "color": "#fffce8"
    },
    "moons": [
        {
            "name": "Moon",
            "color": "#ffffff",
            "cycleLength": 29.53059,
            "cycleDayAdjust": 0.5,
            "currentPhase": {
                "name": "Waxing Crescent",
                "length": 6.3826,
                "icon": "waxing-crescent",
                "singleDay": false
            }
        }
    ]
}

Clock Start/Stop

When it is emitted

This event is emitted in the followin cases:

• When the clock is started.
• When the clock is stopped.
• When the game is paused or unpaused.
• When a combat is started or ended in the active scene
• When a combat round is advanced.

What is passed

When this hook is emitted it will pass a data object that contains the following properties:

Property Name	Value Type	Description
started	boolean	If the clock is started and running.
stopped	boolean	If the clock is stopped and not running.
paused	boolean	If the clock is paused. The clock is paused when the game is paused or there is an active combat running in the active scene.

Examples

Hooking to

This is an example of how to listen for the hook:

Hooks.on(SimpleCalendar.Hooks.ClockStartStop, (data) => {
    console.log(data);
});

Response Data

This is an example of the data that is passed with this hook:

{
  "started": false,
  "stopped": true,
  "paused": false
}

Is Primary GM

When it is emitted

This eventn is emitted when the current users is promoted to the primary GM role.

This will happen 5 seconds after loading the game if no other GM is currently in the primary role.

What is passed

Property Name	Value Type	Description
isPrimaryGM	boolean	If the user is the primary gm (true).

Examples

Hooking to

This is an example of how to listen for the hook:

Hooks.on(SimpleCalendar.Hooks.PrimaryGM, (data) => {
    console.log(data);
});

Response Data

This is an example of the data that is passed with this hook:

{
  "isPrimaryGM": true
}