Clarify nullability for gamerules.

voided · voided · commit 9a3eafde4eb3 · 2024-01-14T22:41:24.000-06:00
diff --git a/include/gamerules.inc b/include/gamerules.inc
@@ -12,8 +12,10 @@
 */
 methodmap CGameRules < CBaseEntity
 {
+	// this entity is intentionally non-nullable, the only way to retrieve an instance of gamerules is through `GetEntity`.
+
 	/**
-	 * Returns the gamerules proxy entity for this game, or null if the entity has not been created yet.
+	 * Returns the gamerules proxy entity for this game, or `INVALID_ENTITY` if the entity has not been created yet.
 	*/
 	public static CGameRules GetEntity()
 	{

Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,10 @@`
`12`	`12`	`*/`
`13`	`13`	`methodmap CGameRules < CBaseEntity`
`14`	`14`	`{`
	`15`	+ // this entity is intentionally non-nullable, the only way to retrieve an instance of gamerules is through `GetEntity`.
	`16`	`+`
`15`	`17`	`/**`
`16`		`- * Returns the gamerules proxy entity for this game, or null if the entity has not been created yet.`
	`18`	+ * Returns the gamerules proxy entity for this game, or `INVALID_ENTITY` if the entity has not been created yet.
`17`	`19`	`*/`
`18`	`20`	`public static CGameRules GetEntity()`
`19`	`21`	`{`