Instance content Lua scripting

[redstrate]

This is quite a big milestone, but I want to tread carefully before it becomes a mess. First priority is getting Sastasha accurate. "Accurate" in this sense doesn't mean literal gameplay with battle NPCs, but general sequence flow. Aka "Do doors open? Is it possible to accidentally sequence break? Does it work over multiplayer?"

The reason why I would discourage trying to focus on battles is because that's a huge problem on its own, which distracts from the bigger problem of "there's a door in my way, why can't I open it with a switch like in retail?".

Once that's complete, we should not script any more dungeons but instead attempt to script as many other kinds of applicable content as possible to weed out any odd or bad API decisions. For example:

• How do sequences in raids work?
• What would scripting Explorer Mode look like?
• Branches? Variant dungeons?
• Bosswall management? I think some raids/zones have crazy branching bosswalls.
• Shortcuts?

Feel free to put other ideas or problems in this thread.

[redstrate]

It would be nice to figure out if there is some correlation between objectives and shortcuts. Then we could have an API that Rust can handle that would automatically manage shortcuts for you. Something like this psuedo-code would be great:

OBJECTIVES = {
    -- sequence ID, then the pop range ID
    0: 10595859,
    -- then when its this objective, automatically move the shortcut
    1: 10595860
}

[redstrate]

For bosswalls I think it would make sense to define them like:

BOSS_ROOMS = {
     -- For room 0, and then a list of bosswall IDs.
     0: {10595859, 10595860},
     -- Freely sizable, since some might only have one.
     1: {10595859},
}

director:close_room(BOSS_ROOMS[0])
director:spawn_boss()
...

There's also the open question of how they detect if there are players in bossrooms. It's probably a map range, but haven't looked too closely yet.

---

Edit:

For detecting players in bosswalls I think I was just overthinking it. Bosswalls begin to close once boss gains aggro, and then they seem to be tethered to their spawn (so when you walk away, it drops aggro and returns back to its area.) I don't think we need any fancy detection yet.

I also added API for handling the bosswall timer and stuff in director:spawn_boss as suggested.

[redstrate]

Sastasha is scripted from beginning to end (albeit with a lot of work left to do.)

Some notes from my experience:

• Novus' Map Editor is still very useful here, but:
  • There needs to be a "Go to Object ID" action (DONE)
  • There needs to be an easier way to go to the bound ID, or backwards (find all EObjs bound to a SGB for example.) This is basically how all animated doors work, so it would be useful.
  • Gimmick list with the relevant EObjs listed would also be useful. (DONE)
• The disconnect between gimmicks and EObjs are weird, ideally we can stop defining gimmick IDs at some point? (DONE)
• I still feel like we can automate the scraping of objectives, clearly the UI is informed somehow.

[redstrate]

Something else I noticed which was really annoying to do is finding bosswalls/bosslines in the map editor, but I'm unsure of a proper solution. (They are not standardized, they don't have obvious SGB names, and of course no EObj name.) I may just have to reimplement just enough AVFX rendering that I can see them...

[redstrate]

• There are several log messages missing:
  • Message when enemies drop a key
  • Message when getting doused with poison
  • Message when completing duty
• No duty completion is recorded for the party, which in turn doesn't allow easy access to explorer mode
• Missing jellyfish spawn for the green coral trigger