Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

12260-Pre & Post Refresh Hotkeys #12694

Merged
merged 5 commits into from
Sep 21, 2023

Conversation

riverwanderer
Copy link
Collaborator

Test hotkey VassalRefreshGHK.

@riverwanderer riverwanderer self-assigned this Sep 14, 2023
@riverwanderer riverwanderer linked an issue Sep 14, 2023 that may be closed by this pull request
@riverwanderer riverwanderer added Awaiting Testing/Feedback Change is good, but neeeds testing or feedback and removed Work In Progress labels Sep 15, 2023
@riverwanderer
Copy link
Collaborator Author

I have tested this PR with the dev version of C&C Nap as follows:

  1. Add an Action Button to the module that responds to hotkey VassalRefreshGHK, simply putting up a message.
  2. Add a GKC button also responding to hotkey VassalRefreshGHK that sends a conversion command to a text label.

Simple Refresh Counters and Refresh Predefined Setups trigger both 1 & 2.

This PR adds another tool for the module maintainer. As per the linked request, it provides a hotkey hook that can be used to automatically convert multiple scenario files in ways that a refresh alone cannot do. The concept is that the mod dev will use this feature to perform such work "once off" and then disable or remove the maintenance functions.

One caveat, if I understand Refresh correctly, any refresh done using "Refresh Predefined Setups" by design is done without triggering SGKCs. As long as the mod dev bears that in mind, VassalRefreshGHK could be useful to them too.

I believe that the WiF developer may have been asking for this type of functionality recently, so I intend to offer him the build for testing & feedback.

@riverwanderer riverwanderer added the Needs Doco Needs Documentation label Sep 15, 2023
Copy link
Collaborator

@BrentEaston BrentEaston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just need some doco

@riverwanderer riverwanderer added Ready for Review Ready to be reviewed for Merging Work In Progress and removed Awaiting Testing/Feedback Change is good, but neeeds testing or feedback Needs Doco Needs Documentation Ready for Review Ready to be reviewed for Merging labels Sep 15, 2023
@riverwanderer riverwanderer changed the title 12260-Post Refresh Hotkey 12260-Pre & Post Refresh Hotkeys Sep 20, 2023
@riverwanderer riverwanderer added this to the 3.7.1 milestone Sep 20, 2023
@riverwanderer
Copy link
Collaborator Author

Ready to merge - re-tested with a pre as well as a post refresh GHK. Documentation is updated. Reserved Hotkeys are VassalGHKpreRefresh and VassalGHKpostRefresh.

@riverwanderer riverwanderer added Ready for Review Ready to be reviewed for Merging and removed Work In Progress labels Sep 20, 2023
@uckelman uckelman modified the milestones: 3.7.1, 3.7.2 Sep 20, 2023
@riverwanderer riverwanderer merged commit 0ee8714 into vassalengine:master Sep 21, 2023
1 check passed
riverwanderer added a commit that referenced this pull request Sep 21, 2023
riverwanderer added a commit to riverwanderer/vassal that referenced this pull request Sep 27, 2023
riverwanderer added a commit to riverwanderer/vassal that referenced this pull request Sep 29, 2023
riverwanderer added a commit to riverwanderer/vassal that referenced this pull request Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Ready for Review Ready to be reviewed for Merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants