Core: Improve join/leave messages, add "HintGame" tag #2859
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
github-actions
bot
added
affects: core
benny-dreamly
approved these changes
Feb 24, 2024
remyjette
approved these changes
Feb 26, 2024
MultiServer.py
Outdated
Comment on lines
809
to
814
| for tag, verb in verbs.items(): | ||
| if tag in client.tags: | ||
| final_verb = verb | ||
| break | ||
| else: | ||
| final_verb = "playing" |
There was a problem hiding this comment.
This can be done with a generator expression and next()
I guess it's a stylistic choice as it should perform the same but to me it reads cleaner than a for/else so figured i'd suggest it
Suggested change
| for tag, verb in verbs.items(): | |
| if tag in client.tags: | |
| final_verb = verb | |
| break | |
| else: | |
| final_verb = "playing" | |
| final_verb = next((verb for tag, verb in verbs.items() if tag in client.tags), "playing") |
There was a problem hiding this comment.
Personally I find this far less readable than the for/else
| ctx.broadcast_text_all( | ||
| "%s (Team #%d) has left the game" % (ctx.get_aliased_name(client.team, client.slot), client.team + 1), | ||
| f"{ctx.get_aliased_name(client.team, client.slot)} (Team #{client.team + 1}) has {final_verb} the game. " | ||
| f"Client({version_str}), {client.tags}.", |
There was a problem hiding this comment.
i'm not sure the client version/tags are necessary for leaving, but that might just be me.
But I love the change from "left" to "stopped tracking", will alleviate confusion for sure
There was a problem hiding this comment.
The tags is helpful, because for instance my APSudoku hint game has the "APSudoku" tag- so it gives an extra level of clarity to the leave message.
ScipioWright
added
the
is: enhancement
|
Instead of creating 3 new data objects in 3 different places, do we want to just create 1? EmilyV99#3 |
PoryGone
added
waiting-on: author
data in one place instead of 3
beauxq
reviewed
Mar 5, 2024
beauxq
approved these changes
Mar 8, 2024
BadMagic100
added
waiting-on: core-review
NewSoupVi
approved these changes
May 2, 2024
jnschurig
pushed a commit
to Tranquilite0/Archipelago-SoulBlazer
that referenced
this pull request
Jun 13, 2024
…2859) * Add better "verbs" on joining msg, and improve leaving msgs * Add 'HintGame' tag, for projects like BKSudoku/APSudoku/HintMachine * data in one place instead of 3 * Clean up 'ignore_game' loop to use any() instead --------- Co-authored-by: beauxq <[email protected]>
qwint
pushed a commit
to qwint/Archipelago
that referenced
this pull request
Jun 24, 2024
…2859) * Add better "verbs" on joining msg, and improve leaving msgs * Add 'HintGame' tag, for projects like BKSudoku/APSudoku/HintMachine * data in one place instead of 3 * Clean up 'ignore_game' loop to use any() instead --------- Co-authored-by: beauxq <[email protected]>
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.
What is this fixing or adding?
HintGametag, for projects like BKSudoku/APSudoku/HintMachine (this tag, likeTextOnly/Tracker, allowsignore_game)hintingforHintGametrackingforTrackerviewingforTextOnlyplayingstopped hintingforHintGamestopped trackingforTrackerstopped viewingforTextOnlyleftWhere multiple tags that have associated verbs are on the same client, it picks the first applicable verb, in tag order
HintGame,Tracker,TextOnly, default.How was this tested?
Connected and disconnected with various tags, using
CommonClientforTextOnly, and my ownAPSudokuproject with various sets/combinations of tags.If this makes graphical changes, please attach screenshots.