fix: fixes after review

This commit is contained in:
p0sel0k
2025-11-02 21:12:26 +03:00
parent a81a8646e9
commit dc642f5294

View File

@@ -1,184 +1,169 @@
-- evolved.d.tl -- evolved.d.tl
-- evolve.lua ver.: 1.4 -- evolve.lua ver.: 1.4
-- Teal declaration file for the public API of evolved.lua -- Teal declaration file for the public API of evolved.lua
local record Evolved local record Evolved
-- Basic alias types record ID
type ID = number end
type Entity = ID
type Fragment = ID
type Query = ID
type System = ID
type Component = any type Entity = ID
type Fragment = ID
type Query = ID
type System = ID
-- This is helper interface to easier create Teal custom records which can be used as components interface IComponent
interface IComponent end
end
type Storage = { Component | IComponent } type Component = any | IComponent
type EachState = {integer, Chunk, integer, integer} -- {[1] = structural_changes, [2] = entity_chunk, [3] = entity_place, [4] = chunk_fragment_index} type Storage = { Component }
type ExecuteState = {integer, { Chunk }, integer, {Fragment: integer} | nil} -- {[1] = structural_changes, [2] = chunk_stack, [3] = chunk_stack_size, [4] = exclude_set} type EachState = { integer, Chunk, integer, integer }
type ExecuteState = { integer, { Chunk }, integer, {Fragment: integer} | nil }
type EachIterator = function(EachState | nil): (Fragment | nil, Component | nil) type EachIterator = function(state?: EachState): (Fragment | nil, Component | nil)
type ExecuteIterator = function(EachState | nil): (Chunk | nil, { Entity } | nil, integer | nil) type ExecuteIterator = function(state?: ExecuteState): (Chunk | nil, { Entity } | nil, integer | nil)
type Execute = function(Chunk, { Entity }, integer) type Execute = function(chunk: Chunk, entity_list: { Entity }, entity_count: integer)
type Prologue = function() type Prologue = function()
type Epilogue = function() type Epilogue = function()
type SetHook = function(entity: Entity, fragment: Fragment, new: Component | IComponent, old?: Component | IComponent) type SetHook = function(entity: Entity, fragment: Fragment, new: Component, old?: Component)
type AssignHook = function(entity: Entity, fragment: Fragment, new: Component | IComponent, old?: Component | IComponent) type AssignHook = function(entity: Entity, fragment: Fragment, new: Component, old?: Component)
type InsertHook = function(entity: Entity, fragment: Fragment, new: Component | IComponent) type InsertHook = function(entity: Entity, fragment: Fragment, new: Component)
type RemoveHook = function(entity: Entity, fragment: Fragment, component: Component | IComponent) type RemoveHook = function(entity: Entity, fragment: Fragment, component: Component)
record Chunk record Chunk
alive: function(self: Chunk): boolean alive: function(self: Chunk): boolean
empty: function(self: Chunk): boolean empty: function(self: Chunk): boolean
has: function(self: Chunk, fragment: Fragment): boolean has: function(self: Chunk, fragment: Fragment): boolean
has_all: function(self: Chunk, ...: Fragment): boolean has_all: function(self: Chunk, ...: Fragment): boolean
has_any: function(self: Chunk, ...: Fragment): boolean has_any: function(self: Chunk, ...: Fragment): boolean
entities: function(self: Chunk): ({ Entity }, number) entities: function(self: Chunk): ({ Entity }, number)
fragments: function(self: Chunk): ({ Fragment }, number) fragments: function(self: Chunk): ({ Fragment }, number)
components: function(self: Chunk, ...: Fragment): Storage... components: function(self: Chunk, ...: Fragment): Storage...
end end
record Builder record Builder
build: function(self: Builder, prefab?: Entity): Entity build: function(self: Builder, prefab?: Entity): Entity
multi_build: function(self: Builder, entity_count: number, prefab?: Entity): ({ Entity }, number) multi_build: function(self: Builder, entity_count: number, prefab?: Entity): ({ Entity }, number)
spawn: function(self: Builder): Entity
multi_spawn: function(self: Builder, entity_count: number): ({ Entity }, number)
clone: function(self: Builder, prefab: Entity): Entity
multi_clone: function(self: Builder, entity_count: number, prefab: Entity): ({ Entity }, number)
has: function(self: Builder, fragment: Fragment): boolean
has_all: function(self: Builder, ...: Fragment): boolean
has_any: function(self: Builder, ...: Fragment): boolean
get: function(self: Builder, ...: Fragment): Component...
set: function(self: Builder, fragment: Fragment, component?: Component): Builder
remove: function(self: Builder, ...: Fragment): Builder
clear: function(self: Builder): Builder
tag: function(self: Builder): Builder
name: function(self: Builder, name: string): Builder
unique: function(self: Builder): Builder
explicit: function(self: Builder): Builder
internal: function(self: Builder): Builder
default: function(self: Builder, default: Component): Builder
duplicate: function(self: Builder, duplicate: function(Component): Component): Builder
prefab: function(self: Builder): Builder
disabled: function(self: Builder): Builder
include: function(self: Builder, ...: Fragment): Builder
exclude: function(self: Builder, ...: Fragment): Builder
require: function(self: Builder, ...: Fragment): Builder
on_set: function(self: Builder, on_set: SetHook): Builder
on_assign: function(self: Builder, on_assign: AssignHook): Builder
on_insert: function(self: Builder, on_insert: InsertHook): Builder
on_remove: function(self: Builder, on_remove: RemoveHook): Builder
group: function(self: Builder, group: System): Builder
query: function(self: Builder, q: Query): Builder
execute: function(self: Builder, exec_fn: Execute): Builder
prologue: function(self: Builder, p: Prologue): Builder
epilogue: function(self: Builder, e: Epilogue): Builder
destruction_policy: function(self: Builder, policy: ID): Builder
end
spawn: function(self: Builder): Entity TAG: Fragment
multi_spawn: function(self: Builder, entity_count: number): ({ Entity }, number) NAME: Fragment
clone: function(self: Builder, prefab: Entity): Entity UNIQUE: Fragment
multi_clone: function(self: Builder, entity_count: number, prefab: Entity): ({ Entity }, number) EXPLICIT: Fragment
INTERNAL: Fragment
has: function(self: Builder, fragment: Fragment): boolean DEFAULT: Fragment
has_all: function(self: Builder, ...: Fragment): boolean DUPLICATE: Fragment
has_any: function(self: Builder, ...: Fragment): boolean
get: function(self: Builder, ...: Fragment): Component...
set: function(self: Builder, fragment: Fragment, component?: Component | IComponent): Builder PREFAB: Fragment
remove: function(self: Builder, ...: Fragment): Builder DISABLED: Fragment
clear: function(self: Builder): any
tag: function(self: Builder): Builder INCLUDES: Fragment
name: function(self: Builder, name: string): Builder EXCLUDES: Fragment
REQUIRES: Fragment
unique: function(self: Builder): Builder ON_SET: Fragment
explicit: function(self: Builder): Builder ON_ASSIGN: Fragment
internal: function(self: Builder): Builder ON_INSERT: Fragment
ON_REMOVE: Fragment
default: function(self: Builder, default: Component | IComponent): Builder GROUP: Fragment
duplicate: function(self: Builder, duplicate: function(Component | IComponent): Component): Builder
prefab: function(self: Builder): Builder
disabled: function(self: Builder): Builder
include: function(self: Builder, ...: Fragment): Builder QUERY: Fragment
exclude: function(self: Builder, ...: Fragment): Builder EXECUTE: Fragment
require: function(self: Builder, ...: Fragment): Builder PROLOGUE: Fragment
EPILOGUE: Fragment
on_set: function(self: Builder, on_set: SetHook): Builder DESTRUCTION_POLICY: Fragment
on_assign: function(self: Builder, on_assign: AssignHook): Builder DESTRUCTION_POLICY_DESTROY_ENTITY: ID
on_insert: function(self: Builder, on_insert: InsertHook): Builder DESTRUCTION_POLICY_REMOVE_FRAGMENT: ID
on_remove: function(self: Builder, on_remove: RemoveHook): Builder
group: function(self: Builder, group: System): Builder
query: function(self: Builder, q: Query): Builder id: function(count?: number): ID...
execute: function(self: Builder, exec_fn: Execute): Builder name: function(...: ID): string...
prologue: function(self: Builder, p: Prologue): Builder pack: function(primary: number, secondary: number): ID
epilogue: function(self: Builder, e: Epilogue): Builder unpack: function(id: ID): (number, number)
destruction_policy: function(self: Builder, policy: ID): Builder defer: function(): boolean
end commit: function(): boolean
cancel: function(): boolean
TAG: Fragment spawn: function(components?: { Fragment: Component }): Entity
NAME: Fragment multi_spawn: function(entity_count: number, components?: { Fragment: Component }): ({ Entity }, number)
UNIQUE: Fragment clone: function(prefab: Entity, components?: { Fragment: Component }): Entity
EXPLICIT: Fragment multi_clone: function(entity_count: number, prefab: Entity, components?: { Fragment: Component }): ({ Entity }, number)
INTERNAL: Fragment
DEFAULT: Fragment alive: function(entity: Entity): boolean
DUPLICATE: Fragment alive_all: function(...: Entity): boolean
alive_any: function(...: Entity): boolean
PREFAB: Fragment empty: function(entity: Entity): boolean
DISABLED: Fragment empty_all: function(...: Entity): boolean
empty_any: function(...: Entity): boolean
INCLUDES: Fragment has: function(entity: Entity, fragment: Fragment): boolean
EXCLUDES: Fragment has_all: function(entity: Entity, ...: Fragment): boolean
REQUIRES: Fragment has_any: function(entity: Entity, ...: Fragment): boolean
ON_SET: Fragment get: function(entity: Entity, ...: Fragment): Component...
ON_ASSIGN: Fragment set: function(entity: Entity, fragment: Fragment, component: Component)
ON_INSERT: Fragment remove: function(entity: Entity, ...: Fragment)
ON_REMOVE: Fragment clear: function(...: Entity)
destroy: function(...: Entity)
GROUP: Fragment batch_set: function(q: Query, fragment: Fragment, component: Component)
batch_remove: function(q: Query, ...: Fragment)
batch_clear: function(...: Query)
batch_destroy: function(...: Query)
QUERY: Fragment each: function(entity: Entity): (EachIterator, EachState | nil)
EXECUTE: Fragment execute: function(q: Query): (ExecuteIterator, ExecuteState | nil)
PROLOGUE: Fragment locate: function(entity: Entity): (any | nil, number)
EPILOGUE: Fragment
DESTRUCTION_POLICY: Fragment process: function(...: System)
DESTRUCTION_POLICY_DESTROY_ENTITY: ID debug_mode: function(yesno: boolean)
DESTRUCTION_POLICY_REMOVE_FRAGMENT: ID collect_garbage: function()
id: function(count?: number): ID chunk: function(first_fragment: Fragment, ...: Fragment): (Chunk, { Entity }, integer)
name: function(...: ID): string... builder: function(): Builder
pack: function(primary: number, secondary: number): ID
unpack: function(id: ID): (number, number)
defer: function(): boolean
commit: function(): boolean
cancel: function(): boolean
spawn: function(components?: { Fragment: Component | IComponent }): Entity
multi_spawn: function(entity_count: number, components?: { Fragment: Component | IComponent }): ({ Entity }, number)
clone: function(prefab: Entity, components?: { Fragment: Component | IComponent }): Entity
multi_clone: function(entity_count: number, prefab: Entity, components?: { Fragment: Component | IComponent }): ({ Entity }, number)
alive: function(entity: Entity): boolean
alive_all: function(...: Entity): boolean
alive_any: function(...: Entity): boolean
empty: function(entity: Entity): boolean
empty_all: function(...: Entity): boolean
empty_any: function(...: Entity): boolean
has: function(entity: Entity, fragment: Fragment): boolean
has_all: function(entity: Entity, ...: Fragment): boolean
has_any: function(entity: Entity, ...: Fragment): boolean
get: function(entity: Entity, ...: Fragment): Component...
set: function(entity: Entity, fragment: Fragment, component: Component | IComponent)
remove: function(entity: Entity, ...: Fragment)
clear: function(...: Entity)
destroy: function(...: Entity)
batch_set: function(q: Query, fragment: Fragment, component: Component | IComponent)
batch_remove: function(q: Query, ...: Fragment)
batch_clear: function(...: Query)
batch_destroy: function(...: Query)
each: function(entity: Entity): (EachIterator, EachState | nil)
execute: function(q: Query): (ExecuteIterator, ExecuteState | nil)
locate: function(entity: Entity): (any | nil, number)
process: function(...: System)
debug_mode: function(yesno: boolean)
collect_garbage: function()
chunk: function(first_fragment: Fragment, ...: Fragment): (Chunk, { Entity }, integer)
builder: function(): Builder
end end
return Evolved return Evolved