mirror of
https://github.com/BlackMATov/evolved.lua.git
synced 2025-12-13 03:29:08 +07:00
update readme
This commit is contained in:
50
README.md
50
README.md
@@ -56,7 +56,6 @@
|
||||
- [Functions](#functions)
|
||||
- [Classes](#classes)
|
||||
- [Chunk](#chunk)
|
||||
- [Scheme](#scheme)
|
||||
- [Builder](#builder)
|
||||
- [License](#license)
|
||||
|
||||
@@ -1063,7 +1062,6 @@ UNIQUE :: fragment
|
||||
EXPLICIT :: fragment
|
||||
INTERNAL :: fragment
|
||||
|
||||
SCHEME :: fragment
|
||||
DEFAULT :: fragment
|
||||
DUPLICATE :: fragment
|
||||
|
||||
@@ -1162,14 +1160,6 @@ chunk_mt:fragments :: fragment[], integer
|
||||
chunk_mt:components :: fragment... -> storage...
|
||||
```
|
||||
|
||||
#### Scheme
|
||||
|
||||
```
|
||||
scheme_boolean :: scheme
|
||||
scheme_number :: scheme
|
||||
scheme_record :: <string, scheme> -> scheme
|
||||
```
|
||||
|
||||
#### Builder
|
||||
|
||||
```
|
||||
@@ -1198,7 +1188,6 @@ builder_mt:unique :: builder
|
||||
builder_mt:explicit :: builder
|
||||
builder_mt:internal :: builder
|
||||
|
||||
builder_mt:scheme :: evolved.scheme -> builder
|
||||
builder_mt:default :: component -> builder
|
||||
builder_mt:duplicate :: {component -> component} -> builder
|
||||
|
||||
@@ -1233,7 +1222,7 @@ builder_mt:destruction_policy :: id -> builder
|
||||
|
||||
## vX.X.X
|
||||
|
||||
- Added the new [`evolved.scheme`](#evovledscheme) fragment trait
|
||||
- Nothing yet, stay tuned!
|
||||
|
||||
## v1.2.0
|
||||
|
||||
@@ -1264,8 +1253,6 @@ builder_mt:destruction_policy :: id -> builder
|
||||
|
||||
### `evolved.INTERNAL`
|
||||
|
||||
### `evovled.SCHEME`
|
||||
|
||||
### `evolved.DEFAULT`
|
||||
|
||||
### `evolved.DUPLICATE`
|
||||
@@ -1676,33 +1663,6 @@ function evolved.chunk_mt:fragments() end
|
||||
function evolved.chunk_mt:components(...) end
|
||||
```
|
||||
|
||||
### Scheme
|
||||
|
||||
#### `evolved.scheme_boolean`
|
||||
|
||||
```lua
|
||||
---@return evolved.scheme scheme
|
||||
---@nodiscard
|
||||
function evolved.scheme_boolean() end
|
||||
```
|
||||
|
||||
#### `evolved.scheme_number`
|
||||
|
||||
```lua
|
||||
---@return evolved.scheme scheme
|
||||
---@nodiscard
|
||||
function evolved.scheme_number() end
|
||||
```
|
||||
|
||||
#### `evolved.scheme_record`
|
||||
|
||||
```lua
|
||||
---@param field_schemes table<string, evolved.scheme>
|
||||
---@return evolved.scheme scheme
|
||||
---@nodiscard
|
||||
function evolved.scheme_record(field_schemes) end
|
||||
```
|
||||
|
||||
### Builder
|
||||
|
||||
#### `evolved.builder`
|
||||
@@ -1841,14 +1801,6 @@ function evolved.builder_mt:explicit() end
|
||||
function evolved.builder_mt:internal() end
|
||||
```
|
||||
|
||||
#### `evolved.builder_mt:scheme`
|
||||
|
||||
```lua
|
||||
---@param scheme evolved.scheme
|
||||
---@return evolved.builder builder
|
||||
function evolved.builder_mt:scheme(scheme) end
|
||||
```
|
||||
|
||||
#### `evolved.builder_mt:default`
|
||||
|
||||
```lua
|
||||
|
||||
@@ -7,7 +7,7 @@ local N = 10000
|
||||
|
||||
print '----------------------------------------'
|
||||
|
||||
basics.describe_bench(string.format('Scheme Benchmarks: Evolved AoS Processing | %d entities', N),
|
||||
basics.describe_bench(string.format('Process Benchmarks: Evolved AoS Processing | %d entities', N),
|
||||
function(w)
|
||||
evo.process(w)
|
||||
end,
|
||||
@@ -48,7 +48,7 @@ basics.describe_bench(string.format('Scheme Benchmarks: Evolved AoS Processing |
|
||||
evo.destroy(w)
|
||||
end)
|
||||
|
||||
basics.describe_bench(string.format('Scheme Benchmarks: Evolved SoA Processing | %d entities', N),
|
||||
basics.describe_bench(string.format('Process Benchmarks: Evolved SoA Processing | %d entities', N),
|
||||
function(w)
|
||||
evo.process(w)
|
||||
end,
|
||||
|
||||
Reference in New Issue
Block a user