mirror of
https://github.com/BlackMATov/evolved.lua.git
synced 2025-12-14 12:10:23 +07:00
temp remove pairs to merge other changes to dev
This commit is contained in:
143
README.md
143
README.md
@@ -53,8 +53,7 @@
|
||||
- [Cheat Sheet](#cheat-sheet)
|
||||
- [Aliases](#aliases)
|
||||
- [Predefs](#predefs)
|
||||
- [Core Functions](#core-functions)
|
||||
- [Relation Functions](#relation-functions)
|
||||
- [Functions](#functions)
|
||||
- [Classes](#classes)
|
||||
- [Chunk](#chunk)
|
||||
- [Builder](#builder)
|
||||
@@ -157,7 +156,6 @@ function evolved.pack(index, version) end
|
||||
---@param id evolved.id
|
||||
---@return integer primary
|
||||
---@return integer secondary
|
||||
---@return integer options
|
||||
---@nodiscard
|
||||
function evolved.unpack(id) end
|
||||
```
|
||||
@@ -1026,7 +1024,6 @@ assert(not evolved.alive(entity))
|
||||
|
||||
```
|
||||
id :: implementation-specific
|
||||
pair :: id
|
||||
|
||||
entity :: id
|
||||
fragment :: id
|
||||
@@ -1050,20 +1047,14 @@ remove_hook :: {entity, fragment, component}
|
||||
|
||||
each_state :: implementation-specific
|
||||
execute_state :: implementation-specific
|
||||
primaries_state :: implementation-specific
|
||||
secondaries_state :: implementation-specific
|
||||
|
||||
each_iterator :: {each_state? -> fragment?, component?}
|
||||
execute_iterator :: {execute_state? -> chunk?, entity[]?, integer?}
|
||||
primaries_iterator :: {primaries_state? -> fragment?, component?}
|
||||
secondaries_iterator :: {secondaries_state? -> fragment?, component?}
|
||||
```
|
||||
|
||||
### Predefs
|
||||
|
||||
```
|
||||
ANY :: fragment
|
||||
|
||||
TAG :: fragment
|
||||
NAME :: fragment
|
||||
|
||||
@@ -1099,7 +1090,7 @@ DESTRUCTION_POLICY_DESTROY_ENTITY :: id
|
||||
DESTRUCTION_POLICY_REMOVE_FRAGMENT :: id
|
||||
```
|
||||
|
||||
### Core Functions
|
||||
### Functions
|
||||
|
||||
```
|
||||
id :: integer? -> id...
|
||||
@@ -1147,25 +1138,6 @@ debug_mode :: boolean -> ()
|
||||
collect_garbage :: ()
|
||||
```
|
||||
|
||||
### Relation Functions
|
||||
|
||||
```
|
||||
pair :: id, id -> pair
|
||||
unpair :: pair -> id, id
|
||||
|
||||
is_pair :: id -> boolean
|
||||
is_wildcard :: id -> boolean
|
||||
|
||||
primary :: entity, fragment, integer? -> fragment?, component?
|
||||
secondary :: entity, fragment, integer? -> fragment?, component?
|
||||
|
||||
primaries :: entity, fragment -> {primaries_state? -> fragment?, component?}, primaries_state?
|
||||
secondaries :: entity, fragment -> {secondaries_state? -> fragment?, component?}, secondaries_state?
|
||||
|
||||
primary_count :: entity, fragment -> integer
|
||||
secondary_count :: entity, fragment -> integer
|
||||
```
|
||||
|
||||
### Classes
|
||||
|
||||
#### Chunk
|
||||
@@ -1260,8 +1232,6 @@ builder_mt:destruction_policy :: id -> builder
|
||||
|
||||
## Predefs
|
||||
|
||||
### `evolved.ANY`
|
||||
|
||||
### `evolved.TAG`
|
||||
|
||||
### `evolved.NAME`
|
||||
@@ -1310,7 +1280,7 @@ builder_mt:destruction_policy :: id -> builder
|
||||
|
||||
### `evolved.DESTRUCTION_POLICY_REMOVE_FRAGMENT`
|
||||
|
||||
## Core Functions
|
||||
## Functions
|
||||
|
||||
### `evolved.id`
|
||||
|
||||
@@ -1346,7 +1316,6 @@ function evolved.pack(index, version) end
|
||||
---@param id evolved.id
|
||||
---@return integer primary
|
||||
---@return integer secondary
|
||||
---@return integer options
|
||||
---@nodiscard
|
||||
function evolved.unpack(id) end
|
||||
```
|
||||
@@ -1578,112 +1547,6 @@ function evolved.debug_mode(yesno) end
|
||||
function evolved.collect_garbage() end
|
||||
```
|
||||
|
||||
## Relation Functions
|
||||
|
||||
### `evolved.pair`
|
||||
|
||||
```lua
|
||||
---@param primary evolved.id
|
||||
---@param secondary evolved.id
|
||||
---@return evolved.pair pair
|
||||
---@nodiscard
|
||||
function evolved.pair(primary, secondary) end
|
||||
```
|
||||
|
||||
### `evolved.unpair`
|
||||
|
||||
```lua
|
||||
---@param pair evolved.pair
|
||||
---@return evolved.id primary
|
||||
---@return evolved.id secondary
|
||||
---@nodiscard
|
||||
function evolved.unpair(pair) end
|
||||
```
|
||||
|
||||
### `evolved.is_pair`
|
||||
|
||||
```lua
|
||||
---@param id evolved.id
|
||||
---@return boolean
|
||||
---@nodiscard
|
||||
function evolved.is_pair(id) end
|
||||
```
|
||||
|
||||
### `evolved.is_wildcard`
|
||||
|
||||
```lua
|
||||
---@param id evolved.id
|
||||
---@return boolean
|
||||
---@nodiscard
|
||||
function evolved.is_wildcard(id) end
|
||||
```
|
||||
|
||||
### `evolved.primary`
|
||||
|
||||
```lua
|
||||
---@param entity evolved.entity
|
||||
---@param secondary evolved.fragment
|
||||
---@param index? integer
|
||||
---@return evolved.fragment? primary
|
||||
---@return evolved.component? component
|
||||
---@nodiscard
|
||||
function evolved.primary(entity, secondary, index) end
|
||||
```
|
||||
|
||||
### `evolved.secondary`
|
||||
|
||||
```lua
|
||||
---@param entity evolved.entity
|
||||
---@param primary evolved.fragment
|
||||
---@param index? integer
|
||||
---@return evolved.fragment? secondary
|
||||
---@return evolved.component? component
|
||||
---@nodiscard
|
||||
function evolved.secondary(entity, primary, index) end
|
||||
```
|
||||
|
||||
### `evolved.primaries`
|
||||
|
||||
```lua
|
||||
---@param entity evolved.entity
|
||||
---@param secondary evolved.fragment
|
||||
---@return evolved.primaries_iterator iterator
|
||||
---@return evolved.primaries_state? iterator_state
|
||||
---@nodiscard
|
||||
function evolved.primaries(entity, secondary) end
|
||||
```
|
||||
|
||||
### `evolved.secondaries`
|
||||
|
||||
```lua
|
||||
---@param entity evolved.entity
|
||||
---@param primary evolved.fragment
|
||||
---@return evolved.secondaries_iterator iterator
|
||||
---@return evolved.secondaries_state? iterator_state
|
||||
---@nodiscard
|
||||
function evolved.secondaries(entity, primary) end
|
||||
```
|
||||
|
||||
### `evolved.primary_count`
|
||||
|
||||
```lua
|
||||
---@param entity evolved.entity
|
||||
---@param secondary evolved.fragment
|
||||
---@return integer
|
||||
---@nodiscard
|
||||
function evolved.primary_count(entity, secondary) end
|
||||
```
|
||||
|
||||
### `evolved.secondary_count`
|
||||
|
||||
```lua
|
||||
---@param entity evolved.entity
|
||||
---@param primary evolved.fragment
|
||||
---@return integer
|
||||
---@nodiscard
|
||||
function evolved.secondary_count(entity, primary) end
|
||||
```
|
||||
|
||||
## Classes
|
||||
|
||||
### Chunk
|
||||
|
||||
Reference in New Issue
Block a user