Sovereignty/jecs
1
0
Fork 0
mirror of https://github.com/Ukendio/jecs.git synced 2025-04-24 17:10:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove dead link

Browse source
This commit is contained in:
Ukendio 2024-07-31 02:55:42 +02:00
parent 24f9f5868b
commit a191a0c6ab
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/api/jecs.md
View file

@ -8,8 +8,31 @@ Jecs. Just an Entity Component System.
```luau ```luau
jecs.World: World jecs.World: World
``` ```
A world is a container of all ECS data. Games can have multiple worlds but component IDs may conflict between worlds. Ensure to register the same component IDs in the same order for each world.
### Wildcard ### Wildcard
```luau
jecs.Wildcard: Entity
```
Builtin component type. This ID is used for wildcard queries.
### Component
```luau
jecs.Component: Entity
```
Builtin component type. Every ID created with [world:component()](world.md#component()) has this type added to it. This is meant for querying every component ID.
### ChildOf
```luau
jecs.ChildOf: Entity
```
Builtin component type. This ID is for creating parent-child hierarchies.
:::
### Rest
```luau
jecs.Rest: Entity
```
## Functions ## Functions