Add assert tag (#155)

* Create assert.ytag It's fairly common in the mod dev channels to see people using asserts when they shouldn't. A quick tag to explain why they shouldn't be used and what to use instead would be beneficial. * Clarify description of behavior when assertions are disabled * clarify again --------- Co-authored-by: modmuss <[email protected]>
FabricMC · Jun 4, 2024 · aedd73c · aedd73c
1 parent cbd63cf
commit aedd73c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/tags/faq/assert.ytag b/tags/faq/assert.ytag
@@ -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 */ }