Add rich-text tooltips for blocks #135
Merged
Conversation
This file contains hidden or 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
wjt
force-pushed
the
T35540-rich-text-tooltips
branch
from
5cea5c8 to
90e8458
Compare
By default, a plain-text label is used which does not support rich text formatting. Define a `Tooltip` scene; and override `Control._make_custom_tooltip()` in `Block` to return an instance of this scene. `Tooltip` is initially just a `RichTextLabel` with BBCode enabled and a custom minimum size set as suggested by the `_make_custom_tooltip()` documentation: > Note: The tooltip is shrunk to minimal size. If you want to ensure it's fully > visible, you might want to set its `custom_minimum_size` to some non-zero > value. We override the theme styles on the `RichTextLabel` to match the styles used in the built-in inspector's help tooltips. In particular, bold, italic and bold-italic text doesn't work without overriding these styles. The [BBCode in RichTextLabel][0] documentation claims: > If no custom bold or italic fonts are defined, faux bold and italic fonts > will be generated by Godot. but empirically this is not true. The Editor Theme Explorer plugin <https://github.com/YuriSizov/godot-editor-theme-explorer> was useful, as was reading the editor source code, specifically `editor_fonts.cpp` and `editor_help.cpp`. None of the existing `tooltip_text` properties in the codebase use the `[` character that is used by BBCode tags, so there is no need to adjust the existing tooltips to keep displaying as they previously did. https://phabricator.endlessm.com/T35540 [0]: https://docs.godotengine.org/en/stable/tutorials/ui/bbcode_in_richtextlabel.html#reference
wjt
force-pushed
the
T35540-rich-text-tooltips
branch
from
90e8458 to
db819ee
Compare
|
I spent some time trying to find a better option than doing the font overrides in a script, but it seems this is the way to go. Changing the editor main font worked too: |
I know, right? I spent a long time trying to find a better way. In the end I searched GitHub for Maybe I'll turn to Discord. |
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.
This overrides the tooltip of all blocks to be a custom control (a thin wrapper around RichTextLabel) and adds a couple of new tooltips that take advantage of this:
I don't want to spend too much time on the tooltips themselves because we intend to review the wording of the blocks themselves & terminology used in conjuction with the learning team – and potentially changing the level of abstraction of some of the blocks. Similarly I could imagine making the tooltips fancier by, for example, listing the parameters, adding a note about what kind of block it is, etc. But again I think this would be better done in conjuction with the learning team. So here I'm focusing on just having the capability to use rich text in tooltips.
https://phabricator.endlessm.com/T35540