BlackMATov/evolved.lua
1
0
Fork 0
mirror of https://github.com/BlackMATov/evolved.lua.git synced 2025-12-14 04:00:14 +07:00
Code Issues Packages Projects Releases Wiki Activity

simple api reference

Browse Source
This commit is contained in:
BlackMATov
2024-11-23 07:48:07 +07:00
parent 10aaeb69b8
commit 5e0bb21faf
3 changed files with 33 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -2,8 +2,39 @@
## API Reference
### Module `registry`
```
coming soon...
registry.entity -> (entity)
registry.is_alive -> entity -> (boolean)
registry.destroy -> entity -> ()
registry.get -> entity -> entity -> (any)
registry.get_or -> entity -> entity -> any -> (any)
registry.has -> entity -> entity -> (boolean)
registry.has_all -> entity -> entity -> entity... -> (boolean)
registry.has_any -> entity -> entity -> entity... -> (boolean)
registry.assign -> entity -> entity -> any -> ()
registry.insert -> entity -> entity -> any -> ()
registry.remove -> entity -> entity -> ()
registry.query -> entity -> entity... -> (query)
registry.execute -> query -> (() -> (chunk?))
registry.chunk -> entity -> entity... -> (chunk)
```
### Module `singles`
```
singles.single -> any -> (entity)
singles.get -> entity -> (any)
singles.has -> entity -> (boolean)
singles.assign -> entity -> any -> ()
```
### Module `vectors`
```
vectors.vector2 -> number -> number -> (vector2)
vectors.is_vector2 -> any -> (boolean)
```
## [License (MIT)](./LICENSE.md)