Draft
Conversation
Author
|
help is appreciated 🙏 |
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
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.
"Hover" is an useful feature that vscode uses. When the mouse hovers on top of a word, it shows up the meaning (tooltips) and useful information for the coder, instead of having to go manually to the tt-wiki.net website and search for the description of a function.
I'm making this a Draft PR because I want to finish all the functions and variable information possible before commiting to the main branch.
Is this a good idea? Do you -Pixel Tony- approve this?
How to use this feature
I added a new file, called
hoverData.json, where definitions are stored. It should have a structure similar to this example of the built-in functionSTORE_PERM:{ "STORE_PERM": { "title": "STORE_PERM(value, address)", "description": "Store value in permanent storage (industries, airports, towns only).", "example": "STORE_PERM(1, 4)" }this, will look like this in VSCode when the user hovers the mouse over it:

What is the purpose of this PR?
The main reason why I'm doing this is because I wanted to learn how to code NewGRFs, but I can't seem to memorize all the built-in features OpenTTD's code gives me. So, with this Hover Feature, modders can actually see what built-in features there are for them to use them faster and smarter.