Undo/redo for the scenario editor

[CelticMinstrel]

The basic framework for undo is already implemented (and possibly working localized to editable text fields in dialogs), but actions need to be defined for everything the designer can do, and the system needs to be enabled by making the menuitems update correctly. It would also be beneficial to have an undo list viewer so people can see the history, but that's not a high priority.

This is probably a comprehensive list of all actions. I've organized them by type rather than by context.

• Actions that alter terrain:
  • Painting operations with the mouse should "commit" on mouse release. So dragging the mouse across the map is one operation, and clicking 4 times is 4 operations.
  • Pencil
  • Paintbrush (two sizes)
  • Spraycan (two sizes)
  • Eraser
  • Hollow Rectangle
  • Filled Rectangle
  • Bucket
  • Change Terrain Randomly
    • Frill up Terrain and Remove Terrain Frills (from menu) are really a special case of this.
  • Note: Placing a sign terrain automatically triggers an Edit Sign operation afterwards. Should that be bundled in or pushed as a separate action?
• Actions that place an entity on the map:
  • Place Special (both town and outdoors)
    • This is a bit complex. It's both a "place" operation (if there isn't already a special on the chosen space) and an "edit" operation.
  • Paste Special
  • Place Special Spot
  • Place Item
  • Place Creature
  • Place Boat
  • Place Horse
  • Place Road
  • Place Field (not going to bother listing them all)
  • Add Random Items (from menu)
• Actions that delete one or more entities on the map:
  • Erase Special
  • Erase Item (either through the erase tool or using the Delete button in Edit Item)
  • Erase Creature (either through the erase tool or using the Delete button in Edit Creature)
  • Erase Boat (via the Delete button in Edit Boat)
  • Erase Horse (via the Delete button in Edit Horse)
  • Erase field (includes roads and special spots)
  • Erase town entrance (outdoors only, but this doesn't really make sense?)
  • Clear Items (from menu)
• Actions that modify an entity on the map:
  • Set town entrance destination (outdoors only)
  • Edit sign (both town and outdoors)
  • Place Special
  • Edit Assigned Special
  • Edit Item (can also be a delete)
  • Edit Creature (can also be a delete)
  • Edit Boat (can also be a delete)
  • Edit Horse (can also be a delete)
  • Set All Items Not Property (from menu)
• Actions that set locations on the map, removing the previously-set locations:
  • Set town entrance location (town only)
  • Set Starting Location (from menu, both town and outdoors)
  • Place Wandering Spot (both town and outdoors)
• Actions that place a rectangle on the map:
  • Place Room Rectangle (both town and outdoors)
  • Set Town Boundaries (from menu, town only)
  • Set Saved Item Rectangle (currently in menu, moving to toolbar, town only)
• Actions working with strings:
  • When editing strings, there are arrow buttons in the dialog. The change should "commit" whenever an arrow button is pressed.
  • Add new string (not available for signs or area descriptions)
  • Delete string
  • Edit string
    • Types of strings: scenario, town, outdoors; town areas, town signs; outdoor areas, outdoor signs; journals
  • Edit designer name (usually via an editable string picker; some via other means)
    • Types of designer names: sound names, boat names, horse names, event names, item class names, item type flag names, job board names, SDF names
• Actions working with special nodes:
  • When editing strings, probably the change should only "commit" when you click OK. However, it may be good to "queue up" the various nodes editing and added during an operation so that you can undo them individually instead all in one batch. Or it might be better not to. I'm not sure. In any case, if you fully cancel out of editing a long sequence, the entire sequence is rolled back as if it never happened.
  • Add new node
  • Delete node
  • Edit node
• Actions that modify core details:
  • Scenario Details
  • Scenario Intro Text
  • Classify Custom Graphics
  • Advanced Scenario Details
  • Set Variable Town Entry
  • Set Scenario Event Timers
  • Set Item Placement Shortcuts
  • Set Change Terrain Rules (not implemented) (generalization of Add Terrain Frills)
  • Town Details
  • Town Wandering Monsters
  • Advanced Town Details
  • Set Town Event Timers
  • Outdoor Details
  • Outdoor Wandering/Special Encounters
• Actions that work with core entities:
  • When editing entities, there are arrow buttons in the dialog. The change should "commit" whenever an arrow button is pressed.
  • Add Terrain
  • Delete Terrain
  • Edit Terrain
  • Add Monster
  • Delete Monster
  • Edit Monster
  • Add Item
  • Delete Item
  • Edit Item
  • Add Special Item
  • Delete Special Item
  • Edit Special Item
  • Add Quest
  • Delete Quest
  • Edit Quest
  • Add Shop
  • Delete Shop
  • Edit Shop
• Actions that work with dialogue:
  • Personalities have arrow buttons, similar to entities. The change should "commit" when an arrow button is pressed.
  • Talk nodes have a less complicated version of the special node editing queue. It should probably work similarly in undo as well.
  • Edit Personality
  • Add Talk Node
  • Delete Talk Node
  • Edit Talk Node
• Actions that work with areas:
  • Create New Town
  • Resize Outdoors
  • Delete Last Town
  • Import Town (replacing current)
  • Import Outdoor Sector (replacing current)
• Actions that work with assets:
  • Add graphic sheet (with New)
  • Replace graphic sheet (with Paste/Import)
  • Delete graphic sheet
  • Add custom sound (with Import)
  • Replace custom sound (with Import)
  • Delete sound
  • Import dialog (not implemented)
  • Delete dialog (not implemented)
  • Edit dialog (not implemented)
  • Import prefab party (not implemented)
  • Delete prefab party (not implemented)
• Actions that don't change anything (no undo needed):
  • Changing mode (most of the buttons on the main screen, several menu items, and Back to Main Menu)
  • Changing active area (Load New Section, Load Another Town)
  • Changing zoom level
  • Changing active paint palette (town only)
  • Copy Special
  • This list isn't necessarily comprehensive, as they don't matter for undo.