Class ClientSettings

menus

settings

storage

sheet

• get sheet(): SettingsConfig

  Return a singleton instance of the Game Settings Configuration app

  Returns SettingsConfig

get

• get(namespace: string, key: string, options?: { document?: boolean }): any

  Get the value of a game setting for a certain namespace and setting key

  Parameters

  • namespace: string

    The namespace under which the setting is registered

  • key: string

    The setting key to retrieve

  • options: { document?: boolean } = {}

    Additional options for setting retrieval

    • Optionaldocument?: boolean

      Retrieve the full Setting document instance instead of just its value

  Returns any

  The current value or the Setting document instance

  Example: Retrieve the current setting value

  game.settings.get("myModule", "myClientSetting");
  Copy

register

• register(namespace: string, key: string, data: SettingConfig): void

  Register a new namespaced game setting. The setting's scope determines where the setting is saved. World - World settings are applied to everyone in the World. Use this for settings like system rule variants that everyone must abide by. User - User settings are applied to an individual user. Use this for settings that are a player's personal preference, like 3D dice skins. Client - Client settings are applied to the browser or client used to access the World. Use this for settings that are affected by the client itself, such as screen dimensions, resolution, or performance.

  Parameters

  • namespace: string

    The namespace under which the setting is registered

  • key: string

    The key name for the setting under the namespace

  • data: SettingConfig

    Configuration for setting data

  Returns void

  Example: Register a client setting

  game.settings.register("myModule", "myClientSetting", {
    name: "Register a Module Setting with Choices",
    hint: "A description of the registered setting and its behavior.",
    scope: "client",     // This specifies a client-stored setting
    config: true,        // This specifies that the setting appears in the configuration view
    requiresReload: true // This will prompt the user to reload the application for the setting to take effect.
    type: String,
    choices: {           // If choices are defined, the resulting setting will be a select menu
      "a": "Option A",
      "b": "Option B"
    },
    default: "a",        // The default value for the setting
    onChange: value => { // A callback function which triggers when the setting is changed
      console.log(value)
    }
  });
  Copy

  Example: Register a world setting

  game.settings.register("myModule", "myWorldSetting", {
    name: "Register a Module Setting with a Range slider",
    hint: "A description of the registered setting and its behavior.",
    scope: "world",      // This specifies a world-level setting
    config: true,        // This specifies that the setting appears in the configuration view
    requiresReload: true // This will prompt the GM to have all clients reload the application for the setting to
                         // take effect.
    type: new foundry.fields.NumberField({nullable: false, min: 0, max: 100, step: 10}),
    default: 50,         // The default value for the setting
    onChange: value => { // A callback function which triggers when the setting is changed
      console.log(value)
    }
  });
  Copy

  Example: Register a user setting

  game.settings.register("myModule", "myUserSetting", {
    name: "Register a Module Setting with a checkbox",
    hint: "A description of the registered setting and its behavior.",
    scope: "user",       // This specifies a user-level setting
    config: true,        // This specifies that the setting appears in the configuration view
    type: new foundry.fields.BooleanField(),
    default: false
  });
  Copy

registerMenu

• registerMenu(namespace: string, key: string, data: SettingSubmenuConfig): void

  Register a new sub-settings menu

  Parameters

  • namespace: string

    The namespace under which the menu is registered

  • key: string

    The key name for the setting under the namespace

  • data: SettingSubmenuConfig

    Configuration for setting data

  Returns void

  Example: Define a settings submenu which handles advanced configuration needs

  game.settings.registerMenu("myModule", "mySettingsMenu", {
    name: "My Settings Submenu",
    label: "Settings Menu Label",      // The text label used in the button
    hint: "A description of what will occur in the submenu dialog.",
    icon: "fa-solid fa-bars",               // A Font Awesome icon used in the submenu button
    type: MySubmenuApplicationClass,   // A FormApplication subclass which should be created
    restricted: true                   // Restrict this submenu to gamemaster only?
  });
  Copy

set

• set(
      namespace: string,
      key: string,
      value: any,
      options?: { document?: boolean },
  ): Promise<any>

  Set the value of a game setting for a certain namespace and setting key

  Parameters

  • namespace: string

    The namespace under which the setting is registered

  • key: string

    The setting key to retrieve

  • value: any

    The data to assign to the setting key

  • Optionaloptions: { document?: boolean } = {}

    Additional options passed to the server when updating world-scope settings

    • Optionaldocument?: boolean

      Return the updated Setting document instead of just its value

  Returns Promise<any>

  The assigned setting value or the Setting document instance

  Example: Update the current value of a setting

  game.settings.set("myModule", "myClientSetting", "b");
  Copy