fix: restore (broken) Action Tracker functionality

lazulit3 commented 1 month ago

This PR fixes functionality related to the Action tracking:

https://github.com/Eranziel/foundryvtt-lancer/issues/751

I tried to understand the prior behavior and fix what bugs I could find, but am unsure if I got everything.

Fixes & Improvements

Action tracker now appears after selecting a Mech token that is engaged in combat
Action tracker shows colored buttons when actions are available, and gray buttons when unavailable
Actor's action tracker data now gets updated on turn start and end
Action tracker's reset button now respects the "Allow players" setting (if disabled they cannot reset)
- The reset button is no longer rendered if players are not allowed to use it
Action tracker is displayed when NPC tokens are selected as well
End of turn message (from "Print Message" Action Tracker setting) differentiates style for spent (colored) vs unspent (gray) actions

Questions / Discussion

For the Print Messages setting in Action Tracker Settings, what is the desired behavior for the end-of-turn action output?

Should the action badges for unused actions be colored and spent actions grayed out (to draw attention to unused action economy?)
Or should end-of-turn message provide history about what actions a player took, and color the spent actions / gray out the unused?

Or neither? I see that the code intended to style them differently based on which actions were spent, but that style is gone/broken, so am guessing here.

Testing

Behavior that I've verified (related to fixes):

Action tracker appears when a mech or NPC is selected/controlled and is in a (started) combat encounter
- Actions are colored when available, gray when unavailable
Actions are refreshed when an actor starts their turn
Actions are cleared (and reaction refreshed) when an actor's turn ends
Actions buttons at bottom of <<MECH//STATS>> on Sheet update action tracker state
If action tracker settings has Allow players disabled:
- the reset button is not rendered
- user cannot use the reset button (even if it was rendered)
If action tracker settings has Print Messages enabled:
- Message with action info appears in chat at end of turn
- Action badge style reflects which actions were taken

lazulit3 commented 1 month ago

Oh I forgot to fix the active vs inactive styling for the Mech Sheet Action buttons-- should make that behavior consistent.

Will follow up later this week.

BoltsJ commented 1 month ago

There's previous work on the fix-action-bar branch. Probably worth building off that rather than starting from scratch

lazulit3 commented 1 month ago

There's previous work on the fix-action-bar branch. Probably worth building off that rather than starting from scratch

Thanks, I hadn't seen this. I've updated this branch with:

Your WIP commit from fix-action-bar rebased on master
My changes rebased on top of that

The only changes I have here that disagree w/ prior work is https://github.com/Eranziel/foundryvtt-lancer/pull/757/commits/dd3532d293787ddcf2ddc55af38e58139bb28729, my rationale for removing this.updateActions(token.actor, _defaultActionData(token.actor)) is at https://github.com/Eranziel/foundryvtt-lancer/commit/21ebd6080f9cda943a0fc0c2992e7500401950d4#r145967069

The !== condition causes updateActions(token.actor, _defaultActionData(token.actor)) to reset the action tracker data-- I think we want to remove the updateActions part altogether. (Otherwise changes to action data just get overridden).

I assume this was from a past circumstance where action_tracker could be undefined and need initialization, but I haven't been able to find a case where this is needed currently. :)

lazulit3 commented 1 month ago