Skip to content

Commit efe89ee

Browse files
committed
Clarify methodmap nullability in readme.
1 parent 9a3eafd commit efe89ee

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,11 @@ If your game uses econ entities, you can enable econ functionality with `#define
4949
## Considerations
5050

5151
- This library won't have much active development, but PRs are still welcome.
52+
53+
### Methodmaps, `null`, & `INVALID_ENTITY`
54+
55+
The thelpers methodmaps originally "creatively" utilized the functionality of `__nullable__` to allow comparisons with `null` to check entity validity.
56+
57+
SourceMod has since updated the syntax to disallow this, so the supported way forward is to perform comparison checks against the `INVALID_ENTITY` constant in this library.
58+
59+
While `__nullable__` now has no useful use in thelpers, the methodmap definitions will remain nullable to support existing consumers who are using the `new ...()` syntax to construct the methodmaps.

0 commit comments

Comments
 (0)