Fix taking transformation mask off setting unexpected flags

[Archez]

The game sets some flags when putting on a transformation mask. These flags are what allow the player to press a button to "skip" the cutscene after the first time. An array tracks the flag for each player form.

The problem is this logic also executes for taking a mask off which leads to PLAYER_FORM_HUMAN being passed into the same array. This ends up as a OOB read, causing garbage data to be passed into SET_WEEKEVENTREG meaning random flag(s) are potentially set. It's been observed on LInux that this sets a few flags pertaining to learning Goron Lullaby.

Checking on console reveals that the OOB value that gets used on console is 0x100A which translates to two flags being set: WEEKEVENTREG_16_02 and WEEKEVENTREG_16_08
The later of the two appears to be unused. The first however is used by the Gorman Brothers to present or skip a specific text ID that would show on the third day if the player completed the alien quest.
The text is the "I head some garos attacked the milk wagon".

I've opted to add a value to the array that matches console, so these flags will be set when taking a mask off, restoring original behavior with the OOB read.

Alternatively, we could fix the bug by checking for the human form and just not call SET_WEEKEVENTREG at all if that is more preferred.

Fixes #490

Build Artifacts

• 2ship-mac.zip
• 2ship-linux.zip
• 2ship-windows.zip

[garrettjoecox]

wow what a wild ride it was reading that one. Solid find

[garrettjoecox]

Alternatively, we could fix the bug by checking for the human form and just not call SET_WEEKEVENTREG at all if that is more preferred.

I like the fix of preserving hardware behavior, it doesn't cause any user issues.