Cloak of the Wolf - issue with Fixpack component "allow arbitrary return-to-human form from clock of the wuff"

[Andrea C.]

The following Fixpack item:

// allow arbitrary return-to-human form from clock of the wuff
// see also clck04.itm, shapeshifting spell batch
COPY_EXISTING ~wolfm.itm~ ~override/cdwolfm.itm~
  LPF ADD_ITEM_EQEFFECT INT_VAR opcode = 60 target = 1 timing = 2 parameter1 = 100 END
  LPF ADD_ITEM_EQEFFECT INT_VAR opcode = 60 target = 1 timing = 2 parameter1 = 100 parameter2 = 1 END
  LPF ADD_ITEM_EQEFFECT INT_VAR opcode = 53 target = 1 timing = 2 parameter1 = 31488 END
  LPF ADD_ITEM_EQEFFECT INT_VAR opcode = 44 target = 1 timing = 2 parameter1 = 18 parameter2 = 1 END
  LPF ADD_ITEM_EQEFFECT INT_VAR opcode = 15 target = 1 timing = 2 parameter1 = 17 parameter2 = 1 END
  LPF ADD_ITEM_EQEFFECT INT_VAR opcode = 215 target = 1 parameter2 = 1 duration = 117 timing = 3 STR_VAR resource = sppolymp END
  LPF ADD_ITEM_EQEFFECT INT_VAR opcode = 215 target = 1 parameter2 = 1 duration = 117 timing = 3 STR_VAR resource = polyback END

is problematic on the classics because "Timing mode: Delay/Limited - 3" expects two parameters: one for the delay before applying the effect (set to 117 in the example above), and one to determine the effect's duration after applying. The classic engine does not allow for setting the latter, resulting in a bug whereby the visual effect for polymorphing into and from the wolf form keeps playing at regular (and frequent) intervals until you unequip the cloak (and keeps going for some time even after you do.)

The Enhanced Editions apparently do not suffer from the same bug, but it might be worth skipping this fix on the classics.

However there is a second bug with this cloak that affects classics and Enhanced Editions alike: if you save and reload while in wolf form, the engine re-scans item effects and reapplies them, thus duplicating the effects from CDWOLFM.ITM over and over. While the Enhanced Editions could fix this if someone were so inclined as to report this on their forums (I'm not), on the classics I would simply add a note to the readme that describes the bug and warns against saving and loading while in wolf form.

 

Huge thanks to Insomniator for looking into this bug and documenting the root causes.

Edited June 17, 2021 by Andrea C.

[Salk]

I would also suggest to add this to the list of the effect:

LPF ADD_ITEM_EQEFFECT INT_VAR opcode = 144 target = 1 timing = 2 parameter1 = 100 END

and point out in the item's description the duration of the transformation.

Edited June 19, 2021 by Salk

[CamDawg]

Well, we've got two ways to go here, and I'm open to feedback as the current solution isn't fully working.

1. We can eliminate the option for the at-will return-to-natural-form shapeshifting. This brings the cloak a little more in line with its original specs and solves the current issues.
2. We remove the time limit outright and treat it like a druid shapeshift, where the player stays in wolf form until they choose to return. From a coding perspective this is the easiest solution as it just turns the cloak into another item in the shapeshifting list. While it's a little bit more of a departure from the original item as-coded, it doesn't necessarily conflict with the item description.

In either case, we still move the relevant bonuses to the paw (since we still have the dispel magic vs. magically created weapons bug sans TobEx).

[Jarno Mikkola]

2. In my opinion, so long as switching doesn't heal the character.

[Salk]

I vote for solution 2 as well.

The departure from the original intent is not egregious and the gain for the item is rather negligible.

[Andrea C.]

I'll cast my vote for solution n. 2 as well, albeit belatedly.