add entity events to docs
This commit is contained in:
@@ -145,3 +145,67 @@ rig:is_visible([optional] index: int) -> bool
|
||||
-- или всего скелета, если индекс не указан
|
||||
rig:set_visible([optional] index: int, status: bool)
|
||||
```
|
||||
|
||||
## События компонента
|
||||
|
||||
```lua
|
||||
function on_despawn()
|
||||
```
|
||||
|
||||
Вызывается при удалении сущности.
|
||||
|
||||
```lua
|
||||
function on_grounded(force: number)
|
||||
```
|
||||
|
||||
Вызывается при приземлении. В качестве первого аргумента передается сила удара. (На данный момент - модуль скорости).
|
||||
|
||||
```lua
|
||||
function on_fall()
|
||||
```
|
||||
|
||||
Вызывается при начале падения.
|
||||
|
||||
```lua
|
||||
function on_save()
|
||||
```
|
||||
|
||||
Вызывается перед сохранением данных компонентов. Здесь можно записать данные, которые нужно сохранить, в таблицу *SAVED_DATA*, которая доступна весь срок жизни компонента.
|
||||
|
||||
```lua
|
||||
function on_sensor_enter(index: int, entity: int)
|
||||
```
|
||||
|
||||
Вызывается при попадании другой сущности в сенсор с индексом, передаваемым первым аргументом. UID сущности, попавшей в сенсор, передается вторым аргументом.
|
||||
|
||||
```lua
|
||||
function on_sensor_exit(index: int, entity: int)
|
||||
```
|
||||
|
||||
Вызывается при выходе другой сущности из сенсора с индексом, передаваемым первым аргументом. UID сущности, покинувшей сенсор, передается вторым аргументом.
|
||||
|
||||
```lua
|
||||
function on_aim_on(playerid: int)
|
||||
```
|
||||
|
||||
Вызывается при наведении прицела игрока на сущность. ID игрока передается в качестве аргумента.
|
||||
|
||||
```lua
|
||||
function on_aim_off(playerid: int)
|
||||
```
|
||||
|
||||
Вызывается когда игрок уводит прицел с сущности. ID игрока передается в качестве аргумента.
|
||||
|
||||
```lua
|
||||
function on_attacked(attackerid: int, playerid: int)
|
||||
```
|
||||
|
||||
Вызывается при атаке на сущность (ЛКМ по сущности). Первым аргументом передается UID атакующей сущности. ID атакующего игрока передается вторым аргументом. Если сущность была атакована не игроком, значение второго аргумента будет равно -1.
|
||||
|
||||
|
||||
```lua
|
||||
function on_used(playerid: int)
|
||||
```
|
||||
|
||||
Вызывается при использовании сущности (ПКМ по сущности). ID игрока передается в качестве аргумента.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user