mm icon indicating copy to clipboard operation
mm copied to clipboard

Rename `ActionParam` to `ItemAction`

Open AngheloAlf opened this issue 2 years ago • 4 comments

~~Yet another Player preparation PR~~

The ItemParam name is not final, the purpose of this PR is to keep this discussion going so this doesn't get buried in the depths of Discord.

The main motivation to rename this away from "Action" is because it is confusing considering we usually use the "Action" word as in "ActionFuncs", meaning actual actions the actor performs, but in the case of Player the current ActionParams does not cover all the possible actions he can perform, it isn't even related to his actual actionFunc callback.

So, since all those "params" are related to item usage we have decided to name it after items (except for the zora fins outlier (which kinda is a repurposed boomerang, so it should be an item... whatever)).

I'm not completely convinced by ItemParam (mainly because IP reminds me of "Internet Protocol"), but I don't have any better idea. Any other suggestion is welcomed.

AngheloAlf avatar Sep 10 '22 03:09 AngheloAlf

Or just plain ItemAction, not convinced param is actually doing anything here... it's not really a parameter.

EllipticEllipsis avatar Sep 10 '22 04:09 EllipticEllipsis

ItemAction seems good to me.

hensldm avatar Sep 17 '22 21:09 hensldm

May I bring your attention to ACTORCAT_ITEMACTION already using "item action" ?

Dragorn421 avatar Sep 18 '22 06:09 Dragorn421

Having done a quick look at where ACTORCAT_ITEMACTION is being used, it's pretty clear that ACTORCAT_ITEMACTION should be renamed. In OoT, although most instances of it's usage are tied to some sort of item interaction, there are a few cases like Bongo Bongo's Shadow, the light from a treasure box (which is in both games), and the Ganon's Tower light beam barrier where it's used.

mzxrules avatar Sep 18 '22 08:09 mzxrules