mirror of
https://github.com/Ukendio/jecs.git
synced 2025-04-25 09:30:03 +00:00
Fix docs
This commit is contained in:
Ukendio
parent
09ae7794ea
commit
4375150683
4 changed files with 136 additions and 147 deletions
|
|
@ -31,7 +31,7 @@ local Name = world:component()
|
|||
local function parent(entity)
|
||||
return world:target(entity, ChildOf)
|
||||
end
|
||||
local function name(entity)
|
||||
local function getName(entity)
|
||||
return world:get(entity, Name)
|
||||
end
|
||||
|
||||
|
|
|
|||
0
docs/api/index.md
Normal file
0
docs/api/index.md
Normal file
|
|
@ -1,6 +0,0 @@
|
|||
# Installing Jecs
|
||||
|
||||
To use Jecs, you will need to add the library to your project's source folder.
|
||||
|
||||
## Installing with Wally
|
||||
Navigate over to the Wally
|
||||
195
lib/init.lua
195
lib/init.lua
|
|
@ -6,10 +6,10 @@
|
|||
type i53 = number
|
||||
type i24 = number
|
||||
|
||||
type Ty = {i53}
|
||||
type Ty = { i53 }
|
||||
type ArchetypeId = number
|
||||
|
||||
type Column = {any}
|
||||
type Column = { any }
|
||||
|
||||
type Archetype = {
|
||||
id: number,
|
||||
|
|
@ -21,20 +21,19 @@ type Archetype = {
|
|||
},
|
||||
types: Ty,
|
||||
type: string | number,
|
||||
entities: {number},
|
||||
columns: {Column},
|
||||
entities: { number },
|
||||
columns: { Column },
|
||||
records: {},
|
||||
}
|
||||
|
||||
|
||||
type Record = {
|
||||
archetype: Archetype,
|
||||
row: number,
|
||||
dense: i24,
|
||||
componentRecord: ArchetypeMap
|
||||
componentRecord: ArchetypeMap,
|
||||
}
|
||||
|
||||
type EntityIndex = {dense: {[i24]: i53}, sparse: {[i53]: Record}}
|
||||
type EntityIndex = { dense: { [i24]: i53 }, sparse: { [i53]: Record } }
|
||||
|
||||
type ArchetypeRecord = number
|
||||
--[[
|
||||
|
|
@ -48,16 +47,16 @@ TODO:
|
|||
]]
|
||||
|
||||
type ArchetypeMap = {
|
||||
cache: {[number]: ArchetypeRecord},
|
||||
cache: { [number]: ArchetypeRecord },
|
||||
first: ArchetypeMap,
|
||||
second: ArchetypeMap,
|
||||
parent: ArchetypeMap,
|
||||
size: number
|
||||
size: number,
|
||||
}
|
||||
|
||||
type ComponentIndex = {[i24]: ArchetypeMap}
|
||||
type ComponentIndex = { [i24]: ArchetypeMap }
|
||||
|
||||
type Archetypes = {[ArchetypeId]: Archetype}
|
||||
type Archetypes = { [ArchetypeId]: Archetype }
|
||||
|
||||
type ArchetypeDiff = {
|
||||
added: Ty,
|
||||
|
|
@ -77,65 +76,66 @@ local ECS_ENTITY_MASK = bit32.lshift(1, 24)
|
|||
local ECS_GENERATION_MASK = bit32.lshift(1, 16)
|
||||
|
||||
local function addFlags(isPair: boolean)
|
||||
local typeFlags = 0x0
|
||||
local typeFlags = 0x0
|
||||
|
||||
if isPair then
|
||||
typeFlags = bit32.bor(typeFlags, FLAGS_PAIR) -- HIGHEST bit in the ID.
|
||||
end
|
||||
if isPair then
|
||||
typeFlags = bit32.bor(typeFlags, FLAGS_PAIR) -- HIGHEST bit in the ID.
|
||||
end
|
||||
if false then
|
||||
typeFlags = bit32.bor(typeFlags, 0x4) -- Set the second flag to true
|
||||
end
|
||||
if false then
|
||||
typeFlags = bit32.bor(typeFlags, 0x2) -- Set the third flag to true
|
||||
end
|
||||
if false then
|
||||
typeFlags = bit32.bor(typeFlags, 0x1) -- LAST BIT in the ID.
|
||||
end
|
||||
typeFlags = bit32.bor(typeFlags, 0x4) -- Set the second flag to true
|
||||
end
|
||||
if false then
|
||||
typeFlags = bit32.bor(typeFlags, 0x2) -- Set the third flag to true
|
||||
end
|
||||
if false then
|
||||
typeFlags = bit32.bor(typeFlags, 0x1) -- LAST BIT in the ID.
|
||||
end
|
||||
|
||||
return typeFlags
|
||||
return typeFlags
|
||||
end
|
||||
|
||||
local function ECS_COMBINE(source: number, target: number): i53
|
||||
local e = source * 2^28 + target * ECS_ID_FLAGS_MASK
|
||||
return e
|
||||
local e = source * 268435456 + target * ECS_ID_FLAGS_MASK
|
||||
return e
|
||||
end
|
||||
|
||||
local function ECS_IS_PAIR(e: number)
|
||||
return (e % 2^4) // FLAGS_PAIR ~= 0
|
||||
return (e % 2 ^ 4) // FLAGS_PAIR ~= 0
|
||||
end
|
||||
|
||||
function separate(entity: number)
|
||||
local _typeFlags = entity % 0x10
|
||||
entity //= ECS_ID_FLAGS_MASK
|
||||
return entity // ECS_ENTITY_MASK, entity % ECS_GENERATION_MASK, _typeFlags
|
||||
function separate(e: number)
|
||||
local _typeFlags = e % 0x10
|
||||
-- Revert to //= after highligting gets fixed
|
||||
--
|
||||
e = e // ECS_ID_FLAGS_MASK
|
||||
return e // ECS_ENTITY_MASK, e % ECS_GENERATION_MASK, _typeFlags
|
||||
end
|
||||
|
||||
-- HIGH 24 bits LOW 24 bits
|
||||
local function ECS_GENERATION(e: i53)
|
||||
e //= 0x10
|
||||
return e % ECS_GENERATION_MASK
|
||||
e = e // 0x10
|
||||
return e % ECS_GENERATION_MASK
|
||||
end
|
||||
|
||||
local function ECS_GENERATION_INC(e: i53)
|
||||
local id, generation, flags = separate(e)
|
||||
|
||||
return ECS_COMBINE(id, generation + 1) + flags
|
||||
end
|
||||
|
||||
-- FIRST gets the high ID
|
||||
local function ECS_ENTITY_T_HI(e: i53): i24
|
||||
e = e // 0x10
|
||||
return e % ECS_ENTITY_MASK
|
||||
end
|
||||
|
||||
-- SECOND
|
||||
local function ECS_ENTITY_T_LO(e: i53)
|
||||
e //= 0x10
|
||||
return e // ECS_ENTITY_MASK
|
||||
e = e // 0x10
|
||||
return e // ECS_ENTITY_MASK
|
||||
end
|
||||
|
||||
local function ECS_GENERATION_INC(e: i53)
|
||||
local id, generation, flags = separate(e)
|
||||
|
||||
return ECS_COMBINE(id, generation + 1) + flags
|
||||
end
|
||||
|
||||
-- FIRST gets the high ID
|
||||
local function ECS_ENTITY_T_HI(entity: i53): i24
|
||||
entity //= 0x10
|
||||
local first = entity % ECS_ENTITY_MASK
|
||||
return first
|
||||
end
|
||||
|
||||
local function ECS_PAIR(pred: number, obj: number)
|
||||
local function ECS_PAIR(pred: i53, obj: i53): i53
|
||||
local first
|
||||
local second: number = WILDCARD
|
||||
|
||||
|
|
@ -148,35 +148,28 @@ local function ECS_PAIR(pred: number, obj: number)
|
|||
second = ECS_ENTITY_T_LO(pred)
|
||||
end
|
||||
|
||||
return ECS_COMBINE(
|
||||
ECS_ENTITY_T_LO(first), second) + addFlags(--[[isPair]] true)
|
||||
return ECS_COMBINE(ECS_ENTITY_T_LO(first), second) + addFlags(--[[isPair]] true)
|
||||
end
|
||||
|
||||
local function getAlive(entityIndex: EntityIndex, id: i24)
|
||||
local entityId = entityIndex.dense[id]
|
||||
local record = entityIndex.sparse[entityIndex.dense[id]]
|
||||
if not record then
|
||||
error(id.." is not alive")
|
||||
end
|
||||
return entityId
|
||||
return entityId
|
||||
end
|
||||
|
||||
-- ECS_PAIR_FIRST, gets the relationship target / obj / HIGH bits
|
||||
local function ECS_PAIR_RELATION(entityIndex, e)
|
||||
assert(ECS_IS_PAIR(e))
|
||||
return getAlive(entityIndex, ECS_ENTITY_T_HI(e))
|
||||
return getAlive(entityIndex, ECS_ENTITY_T_HI(e))
|
||||
end
|
||||
|
||||
-- ECS_PAIR_SECOND gets the relationship / pred / LOW bits
|
||||
local function ECS_PAIR_OBJECT(entityIndex, e)
|
||||
assert(ECS_IS_PAIR(e))
|
||||
return getAlive(entityIndex, ECS_ENTITY_T_LO(e))
|
||||
return getAlive(entityIndex, ECS_ENTITY_T_LO(e))
|
||||
end
|
||||
|
||||
local function nextEntityId(entityIndex, index: i24): i53
|
||||
local id = ECS_COMBINE(index, 0)
|
||||
entityIndex.sparse[id] = {
|
||||
dense = index
|
||||
dense = index,
|
||||
} :: Record
|
||||
entityIndex.dense[index] = id
|
||||
|
||||
|
|
@ -252,7 +245,7 @@ local function newEntity(entityId: i53, record: Record, archetype: Archetype)
|
|||
return record
|
||||
end
|
||||
|
||||
local function moveEntity(entityIndex, entityId: i53, record: Record, to: Archetype)
|
||||
local function moveEntity(entityIndex: EntityIndex, entityId: i53, record: Record, to: Archetype)
|
||||
local sourceRow = record.row
|
||||
local from = record.archetype
|
||||
local destinationRow = archetypeAppend(entityId, to)
|
||||
|
|
@ -265,11 +258,16 @@ local function hash(arr): string | number
|
|||
return table.concat(arr, "_")
|
||||
end
|
||||
|
||||
local function ensureComponentRecord(componentIndex: ComponentIndex, archetypeId, componentId, i): ArchetypeMap
|
||||
local function ensureComponentRecord(
|
||||
componentIndex: ComponentIndex,
|
||||
archetypeId: number,
|
||||
componentId: number,
|
||||
i: number
|
||||
): ArchetypeMap
|
||||
local archetypesMap = componentIndex[componentId]
|
||||
|
||||
if not archetypesMap then
|
||||
archetypesMap = {size = 0, cache = {}, first = {}, second = {}} :: ArchetypeMap
|
||||
archetypesMap = { size = 0, cache = {}, first = {}, second = {} } :: ArchetypeMap
|
||||
componentIndex[componentId] = archetypesMap
|
||||
end
|
||||
|
||||
|
|
@ -286,8 +284,7 @@ local function ECS_ID_IS_WILDCARD(e)
|
|||
return first == WILDCARD or second == WILDCARD
|
||||
end
|
||||
|
||||
|
||||
local function archetypeOf(world: any, types: {i24}, prev: Archetype?): Archetype
|
||||
local function archetypeOf(world: any, types: { i24 }, prev: Archetype?): Archetype
|
||||
local ty = hash(types)
|
||||
|
||||
local id = world.nextArchetypeId + 1
|
||||
|
|
@ -306,26 +303,24 @@ local function archetypeOf(world: any, types: {i24}, prev: Archetype?): Archetyp
|
|||
local object = ECS_PAIR_OBJECT(world.entityIndex, componentId)
|
||||
|
||||
local idr_r = ECS_PAIR(relation, WILDCARD)
|
||||
ensureComponentRecord(
|
||||
componentIndex, id, idr_r, i)
|
||||
ensureComponentRecord(componentIndex, id, idr_r, i)
|
||||
records[idr_r] = i
|
||||
|
||||
local idr_t = ECS_PAIR(WILDCARD, object)
|
||||
ensureComponentRecord(
|
||||
componentIndex, id, idr_t, i)
|
||||
ensureComponentRecord(componentIndex, id, idr_t, i)
|
||||
records[idr_t] = i
|
||||
end
|
||||
columns[i] = {}
|
||||
end
|
||||
|
||||
local archetype = {
|
||||
columns = columns;
|
||||
edges = {};
|
||||
entities = {};
|
||||
id = id;
|
||||
records = records;
|
||||
type = ty;
|
||||
types = types;
|
||||
columns = columns,
|
||||
edges = {},
|
||||
entities = {},
|
||||
id = id,
|
||||
records = records,
|
||||
type = ty,
|
||||
types = types,
|
||||
}
|
||||
world.archetypeIndex[ty] = archetype
|
||||
world.archetypes[id] = archetype
|
||||
|
|
@ -337,20 +332,20 @@ local World = {}
|
|||
World.__index = World
|
||||
function World.new()
|
||||
local self = setmetatable({
|
||||
archetypeIndex = {};
|
||||
archetypes = {} :: Archetypes;
|
||||
componentIndex = {} :: ComponentIndex;
|
||||
archetypeIndex = {},
|
||||
archetypes = {} :: Archetypes,
|
||||
componentIndex = {} :: ComponentIndex,
|
||||
entityIndex = {
|
||||
dense = {},
|
||||
sparse = {}
|
||||
} :: EntityIndex;
|
||||
sparse = {},
|
||||
} :: EntityIndex,
|
||||
hooks = {
|
||||
[ON_ADD] = {};
|
||||
};
|
||||
nextArchetypeId = 0;
|
||||
nextComponentId = 0;
|
||||
nextEntityId = 0;
|
||||
ROOT_ARCHETYPE = (nil :: any) :: Archetype;
|
||||
[ON_ADD] = {},
|
||||
},
|
||||
nextArchetypeId = 0,
|
||||
nextComponentId = 0,
|
||||
nextEntityId = 0,
|
||||
ROOT_ARCHETYPE = (nil :: any) :: Archetype,
|
||||
}, World)
|
||||
self.ROOT_ARCHETYPE = archetypeOf(self, {})
|
||||
return self
|
||||
|
|
@ -477,7 +472,7 @@ local function ensureArchetype(world: World, types, prev)
|
|||
return archetypeOf(world, types, prev)
|
||||
end
|
||||
|
||||
local function findInsert(types: {i53}, toAdd: i53)
|
||||
local function findInsert(types: { i53 }, toAdd: i53)
|
||||
for i, id in types do
|
||||
if id == toAdd then
|
||||
return -1
|
||||
|
|
@ -644,20 +639,20 @@ end
|
|||
|
||||
-- the less creation the better
|
||||
local function actualNoOperation() end
|
||||
local function noop(_self: Query, ...: i53): () -> (number, ...any)
|
||||
local function noop(_self: Query, ...): () -> ()
|
||||
return actualNoOperation :: any
|
||||
end
|
||||
|
||||
local EmptyQuery = {
|
||||
__iter = noop;
|
||||
without = noop;
|
||||
__iter = noop,
|
||||
without = noop,
|
||||
}
|
||||
EmptyQuery.__index = EmptyQuery
|
||||
setmetatable(EmptyQuery, EmptyQuery)
|
||||
|
||||
export type Query = typeof(EmptyQuery)
|
||||
|
||||
function World.query(world: World, ...: i53): Query
|
||||
function World.query(world: World, ...): Query
|
||||
-- breaking?
|
||||
if (...) == nil then
|
||||
error("Missing components")
|
||||
|
|
@ -666,7 +661,7 @@ function World.query(world: World, ...: i53): Query
|
|||
local compatibleArchetypes = {}
|
||||
local length = 0
|
||||
|
||||
local components = {...}
|
||||
local components = { ... }
|
||||
local archetypes = world.archetypes
|
||||
local queryLength = #components
|
||||
|
||||
|
|
@ -708,7 +703,7 @@ function World.query(world: World, ...: i53): Query
|
|||
length += 1
|
||||
compatibleArchetypes[length] = {
|
||||
archetype = archetype,
|
||||
indices = indices
|
||||
indices = indices,
|
||||
}
|
||||
end
|
||||
|
||||
|
|
@ -721,7 +716,7 @@ function World.query(world: World, ...: i53): Query
|
|||
preparedQuery.__index = preparedQuery
|
||||
|
||||
function preparedQuery:without(...)
|
||||
local withoutComponents = {...}
|
||||
local withoutComponents = { ... }
|
||||
for i = #compatibleArchetypes, 1, -1 do
|
||||
local archetype = compatibleArchetypes[i].archetype
|
||||
local records = archetype.records
|
||||
|
|
@ -857,11 +852,11 @@ function World.__iter(world: World): () -> (number?, unknown?)
|
|||
end
|
||||
|
||||
return table.freeze({
|
||||
World = World;
|
||||
World = World,
|
||||
|
||||
OnAdd = ON_ADD;
|
||||
OnRemove = ON_REMOVE;
|
||||
OnSet = ON_SET;
|
||||
OnAdd = ON_ADD,
|
||||
OnRemove = ON_REMOVE,
|
||||
OnSet = ON_SET,
|
||||
Wildcard = WILDCARD,
|
||||
w = WILDCARD,
|
||||
Rest = REST,
|
||||
|
|
|
|||
Loading…
Reference in a new issue