Hooks

📡 Hooks 📡

Hooooooooks

💸 WhetstoneReady

This hook is used to signal that whetstone is fully loaded and ready for your to register themes. This hook is fired after Foundry's 'ready' hook.

Hooks.once("WhetstoneReady", () => {

	// register themes
	game.Whetstone.themes.register(...);

	//register menus
	game.Whetstone.settings.registerMenu(...);
}

💎 onThemeActivate

This hook is called just before a theme is activated. You can return Boolean false to cancel.

/**
 * @param  {WhetstoneTheme} themeData          The theme being activated
 * @return {Boolean}                   Return false to prevent
 */
Hooks.on('onThemeActivate', (themeData) => {
	return true;
});

💍 onThemeActivated

This hook is called just after a theme is activated.

/**
 * @param  {WhetstoneTheme} themeData          The theme being activated
 */
Hooks.on('onThemeActivated', (themeData) => {
	//do stuff
});

💰 onThemeDeactivate

This hook is called just before a theme is deactivated. You can return Boolean false to cancel.

NOTE: When a theme is activated, Whetstone first deactivates all themes for a fresh slate meaning this hook is called many times when themes change.

/**
 * @param  {WhetstoneTheme} themeData          The theme being activated
 * @return {Boolean}                   Return false to prevent
 */
Hooks.on('onThemeDeactivate', (themeData) => {
	return true;
});

🧻 onThemeDeactivated

This hook is called just after a theme is deactivated.

/**
 * @param  {WhetstoneTheme} themeData          The theme being deactivated
 */
Hooks.on('onThemeDeactivated', (themeData) => {
	//do stuff
});

💳 update<ThemeID>

This hook is called just after a setting has been updated for the given theme.

/**
 * @param  {Object} settingData          The settings object being updated
 * @param  {Object} newValue          New™! The value's new value
 * @param  {Object} currentValue          The current stinky value
 */
Hooks.on('updateOceanBlues', (settingData, newValue, currentValue) => {
	// do things
});

// casing must match theme's id ('MyTheme', 'CharliesChocolateFaCtOrY', etc..)
Hooks.on('updateCharliesChocolateFaCtOrY', (settingData, newValue, currentValue) => {
	// do things
});