mirror of
https://github.com/MihailRis/voxelcore.git
synced 2026-11-20 09:29:44 +00:00
update doc/*/scripting/builtins/libworld.md
This commit is contained in:
parent
d0803fce0c
commit
2e476a8164
2 changed files with 30 additions and 3 deletions
|
|
@ -1,5 +1,12 @@
|
|||
# *world* library
|
||||
|
||||
Existing world logic parameters:
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
| -------------- | ---- | ------- | ----------------------------- |
|
||||
| `random_ticks` | bool | `true` | Enables random block ticking. |
|
||||
| `block_ticks` | bool | `true` | Enables block ticking. |
|
||||
|
||||
```lua
|
||||
-- Checks if world is open
|
||||
world.is_open() -> bool
|
||||
|
|
@ -33,6 +40,14 @@ world.get_total_time() -> number
|
|||
-- Returns world seed.
|
||||
world.get_seed() -> int
|
||||
|
||||
-- Returns a world logic parameter value by name.
|
||||
-- Only predefined parameters are supported.
|
||||
world.get_logic(name: str) -> any
|
||||
|
||||
-- Sets a world logic parameter by name.
|
||||
-- Only predefined parameters are supported.
|
||||
world.set_logic(name: str, value: any)
|
||||
|
||||
-- Returns generator name.
|
||||
world.get_generator() -> str
|
||||
|
||||
|
|
@ -112,5 +127,3 @@ world.raycast(
|
|||
length: number, -- ray length
|
||||
normal: vec3, -- normal vector of the surface touched by the ray
|
||||
} or nil if the ray did not touch a block or entity
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,5 +1,12 @@
|
|||
# Библиотека *world*
|
||||
|
||||
Существующие параметры логики мира:
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
| -------------- | ---- | ------------ | -------------------------------- |
|
||||
| `random_ticks` | bool | `true` | Включает случайные такты блоков. |
|
||||
| `block_ticks` | bool | `true` | Включает такты блоков. |
|
||||
|
||||
```lua
|
||||
-- Проверяет, открыт ли мир
|
||||
world.is_open() -> boolean
|
||||
|
|
@ -32,6 +39,14 @@ world.get_total_time() -> number
|
|||
-- Возвращает зерно мира.
|
||||
world.get_seed() -> int
|
||||
|
||||
-- Возвращает значение параметра логики мира по имени.
|
||||
-- Поддерживаются только предопределённые параметры.
|
||||
world.get_logic(name: string) -> any
|
||||
|
||||
-- Устанавливает параметр логики мира по имени.
|
||||
-- Поддерживаются только предопределённые параметры.
|
||||
world.set_logic(name: string, value: any)
|
||||
|
||||
-- Возвращает имя генератора.
|
||||
world.get_generator() -> string
|
||||
|
||||
|
|
@ -111,4 +126,3 @@ world.raycast(
|
|||
length: number, -- длина луча
|
||||
normal: vec3, -- вектор нормали поверхности, которой касается луч
|
||||
} или nil если луч не коснулся блока или сущности
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue