mirror of
https://github.com/BlackMATov/evolved.lua.git
synced 2025-12-13 03:29:08 +07:00
fix: fixes after review
This commit is contained in:
p0sel0k
277
evolved.d.tl
277
evolved.d.tl
@@ -1,184 +1,169 @@
|
||||
-- evolved.d.tl
|
||||
-- evolved.d.tl
|
||||
-- evolve.lua ver.: 1.4
|
||||
-- Teal declaration file for the public API of evolved.lua
|
||||
|
||||
local record Evolved
|
||||
|
||||
-- Basic alias types
|
||||
type ID = number
|
||||
type Entity = ID
|
||||
type Fragment = ID
|
||||
type Query = ID
|
||||
type System = ID
|
||||
record ID
|
||||
end
|
||||
|
||||
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
|
||||
end
|
||||
interface IComponent
|
||||
end
|
||||
|
||||
type Component = any | IComponent
|
||||
|
||||
type Storage = { Component | IComponent }
|
||||
type Storage = { Component }
|
||||
type EachState = { integer, Chunk, integer, integer }
|
||||
type ExecuteState = { integer, { Chunk }, integer, {Fragment: integer} | nil }
|
||||
|
||||
type EachState = {integer, Chunk, integer, integer} -- {[1] = structural_changes, [2] = entity_chunk, [3] = entity_place, [4] = chunk_fragment_index}
|
||||
type ExecuteState = {integer, { Chunk }, integer, {Fragment: integer} | nil} -- {[1] = structural_changes, [2] = chunk_stack, [3] = chunk_stack_size, [4] = exclude_set}
|
||||
type EachIterator = function(state?: EachState): (Fragment | nil, Component | nil)
|
||||
type ExecuteIterator = function(state?: ExecuteState): (Chunk | nil, { Entity } | nil, integer | nil)
|
||||
|
||||
type EachIterator = function(EachState | nil): (Fragment | nil, Component | nil)
|
||||
type ExecuteIterator = function(EachState | nil): (Chunk | nil, { Entity } | nil, integer | nil)
|
||||
type Execute = function(chunk: Chunk, entity_list: { Entity }, entity_count: integer)
|
||||
type Prologue = function()
|
||||
type Epilogue = function()
|
||||
|
||||
type Execute = function(Chunk, { Entity }, integer)
|
||||
type Prologue = function()
|
||||
type Epilogue = function()
|
||||
type SetHook = function(entity: Entity, fragment: Fragment, new: Component, old?: Component)
|
||||
type AssignHook = function(entity: Entity, fragment: Fragment, new: Component, old?: Component)
|
||||
type InsertHook = function(entity: Entity, fragment: Fragment, new: Component)
|
||||
type RemoveHook = function(entity: Entity, fragment: Fragment, component: Component)
|
||||
|
||||
type SetHook = function(entity: Entity, fragment: Fragment, new: Component | IComponent, old?: Component | IComponent)
|
||||
type AssignHook = function(entity: Entity, fragment: Fragment, new: Component | IComponent, old?: Component | IComponent)
|
||||
type InsertHook = function(entity: Entity, fragment: Fragment, new: Component | IComponent)
|
||||
type RemoveHook = function(entity: Entity, fragment: Fragment, component: Component | IComponent)
|
||||
record Chunk
|
||||
alive: function(self: Chunk): boolean
|
||||
empty: function(self: Chunk): boolean
|
||||
has: function(self: Chunk, fragment: Fragment): boolean
|
||||
has_all: function(self: Chunk, ...: Fragment): boolean
|
||||
has_any: function(self: Chunk, ...: Fragment): boolean
|
||||
entities: function(self: Chunk): ({ Entity }, number)
|
||||
fragments: function(self: Chunk): ({ Fragment }, number)
|
||||
components: function(self: Chunk, ...: Fragment): Storage...
|
||||
end
|
||||
|
||||
record Chunk
|
||||
alive: function(self: Chunk): boolean
|
||||
empty: function(self: Chunk): boolean
|
||||
has: function(self: Chunk, fragment: Fragment): boolean
|
||||
has_all: function(self: Chunk, ...: Fragment): boolean
|
||||
has_any: function(self: Chunk, ...: Fragment): boolean
|
||||
entities: function(self: Chunk): ({ Entity }, number)
|
||||
fragments: function(self: Chunk): ({ Fragment }, number)
|
||||
components: function(self: Chunk, ...: Fragment): Storage...
|
||||
end
|
||||
record Builder
|
||||
build: function(self: Builder, prefab?: Entity): Entity
|
||||
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
|
||||
|
||||
record Builder
|
||||
build: function(self: Builder, prefab?: Entity): Entity
|
||||
multi_build: function(self: Builder, entity_count: number, prefab?: Entity): ({ Entity }, number)
|
||||
TAG: Fragment
|
||||
NAME: Fragment
|
||||
|
||||
spawn: function(self: Builder): Entity
|
||||
multi_spawn: function(self: Builder, entity_count: number): ({ Entity }, number)
|
||||
UNIQUE: Fragment
|
||||
EXPLICIT: Fragment
|
||||
INTERNAL: Fragment
|
||||
|
||||
clone: function(self: Builder, prefab: Entity): Entity
|
||||
multi_clone: function(self: Builder, entity_count: number, prefab: Entity): ({ Entity }, number)
|
||||
DEFAULT: Fragment
|
||||
DUPLICATE: Fragment
|
||||
|
||||
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...
|
||||
PREFAB: Fragment
|
||||
DISABLED: Fragment
|
||||
|
||||
set: function(self: Builder, fragment: Fragment, component?: Component | IComponent): Builder
|
||||
remove: function(self: Builder, ...: Fragment): Builder
|
||||
clear: function(self: Builder): any
|
||||
INCLUDES: Fragment
|
||||
EXCLUDES: Fragment
|
||||
REQUIRES: Fragment
|
||||
|
||||
tag: function(self: Builder): Builder
|
||||
name: function(self: Builder, name: string): Builder
|
||||
ON_SET: Fragment
|
||||
ON_ASSIGN: Fragment
|
||||
ON_INSERT: Fragment
|
||||
ON_REMOVE: Fragment
|
||||
|
||||
unique: function(self: Builder): Builder
|
||||
explicit: function(self: Builder): Builder
|
||||
internal: function(self: Builder): Builder
|
||||
GROUP: Fragment
|
||||
|
||||
default: function(self: Builder, default: Component | IComponent): Builder
|
||||
duplicate: function(self: Builder, duplicate: function(Component | IComponent): Component): Builder
|
||||
prefab: function(self: Builder): Builder
|
||||
disabled: function(self: Builder): Builder
|
||||
QUERY: Fragment
|
||||
EXECUTE: Fragment
|
||||
PROLOGUE: Fragment
|
||||
EPILOGUE: Fragment
|
||||
|
||||
include: function(self: Builder, ...: Fragment): Builder
|
||||
exclude: function(self: Builder, ...: Fragment): Builder
|
||||
require: function(self: Builder, ...: Fragment): Builder
|
||||
DESTRUCTION_POLICY: Fragment
|
||||
DESTRUCTION_POLICY_DESTROY_ENTITY: ID
|
||||
DESTRUCTION_POLICY_REMOVE_FRAGMENT: ID
|
||||
|
||||
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
|
||||
id: function(count?: number): ID...
|
||||
name: function(...: ID): string...
|
||||
|
||||
query: function(self: Builder, q: Query): Builder
|
||||
execute: function(self: Builder, exec_fn: Execute): Builder
|
||||
pack: function(primary: number, secondary: number): ID
|
||||
unpack: function(id: ID): (number, number)
|
||||
|
||||
prologue: function(self: Builder, p: Prologue): Builder
|
||||
epilogue: function(self: Builder, e: Epilogue): Builder
|
||||
defer: function(): boolean
|
||||
commit: function(): boolean
|
||||
cancel: function(): boolean
|
||||
|
||||
destruction_policy: function(self: Builder, policy: ID): Builder
|
||||
end
|
||||
spawn: function(components?: { Fragment: Component }): Entity
|
||||
multi_spawn: function(entity_count: number, components?: { Fragment: Component }): ({ Entity }, number)
|
||||
|
||||
TAG: Fragment
|
||||
NAME: Fragment
|
||||
clone: function(prefab: Entity, components?: { Fragment: Component }): Entity
|
||||
multi_clone: function(entity_count: number, prefab: Entity, components?: { Fragment: Component }): ({ Entity }, number)
|
||||
|
||||
UNIQUE: Fragment
|
||||
EXPLICIT: Fragment
|
||||
INTERNAL: Fragment
|
||||
alive: function(entity: Entity): boolean
|
||||
alive_all: function(...: Entity): boolean
|
||||
alive_any: function(...: Entity): boolean
|
||||
|
||||
DEFAULT: Fragment
|
||||
DUPLICATE: Fragment
|
||||
empty: function(entity: Entity): boolean
|
||||
empty_all: function(...: Entity): boolean
|
||||
empty_any: function(...: Entity): boolean
|
||||
|
||||
PREFAB: Fragment
|
||||
DISABLED: Fragment
|
||||
has: function(entity: Entity, fragment: Fragment): boolean
|
||||
has_all: function(entity: Entity, ...: Fragment): boolean
|
||||
has_any: function(entity: Entity, ...: Fragment): boolean
|
||||
|
||||
INCLUDES: Fragment
|
||||
EXCLUDES: Fragment
|
||||
REQUIRES: Fragment
|
||||
get: function(entity: Entity, ...: Fragment): Component...
|
||||
set: function(entity: Entity, fragment: Fragment, component: Component)
|
||||
remove: function(entity: Entity, ...: Fragment)
|
||||
clear: function(...: Entity)
|
||||
destroy: function(...: Entity)
|
||||
|
||||
ON_SET: Fragment
|
||||
ON_ASSIGN: Fragment
|
||||
ON_INSERT: Fragment
|
||||
ON_REMOVE: Fragment
|
||||
batch_set: function(q: Query, fragment: Fragment, component: Component)
|
||||
batch_remove: function(q: Query, ...: Fragment)
|
||||
batch_clear: function(...: Query)
|
||||
batch_destroy: function(...: Query)
|
||||
|
||||
GROUP: Fragment
|
||||
each: function(entity: Entity): (EachIterator, EachState | nil)
|
||||
execute: function(q: Query): (ExecuteIterator, ExecuteState | nil)
|
||||
locate: function(entity: Entity): (any | nil, number)
|
||||
|
||||
QUERY: Fragment
|
||||
EXECUTE: Fragment
|
||||
PROLOGUE: Fragment
|
||||
EPILOGUE: Fragment
|
||||
process: function(...: System)
|
||||
debug_mode: function(yesno: boolean)
|
||||
collect_garbage: function()
|
||||
|
||||
DESTRUCTION_POLICY: Fragment
|
||||
DESTRUCTION_POLICY_DESTROY_ENTITY: ID
|
||||
DESTRUCTION_POLICY_REMOVE_FRAGMENT: ID
|
||||
|
||||
id: function(count?: number): ID
|
||||
name: function(...: ID): string...
|
||||
|
||||
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
|
||||
chunk: function(first_fragment: Fragment, ...: Fragment): (Chunk, { Entity }, integer)
|
||||
builder: function(): Builder
|
||||
end
|
||||
|
||||
return Evolved
|
||||
|
||||
|
||||
Reference in New Issue
Block a user