diff --git a/README.md b/README.md index f5d12a1..88d99a5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ ``` id :: id +alive :: id -> boolean pack :: integer, integer -> id unpack :: id -> integer, integer @@ -19,10 +20,15 @@ assign :: entity, fragment, any... -> boolean, boolean insert :: entity, fragment, any... -> boolean, boolean remove :: entity, fragment... -> boolean, boolean clear :: entity -> boolean, boolean - -alive :: entity -> boolean destroy :: entity -> boolean, boolean +batch_set :: query, fragment, any... -> boolean, boolean +batch_assign :: query, fragment, any... -> boolean, boolean +batch_insert :: query, fragment, any... -> boolean, boolean +batch_remove :: query, fragment... -> boolean, boolean +batch_clear :: query -> boolean, boolean +batch_destroy :: query -> boolean, boolean + select :: chunk, fragment... -> component[]... execute :: query -> {execution_state? -> chunk?, entity[]?}, execution_state? ``` diff --git a/evolved.lua b/evolved.lua index 6862166..4546bea 100644 --- a/evolved.lua +++ b/evolved.lua @@ -755,6 +755,13 @@ function evolved.id(count) end end +---@param id evolved.id +---@return boolean +---@nodiscard +function evolved.alive(id) + return __alive_id(id) +end + ---@param index integer ---@param version integer ---@return evolved.id @@ -1105,13 +1112,6 @@ function evolved.clear(entity) return true, false end ----@param entity evolved.entity ----@return boolean ----@nodiscard -function evolved.alive(entity) - return __alive_id(entity) -end - ---@param entity evolved.entity ---@return boolean is_destroyed ---@return boolean is_deferred @@ -1152,6 +1152,55 @@ function evolved.destroy(entity) return true, false end +---@param query evolved.query +---@param fragment evolved.fragment +---@param ... any component arguments +---@return boolean is_set +---@return boolean is_deferred +function evolved.batch_set(query, fragment, ...) + error('not implemented yet', 2) +end + +---@param query evolved.query +---@param fragment evolved.fragment +---@param ... any component arguments +---@return boolean is_assigned +---@return boolean is_deferred +function evolved.batch_assign(query, fragment, ...) + error('not implemented yet', 2) +end + +---@param query evolved.query +---@param fragment evolved.fragment +---@param ... any component arguments +---@return boolean is_inserted +---@return boolean is_deferred +function evolved.batch_insert(query, fragment, ...) + error('not implemented yet', 2) +end + +---@param query evolved.query +---@param ... evolved.fragment fragments +---@return boolean is_removed +---@return boolean is_deferred +function evolved.batch_remove(query, ...) + error('not implemented yet', 2) +end + +---@param query evolved.query +---@return boolean is_cleared +---@return boolean is_deferred +function evolved.batch_clear(query) + error('not implemented yet', 2) +end + +---@param query evolved.query +---@return boolean is_destroyed +---@return boolean is_deferred +function evolved.batch_destroy(query) + error('not implemented yet', 2) +end + --- --- ---