mirror of
https://github.com/Ukendio/jecs.git
synced 2025-04-25 09:30:03 +00:00
Name the builtin components
This commit is contained in:
parent
9e3f93dd4c
commit
38dd3f1b38
1 changed files with 94 additions and 44 deletions
136
src/init.luau
136
src/init.luau
|
@ -69,9 +69,8 @@ local EcsOnDelete = HI_COMPONENT_ID + 7
|
||||||
local EcsOnDeleteTarget = HI_COMPONENT_ID + 8
|
local EcsOnDeleteTarget = HI_COMPONENT_ID + 8
|
||||||
local EcsDelete = HI_COMPONENT_ID + 9
|
local EcsDelete = HI_COMPONENT_ID + 9
|
||||||
local EcsRemove = HI_COMPONENT_ID + 10
|
local EcsRemove = HI_COMPONENT_ID + 10
|
||||||
local EcsTag = HI_COMPONENT_ID + 11
|
local EcsName = HI_COMPONENT_ID + 11
|
||||||
local EcsName = HI_COMPONENT_ID + 12
|
local EcsRest = HI_COMPONENT_ID + 12
|
||||||
local EcsRest = HI_COMPONENT_ID + 13
|
|
||||||
|
|
||||||
local ECS_PAIR_FLAG = 0x8
|
local ECS_PAIR_FLAG = 0x8
|
||||||
local ECS_ID_FLAGS_MASK = 0x10
|
local ECS_ID_FLAGS_MASK = 0x10
|
||||||
|
@ -937,7 +936,7 @@ local function ARM(query, ...)
|
||||||
end
|
end
|
||||||
|
|
||||||
local EMPTY_LIST = {}
|
local EMPTY_LIST = {}
|
||||||
local EmptyQuery = {
|
local EMPTY_QUERY = {
|
||||||
__iter = function()
|
__iter = function()
|
||||||
return NOOP
|
return NOOP
|
||||||
end,
|
end,
|
||||||
|
@ -954,7 +953,7 @@ local EmptyQuery = {
|
||||||
end,
|
end,
|
||||||
}
|
}
|
||||||
|
|
||||||
setmetatable(EmptyQuery, EmptyQuery)
|
setmetatable(EMPTY_QUERY, EMPTY_QUERY)
|
||||||
|
|
||||||
local function query_init(query)
|
local function query_init(query)
|
||||||
local world_query_iter_next = query.iter_next
|
local world_query_iter_next = query.iter_next
|
||||||
|
@ -968,7 +967,7 @@ local function query_init(query)
|
||||||
local lastArchetype = 1
|
local lastArchetype = 1
|
||||||
local archetype = compatible_archetypes[1]
|
local archetype = compatible_archetypes[1]
|
||||||
if not archetype then
|
if not archetype then
|
||||||
return EmptyQuery
|
return EMPTY_QUERY
|
||||||
end
|
end
|
||||||
local columns = archetype.columns
|
local columns = archetype.columns
|
||||||
local entities = archetype.entities
|
local entities = archetype.entities
|
||||||
|
@ -1226,7 +1225,6 @@ end
|
||||||
|
|
||||||
local function query_without(query, ...)
|
local function query_without(query, ...)
|
||||||
local compatible_archetypes = query.compatible_archetypes
|
local compatible_archetypes = query.compatible_archetypes
|
||||||
local length: number = query.length
|
|
||||||
local N = select("#", ...)
|
local N = select("#", ...)
|
||||||
for i = #compatible_archetypes, 1, -1 do
|
for i = #compatible_archetypes, 1, -1 do
|
||||||
local archetype = compatible_archetypes[i]
|
local archetype = compatible_archetypes[i]
|
||||||
|
@ -1247,14 +1245,11 @@ local function query_without(query, ...)
|
||||||
compatible_archetypes[i] = compatible_archetypes[last]
|
compatible_archetypes[i] = compatible_archetypes[last]
|
||||||
end
|
end
|
||||||
compatible_archetypes[last] = nil
|
compatible_archetypes[last] = nil
|
||||||
length -= 1
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
query.length = length
|
if #compatible_archetypes == 0 then
|
||||||
|
return EMPTY_QUERY
|
||||||
if length == 0 then
|
|
||||||
return EmptyQuery
|
|
||||||
end
|
end
|
||||||
|
|
||||||
return query
|
return query
|
||||||
|
@ -1262,7 +1257,6 @@ end
|
||||||
|
|
||||||
local function query_with(query, ...)
|
local function query_with(query, ...)
|
||||||
local compatible_archetypes = query.compatible_archetypes
|
local compatible_archetypes = query.compatible_archetypes
|
||||||
local length: number = query.length
|
|
||||||
local N = select("#", ...)
|
local N = select("#", ...)
|
||||||
for i = #compatible_archetypes, 1, -1 do
|
for i = #compatible_archetypes, 1, -1 do
|
||||||
local archetype = compatible_archetypes[i]
|
local archetype = compatible_archetypes[i]
|
||||||
|
@ -1283,12 +1277,10 @@ local function query_with(query, ...)
|
||||||
compatible_archetypes[i] = compatible_archetypes[last]
|
compatible_archetypes[i] = compatible_archetypes[last]
|
||||||
end
|
end
|
||||||
compatible_archetypes[last] = nil
|
compatible_archetypes[last] = nil
|
||||||
length -= 1
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
query.length = length
|
if #compatible_archetypes == 0 then
|
||||||
if length == 0 then
|
return EMPTY_QUERY
|
||||||
return EmptyQuery
|
|
||||||
end
|
end
|
||||||
return query
|
return query
|
||||||
end
|
end
|
||||||
|
@ -1352,6 +1344,7 @@ end
|
||||||
local Query = {}
|
local Query = {}
|
||||||
Query.__index = Query
|
Query.__index = Query
|
||||||
Query.__iter = query_iter
|
Query.__iter = query_iter
|
||||||
|
Query.iter = query_iter
|
||||||
Query.without = query_without
|
Query.without = query_without
|
||||||
Query.with = query_with
|
Query.with = query_with
|
||||||
Query.archetypes = query_archetypes
|
Query.archetypes = query_archetypes
|
||||||
|
@ -1373,7 +1366,7 @@ local function world_query(world: World, ...)
|
||||||
for _, id in ids do
|
for _, id in ids do
|
||||||
local map = componentIndex[id]
|
local map = componentIndex[id]
|
||||||
if not map then
|
if not map then
|
||||||
return EmptyQuery
|
return EMPTY_QUERY
|
||||||
end
|
end
|
||||||
|
|
||||||
if idr == nil or map.size < idr.size then
|
if idr == nil or map.size < idr.size then
|
||||||
|
@ -1407,14 +1400,13 @@ local function world_query(world: World, ...)
|
||||||
end
|
end
|
||||||
|
|
||||||
if length == 0 then
|
if length == 0 then
|
||||||
return EmptyQuery
|
return EMPTY_QUERY
|
||||||
end
|
end
|
||||||
|
|
||||||
local q = setmetatable({
|
local q = setmetatable({
|
||||||
compatible_archetypes = compatible_archetypes,
|
compatible_archetypes = compatible_archetypes,
|
||||||
length = length,
|
|
||||||
ids = ids,
|
ids = ids,
|
||||||
}, Query)
|
}, Query) :: any
|
||||||
|
|
||||||
return q
|
return q
|
||||||
end
|
end
|
||||||
|
@ -1436,13 +1428,17 @@ World.target = world_target
|
||||||
World.parent = world_parent
|
World.parent = world_parent
|
||||||
World.contains = world_contains
|
World.contains = world_contains
|
||||||
|
|
||||||
if _G.__JECS_DEBUG == true then
|
if _G.__JECS_DEBUG then
|
||||||
-- taken from https://github.com/centau/ecr/blob/main/src/ecr.luau
|
-- taken from https://github.com/centau/ecr/blob/main/src/ecr.luau
|
||||||
-- error but stack trace always starts at first callsite outside of this file
|
-- error but stack trace always starts at first callsite outside of this file
|
||||||
local function throw(msg: string)
|
local function throw(msg: string)
|
||||||
local s = 1
|
local s = 1
|
||||||
repeat s += 1 until debug.info(s, "s") ~= debug.info(1, "s")
|
repeat s += 1 until debug.info(s, "s") ~= debug.info(1, "s")
|
||||||
|
if warn then
|
||||||
error(msg, s)
|
error(msg, s)
|
||||||
|
else
|
||||||
|
print(`[jecs] error: {msg}\n`)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
local function ASSERT<T>(v: T, msg: string)
|
local function ASSERT<T>(v: T, msg: string)
|
||||||
|
@ -1452,21 +1448,45 @@ if _G.__JECS_DEBUG == true then
|
||||||
throw(msg)
|
throw(msg)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
local function get_name(world, id): string | number
|
||||||
|
local name: string | nil
|
||||||
|
if ECS_IS_PAIR(id) then
|
||||||
|
name = `({get_name(world, ECS_ENTITY_T_HI(id))}, {get_name(world, ECS_ENTITY_T_LO(id))})`
|
||||||
|
else
|
||||||
|
local _1 = world_get_one_inline(world, id, EcsName)
|
||||||
|
if _1 then
|
||||||
|
name = `${_1}`
|
||||||
|
end
|
||||||
|
end
|
||||||
|
if name then
|
||||||
|
return name
|
||||||
|
else
|
||||||
|
return `${id}`
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
local function ID_IS_TAG(world, id)
|
||||||
|
return not world_has_one_inline(world, ECS_ENTITY_T_HI(id), EcsComponent)
|
||||||
|
end
|
||||||
|
|
||||||
World.query = function(world: World, ...)
|
World.query = function(world: World, ...)
|
||||||
ASSERT((...), "Requires at least a single component")
|
ASSERT((...), "Requires at least a single component")
|
||||||
return world_query(world, ...)
|
return world_query(world, ...)
|
||||||
end
|
end
|
||||||
|
|
||||||
World.set = function(world: World, entity: i53, id: i53, value: any): ()
|
World.set = function(world: World, entity: i53, id: i53, value: any): ()
|
||||||
local idr = world.componentIndex[id]
|
local is_tag = ID_IS_TAG(world, id)
|
||||||
local flags = idr.flags
|
if (is_tag and value == nil) then
|
||||||
local id_is_tag = bit32.band(flags, ECS_ID_IS_TAG) ~= 0
|
local _1 = get_name(world, entity)
|
||||||
if id_is_tag then
|
local _2 = get_name(world, id)
|
||||||
local name = world_get_one_inline(world, id, EcsName) or `${id}`
|
local why = "cannot set component value to nil"
|
||||||
throw(`({name}) is a tag. Did you mean to use "world:add(entity, {name})"`)
|
throw(why)
|
||||||
elseif value == nil then
|
elseif (value ~= nil and is_tag) then
|
||||||
local name = world_get_one_inline(world, id, EcsName) or `${id}`
|
local _1 = get_name(world, entity)
|
||||||
throw(`cannot set component ({name}) value to nil. If this was intentional, use "world:add(entity, {name})"`)
|
local _2 = get_name(world, id)
|
||||||
|
local why = `cannot set a component value because {_2} is a tag`
|
||||||
|
why ..= `\n[jecs] note: consider using "world:add({_1}, {_2})" instead`
|
||||||
|
throw(why)
|
||||||
end
|
end
|
||||||
|
|
||||||
world_set(world, entity, id, value)
|
world_set(world, entity, id, value)
|
||||||
|
@ -1474,8 +1494,10 @@ if _G.__JECS_DEBUG == true then
|
||||||
|
|
||||||
World.add = function(world: World, entity: i53, id: i53, value: nil)
|
World.add = function(world: World, entity: i53, id: i53, value: nil)
|
||||||
if value ~= nil then
|
if value ~= nil then
|
||||||
local name = world_get_one_inline(world, id, EcsName) or `${id}`
|
local _1 = get_name(world, entity)
|
||||||
throw(`You provided a value when none was expected. Did you mean to use "world:add(entity, {name})"`)
|
local _2 = get_name(world, id)
|
||||||
|
throw("You provided a value when none was expected. "
|
||||||
|
..`Did you mean to use "world:add({_1}, {_2})"`)
|
||||||
end
|
end
|
||||||
|
|
||||||
world_add(world, entity, id)
|
world_add(world, entity, id)
|
||||||
|
@ -1483,20 +1505,35 @@ if _G.__JECS_DEBUG == true then
|
||||||
|
|
||||||
World.get = function(world: World, entity: i53, ...)
|
World.get = function(world: World, entity: i53, ...)
|
||||||
local length = select("#", ...)
|
local length = select("#", ...)
|
||||||
ASSERT(length > 4, "world:get does not support more than 4 components")
|
ASSERT(length < 5, "world:get does not support more than 4 components")
|
||||||
|
local _1
|
||||||
for i = 1, length do
|
for i = 1, length do
|
||||||
local id = select(i, ...)
|
local id = select(i, ...)
|
||||||
local idr = world.componentIndex[id]
|
local id_is_tag = not world_has(world, id, EcsComponent)
|
||||||
local flags = idr.flags
|
|
||||||
local id_is_tag = bit32.band(flags, ECS_ID_IS_TAG) ~= 0
|
|
||||||
if id_is_tag then
|
if id_is_tag then
|
||||||
local name = world_get_one_inline(world, id, EcsName) or `${id}`
|
local name = get_name(world, id)
|
||||||
throw(`cannot get component ({name}) value because it is a tag. If this was intentional, use "world:has(entity, {name})"`)
|
if not _1 then
|
||||||
|
_1 = get_name(world, entity)
|
||||||
|
end
|
||||||
|
throw(
|
||||||
|
`cannot get (#{i}) component {name} value because it is a tag.`
|
||||||
|
..`\n[jecs] note: If this was intentional, use "world:has({_1}, {name}) instead"`)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
return world_get(world, entity, ...)
|
return world_get(world, entity, ...)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
World.target = function(world, entity, relation, index)
|
||||||
|
if index == nil then
|
||||||
|
local _1 = get_name(world, entity)
|
||||||
|
local _2 = get_name(world, relation)
|
||||||
|
|
||||||
|
throw("We have changed the function call to require an index parameter,"
|
||||||
|
..` please use world:target({_1}, {_2}, 0)`)
|
||||||
|
end
|
||||||
|
return world_target(world, entity, relation, index)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
function World.new()
|
function World.new()
|
||||||
|
@ -1521,13 +1558,27 @@ function World.new()
|
||||||
entity_index_new_id(self.entityIndex, i)
|
entity_index_new_id(self.entityIndex, i)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
world_add(self, EcsName, EcsComponent)
|
||||||
world_add(self, EcsOnSet, EcsComponent)
|
world_add(self, EcsOnSet, EcsComponent)
|
||||||
world_add(self, EcsOnAdd, EcsComponent)
|
world_add(self, EcsOnAdd, EcsComponent)
|
||||||
world_add(self, EcsOnRemove, EcsComponent)
|
world_add(self, EcsOnRemove, EcsComponent)
|
||||||
world_add(self, EcsRest, EcsComponent)
|
|
||||||
world_add(self, EcsName, EcsComponent)
|
|
||||||
world_add(self, EcsChildOf, ECS_PAIR(EcsOnDeleteTarget, EcsDelete))
|
|
||||||
world_add(self, EcsWildcard, EcsComponent)
|
world_add(self, EcsWildcard, EcsComponent)
|
||||||
|
world_add(self, EcsRest, EcsComponent)
|
||||||
|
|
||||||
|
world_set(self, EcsOnAdd, EcsName, "jecs.OnAdd")
|
||||||
|
world_set(self, EcsOnRemove, EcsName, "jecs.OnRemove")
|
||||||
|
world_set(self, EcsOnSet, EcsName, "jecs.OnSet")
|
||||||
|
world_set(self, EcsWildcard, EcsName, "jecs.Wildcard")
|
||||||
|
world_set(self, EcsChildOf, EcsName, "jecs.ChildOf")
|
||||||
|
world_set(self, EcsComponent, EcsName, "jecs.Component")
|
||||||
|
world_set(self, EcsOnDelete, EcsName, "jecs.OnDelete")
|
||||||
|
world_set(self, EcsOnDeleteTarget, EcsName, "jecs.OnDeleteTarget")
|
||||||
|
world_set(self, EcsDelete, EcsName, "jecs.Delete")
|
||||||
|
world_set(self, EcsRemove, EcsName, "jecs.Remove")
|
||||||
|
world_set(self, EcsName, EcsName, "jecs.Name")
|
||||||
|
world_set(self, EcsRest, EcsRest, "jecs.Rest")
|
||||||
|
|
||||||
|
world_add(self, EcsChildOf, ECS_PAIR(EcsOnDeleteTarget, EcsDelete))
|
||||||
|
|
||||||
return self
|
return self
|
||||||
end
|
end
|
||||||
|
@ -1660,7 +1711,6 @@ return {
|
||||||
OnDeleteTarget = EcsOnDeleteTarget :: Entity,
|
OnDeleteTarget = EcsOnDeleteTarget :: Entity,
|
||||||
Delete = EcsDelete :: Entity,
|
Delete = EcsDelete :: Entity,
|
||||||
Remove = EcsRemove :: Entity,
|
Remove = EcsRemove :: Entity,
|
||||||
Tag = EcsTag :: Entity,
|
|
||||||
Name = EcsName :: Entity<string>,
|
Name = EcsName :: Entity<string>,
|
||||||
Rest = EcsRest :: Entity,
|
Rest = EcsRest :: Entity,
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue