@vnejs/docs 0.2.1

package/plugins/canvas/video.md

@@ -0,0 +1,71 @@
+# plugins/canvas/video/
+
+Пакет: `@vnejs/plugins.canvas.video` · namespace: `LAYER_VIDEO`
+
+Показ, скрытие, смена и preload видео на canvas-слоях.
+
+Then-bg после видео принимает те же args, что [bg.md](./bg.md), включая `overlays` (в сценарии — блок `bg:` под командой video).
+
+```vne
+$ bl.video show {logo} … then bg {castle/surgery_room} …
+  bg:
+    overlays:
+      woman: 1
+      man: 1
+```
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SHOW` | `vne:layer_video:show` | Запросить данные у обработчиков и продолжить цепочку. |
+| `HIDE` | `vne:layer_video:hide` | Запросить данные у обработчиков и продолжить цепочку. |
+| `CHANGE` | `vne:layer_video:change` | Запросить данные у обработчиков и продолжить цепочку. |
+| `ENDED` | `vne:layer_video:ended` | Запросить данные у обработчиков и продолжить цепочку. |
+| `PRELOAD` | `vne:layer_video:preload` | Событие `PRELOAD` namespace плагина. |
+| `SRC_GET` | `vne:layer_video:src_get` | Запросить данные у обработчиков и продолжить цепочку. |
+| `STATE_RM` | `vne:layer_video:state_rm` | Событие `STATE_RM` namespace плагина. |
+| `STATE_GET` | `vne:layer_video:state_get` | Получить значение или ресурс. |
+| `STATE_ADD` | `vne:layer_video:state_add` | Событие `STATE_ADD` namespace плагина. |
+| `STATE_UPDATE` | `vne:layer_video:state_update` | Обновить накопленное состояние модуля. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `TRANSITIONS_SHOW` | `string` | Значение по умолчанию: "TRANSITIONS_SHOW". |
+| `TRANSITIONS_HIDE` | `string` | Значение по умолчанию: "TRANSITIONS_HIDE". |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.video.show` | Обрабатывает SHOW, ENDED. |
+| `layer.video.hide` | Подмодуль `video.hide` плагина. |
+| `layer.video.change` | Подмодуль `video.change` плагина. |
+| `layer.video.state` | Обрабатывает STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
+| `layer.video.src_get` | Подмодуль `video.src_get` плагина. |
+| `layer.video.preload` | Подмодуль `video.preload` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [interact.md](../core/interact.md) — `INTERACT`: EVENTS.PUSH_POP, EVENTS.PUSH, EVENTS.POP
+- [media.md](../core/media.md) — `MEDIA`: EVENTS.LOAD, CONST.PRIORITIES.BACKGROUND, CONST.TYPES.VIDEO, EVENTS.GET
+- [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.PRELOAD
+- [vendors.md](../core/vendors.md) — `VENDORS`: EVENTS.UID, emitClone
+
+### Остальные
+
+- [layer.md](./layer.md) — `LAYER`: EVENTS.CHILD_CHANGE, EVENTS.UPDATE_FORCE, EVENTS.CHILDS_RM, SETTINGS.QUALITY, EVENTS.CHILD_ADD
+- [image.md](./image.md) — `LAYER_BG`: EVENTS.PRELOAD, EVENTS.SHOW

package/plugins/canvas.layers/bl.md

@@ -0,0 +1,47 @@
+# plugins/canvas.layers/bl/
+
+Пакет: `@vnejs/plugins.canvas.layers.bl` · namespace: `LAYER_BL`
+
+Фоновый canvas-слой bl: контроллер, view и команды bg/sprite/text/video.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `UPDATE` | `vne:layer_bl:update` | Обновить состояние или отображение. |
+
+## Константы
+
+- **`LAYER`** — "bl"
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `ZINDEX` | `string` | Значение по умолчанию: "ZINDEX". |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.bl.controller` | Подмодуль `bl.controller` плагина. |
+| `layer.bl.props` | Подмодуль `bl.props` плагина. |
+| `layer.bl.bg` | Подмодуль `bl.bg` плагина. |
+| `layer.bl.sprite` | Подмодуль `bl.sprite` плагина. |
+| `layer.bl.text` | Подмодуль `bl.text` плагина. |
+| `layer.bl.video` | Подмодуль `bl.video` плагина. |
+| `layer.bl.view` | Подмодуль `bl.view` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/canvas.layers/fl.md

@@ -0,0 +1,47 @@
+# plugins/canvas.layers/fl/
+
+Пакет: `@vnejs/plugins.canvas.layers.fl` · namespace: `LAYER_FL`
+
+Передний canvas-слой fl: контроллер, view и команды bg/sprite/text/video.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `UPDATE` | `vne:layer_fl:update` | Обновить состояние или отображение. |
+
+## Константы
+
+- **`LAYER`** — "fl"
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `ZINDEX` | `string` | Значение по умолчанию: "ZINDEX". |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.fl.controller` | Подмодуль `fl.controller` плагина. |
+| `layer.fl.bg` | Подмодуль `fl.bg` плагина. |
+| `layer.fl.props` | Подмодуль `fl.props` плагина. |
+| `layer.fl.sprite` | Подмодуль `fl.sprite` плагина. |
+| `layer.fl.text` | Подмодуль `fl.text` плагина. |
+| `layer.fl.video` | Подмодуль `fl.video` плагина. |
+| `layer.fl.view` | Подмодуль `fl.view` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/canvas.layers/ml.md

@@ -0,0 +1,47 @@
+# plugins/canvas.layers/ml/
+
+Пакет: `@vnejs/plugins.canvas.layers.ml` · namespace: `LAYER_ML`
+
+Средний canvas-слой ml: контроллер, view и команды bg/sprite/text/video.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `UPDATE` | `vne:layer_ml:update` | Обновить состояние или отображение. |
+
+## Константы
+
+- **`LAYER`** — "ml"
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `ZINDEX` | `string` | Значение по умолчанию: "ZINDEX". |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.ml.controller` | Подмодуль `ml.controller` плагина. |
+| `layer.ml.props` | Подмодуль `ml.props` плагина. |
+| `layer.ml.bg` | Подмодуль `ml.bg` плагина. |
+| `layer.ml.sprite` | Подмодуль `ml.sprite` плагина. |
+| `layer.ml.text` | Подмодуль `ml.text` плагина. |
+| `layer.ml.video` | Подмодуль `ml.video` плагина. |
+| `layer.ml.view` | Подмодуль `ml.view` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/canvas.layers/ul.md

@@ -0,0 +1,46 @@
+# plugins/canvas.layers/ul/
+
+Пакет: `@vnejs/plugins.canvas.layers.ul` · namespace: `LAYER_UL`
+
+Верхний canvas-слой ul без pointer-events; bg, sprite и text.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `UPDATE` | `vne:layer_ul:update` | Обновить состояние или отображение. |
+
+## Константы
+
+- **`LAYER`** — "ul"
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `ZINDEX` | `number` | Значение по умолчанию: 1500. |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.ul.controller` | Подмодуль `ul.controller` плагина. |
+| `layer.ul.bg` | Подмодуль `ul.bg` плагина. |
+| `layer.ul.props` | Подмодуль `ul.props` плагина. |
+| `layer.ul.sprite` | Подмодуль `ul.sprite` плагина. |
+| `layer.ul.text` | Подмодуль `ul.text` плагина. |
+| `layer.ul.view` | Подмодуль `ul.view` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/canvas.props/animation.md

@@ -0,0 +1,48 @@
+# plugins/canvas.props/animation/
+
+Пакет: `@vnejs/plugins.canvas.props.animation` · namespace: `LAYER_ANIMATION`
+
+CSS-анимация canvas-слоя с сохранением в state.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SET` | `vne:layer_animation:set` | Записать или обновить значение. |
+| `UNSET` | `vne:layer_animation:unset` | Событие `UNSET` namespace плагина. |
+
+## Константы
+
+- **`EXEC_ACTIONS`** — `set` / `unset`.
+- **`LINE_KEYWORDS.DANGEROUS`** — `"dangerous"`: разрешить «опасную» анимацию (если включено в settings).
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `ANIMATIONS` | `string` | Значение по умолчанию: "ANIMATIONS". |
+| `DEFAULT_DANGEROUS_ENABLED` | `boolean` | Значение по умолчанию для включения функции. |
+
+## Настройки
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `DANGEROUS_ENABLED` (`vne:layer_animation:dangerous_enabled`) | `boolean` | Включить или выключить функцию. |
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.animation` | Обрабатывает SET, UNSET, CLEAR, CHANGED. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [interact.md](../core/interact.md) — `INTERACT`: INTERACT
+- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
+
+### Остальные
+
+- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.PROPS_UPDATE, EVENTS.UPDATE_FORCE

package/plugins/canvas.props/clip.md

@@ -0,0 +1,43 @@
+# plugins/canvas.props/clip/
+
+Пакет: `@vnejs/plugins.canvas.props.clip` · namespace: `LAYER_CLIP`
+
+CSS clip-path canvas-слоя с плавной сменой.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SET` | `vne:layer_clip:set` | Записать или обновить значение. |
+| `UNSET` | `vne:layer_clip:unset` | Событие `UNSET` namespace плагина. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `CLIPS` | `string` | Значение по умолчанию: "CLIPS". |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.clip` | Обрабатывает SET, UNSET, CLEAR. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [interact.md](../core/interact.md) — `INTERACT`: INTERACT
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
+
+### Остальные
+
+- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.PROPS_UPDATE, EVENTS.UPDATE_FORCE

package/plugins/canvas.props/filters.md

@@ -0,0 +1,39 @@
+# plugins/canvas.props/filters/
+
+Пакет: `@vnejs/plugins.canvas.props.filters` · namespace: `UNKNOWN`
+
+CSS filter canvas-слоя с плавной сменой.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.filter` | Обрабатывает SET, UNSET, CLEAR. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [interact.md](../core/interact.md) — `INTERACT`: INTERACT
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
+
+### Остальные
+
+- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.PROPS_UPDATE, EVENTS.UPDATE_FORCE
+- [filter.md](./filter.md) — `LAYER_FILTER`: EVENTS.SET, EVENTS.UNSET, PARAMS.FILTERS

package/plugins/canvas.props/mask.md

@@ -0,0 +1,44 @@
+# plugins/canvas.props/mask/
+
+Пакет: `@vnejs/plugins.canvas.props.mask` · namespace: `LAYER_MASK`
+
+CSS mask canvas-слоя с анимированной сменой параметров.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SET` | `vne:layer_mask:set` | Записать или обновить значение. |
+| `UNSET` | `vne:layer_mask:unset` | Событие `UNSET` namespace плагина. |
+| `CHANGE` | `vne:layer_mask:change` | Событие `CHANGE` namespace плагина. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `MASKS` | `string` | Значение по умолчанию: "MASKS". |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.mask` | Обрабатывает SET, UNSET, CHANGE, CLEAR. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [interact.md](../core/interact.md) — `INTERACT`: INTERACT
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
+
+### Остальные
+
+- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.UPDATE_FORCE, EVENTS.PROPS_UPDATE

package/plugins/canvas.props/scale.md

@@ -0,0 +1,41 @@
+# plugins/canvas.props/scale/
+
+Пакет: `@vnejs/plugins.canvas.props.scale` · namespace: `LAYER_SCALE`
+
+CSS scale и transform-origin canvas-слоя.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SET` | `vne:layer_scale:set` | Записать или обновить значение. |
+| `UNSET` | `vne:layer_scale:unset` | Событие `UNSET` namespace плагина. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.scale` | Обрабатывает SET, UNSET, CLEAR. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [interact.md](../core/interact.md) — `INTERACT`: INTERACT
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
+
+### Остальные
+
+- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.PROPS_UPDATE, EVENTS.UPDATE_FORCE

package/plugins/controls/controls.md

@@ -0,0 +1,41 @@
+# plugins/controls/controls/
+
+Пакет: `@vnejs/plugins.controls.controls` · namespace: `CONTROLS`
+
+Стек обработчиков абстрактных control-кнопок (push/pop/emit).
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `EMIT` | `vne:controls:emit` | Инициировать действие или цикл. |
+| `PUSH` | `vne:controls:push` | Добавить элемент в очередь или стек. |
+| `POP` | `vne:controls:pop` | Извлечь элемент из очереди или стека. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `controls` | Обрабатывает EMIT, PUSH, POP. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/controls/cursor.md

@@ -0,0 +1,59 @@
+# plugins/controls/cursor/
+
+Пакет: `@vnejs/plugins.controls.cursor` · namespace: `CURSOR`
+
+Кастомный курсор: позиция, сдвиг, view и программный клик.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SHOW` | `vne:cursor:show` | Показать UI или слой. |
+| `HIDE` | `vne:cursor:hide` | Скрыть UI или слой. |
+| `UPDATE` | `vne:cursor:update` | Обновить состояние или отображение. |
+| `CLICK` | `vne:cursor:click` | Событие `CLICK` namespace плагина. |
+| `VIEW_SET` | `vne:cursor:view_set` | Записать или обновить значение. |
+| `MOVE` | `vne:cursor:move` | Событие `MOVE` namespace плагина. |
+| `MOVED` | `vne:cursor:moved` | Событие `MOVED` namespace плагина. |
+| `SHIFT` | `vne:cursor:shift` | Событие `SHIFT` namespace плагина. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `DEFAULT_VIEW` | `string` | Значение по умолчанию: "default". |
+| `DEFAULT_SHIFT_SPEED` | `number` | Значение по умолчанию: 1. |
+| `DEFAULT_SHIFT_REVERSE_X` | `boolean` | Значение по умолчанию: false. |
+| `DEFAULT_SHIFT_REVERSE_Y` | `boolean` | Значение по умолчанию: false. |
+| `BASE_SHIFT_SPEED` | `number` | Значение по умолчанию: 16. |
+
+## Настройки
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `SHIFT_SPEED` (`vne:cursor:shift_speed`) | `number` | Скорость воспроизведения или анимации. |
+| `SHIFT_REVERSE_Y` (`vne:cursor:shift_reverse_y`) | `string` | Настройка `vne:cursor:shift_reverse_y` в `shared.settings`. |
+| `SHIFT_REVERSE_X` (`vne:cursor:shift_reverse_x`) | `string` | Настройка `vne:cursor:shift_reverse_x` в `shared.settings`. |
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `cursor` | Обрабатывает MOVE, CLICK, SHIFT, VIEW_SET, …. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.INIT
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
+- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED, EVENTS.RESIZE
+- [vendors.md](../core/vendors.md) — `VENDORS`: emitClone
+
+### Остальные
+
+— нет

package/plugins/controls/gamepad.md

@@ -0,0 +1,37 @@
+# plugins/controls/gamepad/
+
+Пакет: `@vnejs/plugins.controls.gamepad` · namespace: `GAMEPAD`
+
+Геймпад → абстрактные control-события через joypad.js.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `controls.gamepad` | Подмодуль `gamepad` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+- [controls.md](./controls.md) — `CONTROLS`: EVENTS.EMIT, CONST.BUTTONS

package/plugins/controls/keyboard.md

@@ -0,0 +1,37 @@
+# plugins/controls/keyboard/
+
+Пакет: `@vnejs/plugins.controls.keyboard` · namespace: `KEYBOARD`
+
+Клавиатура → абстрактные control-события.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `controls.keyboard` | Подмодуль `keyboard` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+- [controls.md](./controls.md) — `CONTROLS`: EVENTS.EMIT, CONST.BUTTONS