SamsTheNerd / HexGloop

A very gloopy hex casting addon
GNU Lesser General Public License v3.0
4 stars 8 forks source link

0.0.4 - Jeweler's Reflection description/parameters in Hex Notebook mismatches behavior #11

Open BlastYoBoots opened 1 year ago

BlastYoBoots commented 1 year ago

Hi, running HexGloop 0.0.4 on an otherwise AllOfFabric6 server (which has HexCasting and Hexal). Unsure if this is something you may have already fixed for 0.0.5, either by changing the spell behavior or the description. Ahem:

Jeweler's Reflection's description in the Hex Notebook reads thus:

(any -> ) "If I could save an iota into a ring I'm wearing, returns True. Otherwise, returns False."

But the real behavior of the spellform is actually this, difference emphasized:

(any -> any, bool) "If I could save an iota into a ring I'm wearing, adds True to the stack. Otherwise, adds False to the stack."

The key difference here is that Jeweler's Reflection DOES require an iota before it on the stack (or it throws), but doesn't seem to pop that iota off or consume it. It just pushes True or False onto the stack and the input iota is preserved. Which is convenient, but left me with garbage on the stack I wasn't expecting from the documentation! I'd suggest just revising the Hex Notebook entry, particularly those parameters to emphasize the preservation (though was an iota really necessary as input?), but obviously feel free to resolve this any way you wish depending on what the intended behavior was.