oot icon indicating copy to clipboard operation
oot copied to clipboard

Player Docs: `Player_ActionChange_6`, Rolling and Put Away

Open fig02 opened this issue 1 year ago • 0 comments

The first of many upcoming "action change" handler function docs.

This one is a bit awkward because it groups together some pretty unrelated behavior. They are related in that they are triggered by the A button. But these are by far not all actions triggered by the A button in general.

I chose to name the action change handler as Player_ActionChange_HandleRollingAndPutAway. This unfortunately omits one last behavior that this functions also handles-- toggling navi on and off. I chose to leave it out of the name because it is overall less important, and would make the name even longer. Another route could be to try to name it after the fact that these actions revolve around the A button. But that seems less appealing for searching and readability.

My recommendation for how to review this is Player_ActionChange_HandleRollingAndPutAway -> Player_TryRolling -> Player_SetupRoll -> Player_Action_Roll

fig02 avatar Apr 25 '24 15:04 fig02