Class SpellSchoolApi

Allows for configuration related to Spell Schools. Currently, FontAwesome and RPG Awesome icons are officially supported.

Index

Constructors

Methods

Constructors

constructor

new SpellSchoolApi(): SpellSchoolApi
Returns SpellSchoolApi

Methods

setIcon

setIcon(schoolKey: string, iconClass: SupportedSpellSchoolIcon): void
Sets an icon class for a target school key.
Parameters
- schoolKey: string
  the key that represents a spell school, e.g. "abj" for Abjuration, "nec" for Necromancy, and "trs" for Transmutation
- iconClass: SupportedSpellSchoolIcon
  a class string for an <i> element
Returns void
Example: Changing the transmutation icon to some nice coins.
```
Hooks.once("tidy5e-sheet.ready", (api) => {
  api.config.spellSchool.setIcon('trs', 'fa-solid fa-coins');
});
```
- Defined in api/config/spell-school/SpellSchoolApi.ts:23