block.raycast/entity.raycast: Updated docs to reflect changes

This commit is contained in:
REDxEYE
2024-08-20 15:33:29 +03:00
parent 1be50c2e06
commit a48d54aa27
4 changed files with 14 additions and 4 deletions
+6 -1
View File
@@ -65,12 +65,17 @@ block.raycast(start: vec3, dir: vec3, max_distance: number, [опциональ
endpoint: vec3, -- точка касания луча
iendpoint: vec3, -- позиция блока, которого касается луч
length: number, -- длина луча
normal: vec3 -- вектор нормали поверхности, которой касается луч
normal: vec3, -- вектор нормали поверхности, которой касается луч
[optional] dest: table, -- таблица куда будет записан результат вместо возврата из функции
[optional] filter: table -- массив имён блоков которые "прозрачны" для луча
} или nil
```
Бросает луч из точки start в направлении dir. Max_distance указывает максимальную длину луча.
Аргумент `filter` позволяет указать какие блоки являются "прозрачными" для луча, прим.: {"base:glass","base:water"}.
Для использования агрумент `dest` нужно чем-то заполнить(можно nil), это сделано для обратной совместимости
Функция возвращает таблицу с результатами или nil, если луч не касается блока.
Для результата будет использоваться целевая (dest) таблица вместо создания новой, если указан опциональный аргумент.
+1 -1
View File
@@ -51,7 +51,7 @@ entities.get_all_in_radius(center: vec3, radius: number) -> array<int>
```lua
entities.raycast(start: vec3, dir: vec3, max_distance: number,
ignore: int, [optional] destination: table) -> table или nil
ignore: int, [optional] destination: table, [optional] filter: table) -> table или nil
```
Функция является расширенным вариантом [block.raycast](libblock.md#raycast). Возвращает таблицу с результатами если луч касается блока, либо сущности.