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

Update docs

Browse source
This commit is contained in:
Ukendio 2024-08-11 03:24:28 +02:00
parent 91e2f1a52a
commit 623428f676
1 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/api/world.md
View file

@ -70,12 +70,21 @@ For example, a Health type should be created using this.
### get() ### get()
```luau ```luau
function World:get( function World:get<T>(
entity: Entity, -- The entity entity: Entity, -- The entity
...: Entity<T> -- The types to fetch id: Entity<T> -- The component ID to fetch
): ... -- Returns the component data in the same order they were passed in ): T
``` ```
Returns the data for each provided type for the corresponding entity. Returns the data for the component data the corresponding entity, nil if entity does not have the ID or was a tag.
### has()
```luau
function World:has(
entity: Entity, -- The entity
id: Entity<T> -- The component ID to check
): boolean
```
Returns whether the entity has the ID.
::: :::
@ -109,7 +118,7 @@ Adds or changes the entity's component.
```luau ```luau
function World:query( function World:query(
...: Entity -- The IDs to query with ...: Entity -- The IDs to query with
): Query -- Returns the Query ): Query
``` ```
Creates a [`query`](query) with the given IDs. Entities that satisfies the conditions of the query will be returned and their corresponding data. Creates a [`query`](query) with the given IDs. Entities that satisfies the conditions of the query will be returned and their corresponding data.