[#3958] Improve localization of rest messages #4749
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
Updates the rest message to select the proper plural form of Hit Points and Hit Dice to match the number recovered. Also adjusts the flavor to automatically display the rest time in the message flavor, rather than relying on hard-coded labels for each rest variant. This ensures the flavor will properly display the rest time even if it doesn't exactly match the default values. In order to support this as well as improve other time-based localization in the future, this PR adds two new utlity methods: - `convertTime` converts a time from one set of units to another. It will also attempt to pick the best unit automatically if the `to` units are not defined, selecting the largest unit that can fully represent the value (with some wiggle room so it will display 90 minutes, rather than 1.5 hours). - `formatTime` converts a time value and units into a string for display, relying on the system-provided plural localization if available and if not using Javascript's standard unit formatting for numbers.
Fyorl
approved these changes
Dec 12, 2024
| @@ -426,10 +454,44 @@ export function getSceneTargets() { | |||
| /* Conversions */ | |||
| /* -------------------------------------------- */ | |||
|
|
|||
| /** | |||
| * Convert the provided time value to another unit. If not final unit is provided, then will convert it to the largest | |||
There was a problem hiding this comment.
Suggested change
| * Convert the provided time value to another unit. If not final unit is provided, then will convert it to the largest | |
| * Convert the provided time value to another unit. If ot final unit is provided, then will convert it to the largest |
There was a problem hiding this comment.
I think you deleted the wrong letter there :)
| * @param {string} from The initial unit as defined in `CONFIG.DND5E.timeUnits`. | ||
| * @param {object} [options={}] | ||
| * @param {boolean} [options.combat=false] Use combat units when auto-selecting units, rather than normal units. | ||
| * @param {string} [options.to] The final units, is explicitly provided. |
There was a problem hiding this comment.
Suggested change
| * @param {string} [options.to] The final units, is explicitly provided. | |
| * @param {string} [options.to] The final units, if explicitly provided. |
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.
Updates the rest message to select the proper plural form of Hit Points and Hit Dice to match the number recovered.
Also adjusts the flavor to automatically display the rest time in the message flavor, rather than relying on hard-coded labels for each rest variant. This ensures the flavor will properly display the rest time even if it doesn't exactly match the default values.
In order to support this as well as improve other time-based localization in the future, this PR adds two new utlity methods:
convertTimeconverts a time from one set of units to another. It will also attempt to pick the best unit automatically if thetounits are not defined, selecting the largest unit that can fully represent the value (with some wiggle room so it will display 90 minutes, rather than 1.5 hours).formatTimeconverts a time value and units into a string for display, relying on the system-provided plural localization if available and if not using Javascript's standard unit formatting for numbers.