[WIP] Summoning followers

[Ilwyd]

This is a WIP PR to add summoning followers to the game. This is intended to just the be basics of having followers and then in a future PR things like familiar combat, scroll effects, etc can be added.

• Using pouches to spawn familiars
• Dropping / spawning pets
• Familiar details tab
  • Familiar chathead
  • Familiar name
  • Correct chathead animations
  • Familiar timer
    • Dismiss familiar on time running out
  • Call
  • Dismiss
  • Renew familiar
• Pet details tab
  • Pet chathead
  • Pet name
  • Correct chathead animations
  • Pet hunger (maybe)
  • Pet age (maybe)
  • Dismiss, call pet buttons
• Summoning orb right-click menu
  • Select left-click option menu
  • Dismiss
  • Call
  • Renew
• Saving follower details on logout
• Spawning follower again on login

Known Bugs:

• The cast option for every familiar you've summoned in your session shows in the right click menu for the summoning orb
• Logging out with a familiar breaks the summoning orb on summoning a new familiar on your next log in

[GregHib]

Variables can be used for this, a custom var storing the follower id will be needed, it's also better to store the npc index and look-up the NPC rather than store the NPC directly to prevent accidentally using (and the garbage collector not being able to delete) npcs that no-longer exist
e.g.

var Player.follower: NPC?
    get() {
        val index = this["follower_index", -1]
        get<NPCS>.get(index)
    }
    set(value) {
        this["follower_index"] = value.index
    }

[Ilwyd]

Thanks, I was planning on changing this. Wrote that quickly just so I could get the dismiss button working.

One problem I'm having with this approach is that index is -1 for a tick, so I can't immediately set follower when the npc is added. I can queue it, not sure if that's the correct approach though.

[GregHib]

Hmm yeah that's a good point, using the world queue for that should be fine just make sure the name is unique

[DavidMBusey]

This is sick.

[Ilwyd]

This is sick.

Thanks, slowly working my way through it when I have the time 😅