Spells Tab Revamp

Introduction

Started by James Dempsey to implement the following feature requests:

• 1104393 - Spellbook as containers [1]
• 1082837 - Some classes need both spellbooks and memorised spell lists [2]
• 871933 - Spell memorization warning [3]
• 918062 - Pearl of Power Support [4]
• 919783 - Expansion ideas on the Spells tab [5]
• 1094612 - Pages for Spellbook [6]
• 1199739 - Prepared Spells spell book on Spells tab [7]

Basic assumptions

• There are 3 types of spell collections:
  • Known spells
  • Prepared spells
  • Spellbooks
• Frequent cases should be made as easy as possible
• Less frequent cases should be made reasonably intuitive to use, but may be less streamlined
• All fields should be fully displayed and usable in 800x600, i.e. no overlapping or hidden fields and enough info displayed to be useful.
• Same general UI as the rest of PCGen – i.e. tabs and subtabs with selection lists
• Multiple selection and addition should be supported
• Some books grant spells from feats or other one off sources - not all spells source from class levels

Requirement thoughts

• Cleric/Druid/ etc Known spells – expected to be automatic, but allow for exclusions
• Wizard Known Spells – should be setup to allow the easy use of spell books, either by auto adding new known spells to the current default book, or adding spells to the known list when they are added to a book designated as representing part of the wizards known collection
• Captured spell books – allow for spells not in known list as well as transfer of spells books between characters (NPC->PC), also allow for mastery of a spellbook, so auto add all spells to known list.
• Spells gained from feats/templates/etc. The system needs to decouple spells from the class level, and allow any object to grant a spell. If the object that grants the spell is not a class, there likely needs to be a variable or some such to base the level dependant effects off of. (This is for Midnight)
• Prepared Spells
  • Selection is from known spells only
  • Limit on number of prepared spells is always imposed
  • Obvious way to allow/disallow use of spell slots for lower level spells
  • Allow the use of metamagic
  • Incorporate pearls of power and rings of wizardry, or similar objects
• DCs etc for learning spells might be outside the scope of this exercise
• The term book should only be used when referring to physical books

Use Cases

1. Add a known spell where there are no spellbooks (Completed 5.9.6)
2. Add a known spell where there are spellbooks (Completed 5.9.6)
3. Add a prepared spell from the list of known spells (Completed 5.9.6)
4. Add a prepared spell with a metamagic feat from the list of known spells (Completed 5.9.6)
5. Add a captured and unlearnt spellbook
6. Copy and learn a spell from a captured spellbook
7. Add a new spell to a spellbook, adding it to known at the same time
8. Transfer a spellbook from another character
9. Master a spellbook, adding all spells to known list.
10. Calculate the cost of a spellbook
11. Create a new spellbook. (Completed 5.9.6)
12. Add a spell that is allowable because of a feat or other source.
13. Add spells to a class' available spell list based on a race, class, feat, or domain.