wowkit API
    Preparing search index...

    Class SpellsService

    Once, at the first login of the session. Regular work (@Interval) starts right after.

    Implements

    Index
    • The highest learned rank of a spell (by name, from the spellbook index).

      Parameters

      • spellId: number

      Returns number | undefined

    • The English spellbook name of a spell, for IDs the client does not name.

      Parameters

      • spellId: number | undefined

      Returns string | undefined

    • Every English spellbook name a spell may have (a renamed spell has two).

      Parameters

      • spellId: number | undefined

      Returns string[]

    • Parameters

      • spellId: number | undefined

      Returns SpellInfo | undefined

    • Parameters

      • spellId: number

      Returns string | undefined

    • Parameters

      • spellId: number | undefined

      Returns string | undefined

    • The rank number from the spell's subtext ("Rank 2"); undefined without a rank or text.

      Parameters

      • spellId: number

      Returns number | undefined

    • The texts of the spell's tooltip; undefined when the client has none.

      Parameters

      • spellId: number

      Returns string[] | undefined

    • Forgets cached lookups. shouldDropSpellBook also drops the spellbook index; otherwise only failed lookups are forgotten, so a newly learned rank resolves.

      Parameters

      • shouldDropSpellBook: boolean

      Returns void

    • Can the spell be cast right now (power, form, ...)? Undefined when the client gives no readable answer. Battle Shout with 0 rage: false.

      Parameters

      • spellId: number

      Returns boolean | undefined

    • Parameters

      • spellId: number | undefined

      Returns boolean

    • One spell ID of each spell in the player's spell book (and the pet's); empty until the book is read.

      Returns number[]

    • A spell was just learned (LEARNED_SPELL_IN_SKILL_LINE): add it to the ranks of its name.

      Parameters

      • spellId: number | undefined

      Returns void

    • Rebuilds the spellbook index (see SpellBookService.rebuild).

      Parameters

      • isImmediate: boolean

      Returns void

    • The spell ID the player knows for this spell (by ID, override, name and spellbook).

      Parameters

      • spellId: number | undefined

      Returns number | undefined

    • The ID of a spell given by name (a cast name, a poison name).

      Parameters

      • name: string | undefined

      Returns number | undefined

    • The ID the player knows for this spell, or the ID itself when none is known.

      Parameters

      • spellId: number

      Returns number