Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add assert tag #155

Merged
merged 4 commits into from
Jun 4, 2024
Merged

Add assert tag #155

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e18a50
Create assert.ytag
hiisuuii Jan 25, 2024
64323f6
Clarify description of behavior when assertions are disabled
hiisuuii Jan 27, 2024
8173d83
clarify again
hiisuuii Jan 27, 2024
4c36fd9
Merge branch 'main' into patch-1
modmuss50 Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions tags/faq/assert.ytag
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
type: text

---

You should avoid using `assert` in your mod code. If the assert passes, it will work as expected. However, if it fails, Minecraft will crash. Assertions are also disabled by default in the JVM, and will be ignored when your mod is run outside an IDE, which may lead to undefined behavior and potentially a NullPointerException.
Instead of using the assertion pattern `assert someObject != null;`, you should use the null-checking pattern: `if (someObject != null) { /* Code here */ }
Loading