From 49305f73dd35341b0d1605e8bdf9f36824de1c43 Mon Sep 17 00:00:00 2001 From: Marcus Date: Sun, 28 Jul 2024 02:39:19 +0200 Subject: [PATCH] Add archetypes method (#89) * Add method * Remove unnecessary shadowed variable --- benches/query.luau | 5 --- docs/api/jecs.md | 30 ++++++++++++++++++ docs/api/world.md | 76 +++++++++++++++++++++++++++++++++++++++++----- docs/index.md | 2 +- src/init.luau | 24 +++++++-------- 5 files changed, 112 insertions(+), 25 deletions(-) create mode 100644 docs/api/jecs.md diff --git a/benches/query.luau b/benches/query.luau index f715d47..54cc7d4 100644 --- a/benches/query.luau +++ b/benches/query.luau @@ -40,11 +40,6 @@ do end end) - BENCH("1 component, 7 tags", function() - for _ in world:query(H):with(G, F, E, D, C, B, A) do - end - end) - local e = world:entity() world:set(e, A, true) world:set(e, B, true) diff --git a/docs/api/jecs.md b/docs/api/jecs.md new file mode 100644 index 0000000..61a66a8 --- /dev/null +++ b/docs/api/jecs.md @@ -0,0 +1,30 @@ +# Jecs + +Jecs. Just an Entity Component System. + +## Properties + +### World +```luau +jecs.World: World +``` + +### Wildcard + +### z<> + +## Functions + +### pair() +```luau +function jecs.pair( + first: Entity, -- The first element of the pair, referred to as the relationship of the relationship pair. + object: Entity, -- The second element of the pair, referred to as the target of the relationship pair. +): number -- Returns the Id with those two elements + +``` +::: info + +Note that while relationship pairs can be used as components, meaning you can add data with it as an ID, however they cannot be used as entities. Meaning you cannot add components to a pair as the source of a binding. + +::: diff --git a/docs/api/world.md b/docs/api/world.md index 96f7fb3..e7702fa 100644 --- a/docs/api/world.md +++ b/docs/api/world.md @@ -1,11 +1,11 @@ -# World +# Query A World contains entities which have components. The World is queryable and can be used to get entities with a specific set of components. ## Functions ### new() -```lua +```luau function World.new(): World ``` Creates a new world. @@ -27,7 +27,7 @@ const world = new World(); ## entity() ```luau -function World:entity(): Entity +function World:entity(): Entity -- The new entit. ``` Creates a new entity. @@ -42,11 +42,12 @@ local entity = world:entity() const entity = world.entity(); ``` -::: +:: +: -### component()` +### component() ```luau -function World:component(): Entity +function World:component(): Entity -- The new componen. ``` Creates a new component. @@ -60,7 +61,6 @@ local Health = world:component() :: jecs.Entity ```ts [typescript] const Health = world.component(); ``` - ::: ::: info @@ -68,3 +68,65 @@ You should use this when creating components. For example, a Health type should be created using this. ::: + +### get() +```luau +function World:get( + entity: Entity, -- The entity + ...: Entity -- The types to fetch +): ... -- Returns the component data in the same order they were passed in +``` +Returns the data for each provided type for the corresponding entity. + +::: + +### add() +```luau +function World:add( + entity: Entity, -- The entity + id: Entity -- The component ID to add +): () +``` +Adds a component ID to the entity. + +This operation adds a single (component) id to an entity. + +::: info +This function is idempotent, meaning if the entity already has the id, this operation will have no side effects. +::: + + +### set() +```luau +function World:set( + entity: Entity, -- The entity + id: Entity, -- The component ID to set + data: T -- The data of the component's type +): () +``` +Adds or changes the entity's component. + +### query() +```luau +function World:query( + ...: Entity -- The component IDs to query with. Entities that satifies the conditions will be returned +): Query<...Entity> -- Returns the Query which gets the entity and their corresponding data when iterated +``` +Creates a [`query`](query) with the given component IDs. + +Example: +::: code-group + +```luau [luau] +for id, position, velocity in world:query(Position, Velocity) do + -- Do something +end +``` + +```ts [typescript] +for (const [id, position, velocity] of world.query(Position, Velocity) { + // Do something +} +``` + +::: diff --git a/docs/index.md b/docs/index.md index 953fa01..3ed3a93 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,7 +14,7 @@ hero: link: /overview/get-started.md - theme: alt text: API References - link: /api/ + link: /api/jecs.md features: - title: Stupidly Fast diff --git a/src/init.luau b/src/init.luau index 0004c6c..6446e86 100644 --- a/src/init.luau +++ b/src/init.luau @@ -136,7 +136,7 @@ local function STRIP_GENERATION(e: i53): i24 end local function ECS_PAIR(pred: i53, obj: i53): i53 - return ECS_COMBINE(ECS_ENTITY_T_LO(obj), ECS_ENTITY_T_LO(pred)) + FLAGS_ADD(--[[isPair]] true) :: i53 + return ECS_COMBINE(ECS_ENTITY_T_LO(obj), ECS_ENTITY_T_LO(pred)) + FLAGS_ADD(--[[isPair]] true) :: i53 end local ERROR_ENTITY_NOT_ALIVE = "Entity is not alive" @@ -897,8 +897,8 @@ do local function world_query_with(query, ...) local ids = { ... } - for i = #compatibleArchetypes, 1, -1 do - local archetype = compatibleArchetypes[i] + for i = #compatible_archetypes, 1, -1 do + local archetype = compatible_archetypes[i] local records = archetype.records local shouldRemove = false @@ -910,11 +910,11 @@ do end if shouldRemove then - table.remove(compatibleArchetypes, i) + table.remove(compatible_archetypes, i) end end - if #compatibleArchetypes == 0 then + if #compatible_archetypes == 0 then return EmptyQuery end @@ -928,7 +928,7 @@ do end local indices = {} - local compatibleArchetypes = {} + compatible_archetypes = {} local length = 0 local components = { ... } :: any @@ -970,11 +970,10 @@ do end length += 1 - compatibleArchetypes[length] = compatibleArchetype + compatible_archetypes[length] = compatibleArchetype indices[length] = records end - compatible_archetypes = compatibleArchetypes column_indices = indices ids = components @@ -997,6 +996,9 @@ do with = world_query_with, without = world_query_without, replace = world_query_replace, + archetypes = function() + return compatible_archetypes + end } :: any setmetatable(it, it) @@ -1189,13 +1191,11 @@ return { OnAdd = EcsOnAdd :: Entity, OnRemove = EcsOnRemove :: Entity, OnSet = EcsOnSet :: Entity, - - Wildcard = EcsWildcard :: Entity, - w = EcsWildcard :: Entity, ChildOf = EcsChildOf, Component = EcsComponent, - Rest = EcsRest, + Wildcard = EcsWildcard :: Entity, + w = EcsWildcard :: Entity, pair = (ECS_PAIR :: any) :: (pred: Entity, obj: Entity) -> number,