feat: ✨ Misc: Add code_note func, to show a helpful message in log_fatal
#139
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
KANAjetzt
approved these changes
Feb 27, 2023
ithinkandicode
changed the title
code_note func, to show a helpful message in log_fatalcode_note func, to show a helpful message in log_fatal
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
I saw this approach in a c# game I decompiled a while ago. It lets us show important notes that would otherwise be stripped when you decompile a game's PCK.
I don't know how useful it would be across the entire codebase, but I think that doing it for this one particular bit of code (
log_fatal) would be very helpful to new users. Eg. I've seen a few people on the Brotato discord who didn't understand why they were getting an error here, because if you don't know about the error stack trace, it can look like an error with ModLoader itself.It uses a dummy func,
code_note, which does nothing but can be re-used elsewhere as it's part ofModLoaderUtils.