Player Docs: Player_ActionChange_6, Rolling and Put Away
#1949
+110
−61
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fig02
commented
Apr 25, 2024
Comment on lines
6048
to
6061
| s32 Player_ActionChange_HandleRollingAndPutAway(Player* this, PlayState* play) { | ||
| if (!func_80833B54(this) && !sUpperBodyIsBusy && !(this->stateFlags1 & PLAYER_STATE1_23) && | ||
| CHECK_BTN_ALL(sControlInput->press.button, BTN_A)) { | ||
| if (func_8083BC7C(this, play)) { | ||
| return 1; | ||
| } | ||
| if ((this->unk_837 == 0) && (this->heldItemAction >= PLAYER_IA_SWORD_MASTER)) { | ||
| if (Player_TryRolling(this, play)) { | ||
| return true; | ||
| } else if ((this->putAwayCooldownTimer == 0) && (this->heldItemAction >= PLAYER_IA_SWORD_MASTER)) { | ||
| Player_UseItem(play, this, ITEM_NONE); | ||
| } else { | ||
| this->stateFlags2 ^= PLAYER_STATE2_20; | ||
| this->stateFlags2 ^= PLAYER_STATE2_NAVI_ACTIVE; | ||
| } | ||
| } | ||
|
|
||
| return 0; | ||
| return false; | ||
| } |
There was a problem hiding this comment.
Technically speaking, rolling is the only actual action that this "ActionChange" function concerns. The other things are "extra" and not handled by the main action system. So I could see an argument for naming the function after rolling only. The function comment can explain the "extra" functionality that is also controls. Would like to hear other thoughts.
There was a problem hiding this comment.
I actually think this is probably for the better and will change it, but still would like to hear opinions
cadmic
approved these changes
Apr 25, 2024
| LinkAnimation_PlayOnceSetSpeed(play, &this->skelAnime, | ||
| GET_PLAYER_ANIM(PLAYER_ANIMGROUP_landing_roll, this->modelAnimType), | ||
| 1.25f * D_808535E8); | ||
| } | ||
|
|
||
| s32 func_8083BC7C(Player* this, PlayState* play) { | ||
| s32 Player_TryRolling(Player* this, PlayState* play) { |
There was a problem hiding this comment.
Nit: Player_TryRoll? I think these Try functions are somewhat common so maybe naming them after the action is more consistent
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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