@vnejs/docs 0.2.1

package/plugins/audio/audio.md

@@ -0,0 +1,61 @@
+# plugins/audio/audio/
+
+Пакет: `@vnejs/plugins.audio.audio` · namespace: `AUDIO`
+
+Базовый аудиодвижок: play/stop/pause/resume, volume и загрузка медиа через Web Audio.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `PLAY` | `vne:audio:play` | Запросить данные у обработчиков и продолжить цепочку. |
+| `STOP` | `vne:audio:stop` | Запросить данные у обработчиков и продолжить цепочку. |
+| `PAUSE` | `vne:audio:pause` | Запросить данные у обработчиков и продолжить цепочку. |
+| `RESUME` | `vne:audio:resume` | Запросить данные у обработчиков и продолжить цепочку. |
+| `MEDIA_GET` | `vne:audio:media_get` | Получить значение или ресурс. |
+| `MEDIA_LOAD` | `vne:audio:media_load` | Загрузить данные или ресурс. |
+| `VOLUME` | `vne:audio:volume` | Запросить данные у обработчиков и продолжить цепочку. |
+| `VOLUME_GET` | `vne:audio:volume_get` | Запросить данные у обработчиков и продолжить цепочку. |
+| `VOLUME_CHANGED` | `vne:audio:volume_changed` | Зафиксировать изменение состояния. |
+| `GLOBAL_PAUSE` | `vne:audio:global_pause` | Приостановить воспроизведение. |
+| `GLOBAL_RESUME` | `vne:audio:global_resume` | Событие `GLOBAL_RESUME` namespace плагина. |
+| `ENDED` | `vne:audio:ended` | Событие `ENDED` namespace плагина. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `QUALITY` | `string` | Значение по умолчанию: "64k". |
+
+## Настройки
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `VOLUME` (`vne:audio:volume`) | `number` | Уровень громкости. |
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `audio.play` | Подмодуль `play` плагина. |
+| `audio.stop` | Подмодуль `stop` плагина. |
+| `audio.media` | Обрабатывает MEDIA_GET, MEDIA_LOAD. |
+| `audio.pause` | Подмодуль `pause` плагина. |
+| `audio.volume` | Обрабатывает VOLUME, VOLUME_GET, CHANGED. |
+| `audio.resume` | Подмодуль `resume` плагина. |
+| `audio.ended` | Обрабатывает PLAY, STOP. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [media.md](../core/media.md) — `MEDIA`: EVENTS.LOAD, CONST.PRIORITIES.BACKGROUND, CONST.TYPES.AUDIO
+- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED
+
+### Остальные
+
+- [volume.md](../settings/volume.md) — `VOLUME`: SETTINGS.COMMON, SETTINGS.AUDIO

package/plugins/audio/music.md

@@ -0,0 +1,39 @@
+# plugins/audio/music/
+
+Пакет: `@vnejs/plugins.audio.music` · namespace: `MUSIC`
+
+Воспроизведение зацикленной музыки из сценария с сохранением state.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `VOLUME` (`vne:music:volume`) | `number` | Уровень громкости. |
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `music` | Модуль `music`. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/audio/sound.md

@@ -0,0 +1,39 @@
+# plugins/audio/sound/
+
+Пакет: `@vnejs/plugins.audio.sound` · namespace: `SOUND`
+
+Воспроизведение звуковых эффектов из сценария с отдельной громкостью.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `VOLUME` (`vne:sound:volume`) | `number` | Уровень громкости. |
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `sound` | Модуль `sound`. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/audio/voice.md

@@ -0,0 +1,43 @@
+# plugins/audio/voice/
+
+Пакет: `@vnejs/plugins.audio.voice` · namespace: `VOICE`
+
+Озвучка реплик без loop, сброс при interact и настройка языка voice.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `DEFAULT_LANG` | `string` | Значение по умолчанию: "ru". |
+
+## Настройки
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `VOLUME` (`vne:voice:volume`) | `number` | Уровень громкости. |
+| `LANG` (`vne:voice:lang`) | `string` | Настройка `vne:voice:lang` в `shared.settings`. |
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `voice` | Модуль `voice`. |
+| `voice.lang` | Подмодуль `lang` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT
+
+### Остальные
+
+— нет

package/plugins/canvas/bg.md

@@ -0,0 +1,76 @@
+# plugins/canvas/bg/
+
+Пакет: `@vnejs/plugins.canvas.child.bg` · namespace: `LAYER_BG`
+
+Показ, скрытие, смена и preload изображений на canvas-слоях.
+
+## Overlays
+
+В args сценария / событий поле `overlays?: Record<string, string>` задаёт слои поверх базового `{name}/index`: каждый ключ `key → value` резолвится в медиа `{name}/{key}/{value}`.
+
+```vne
+$ bl.bg show {castle/surgery_room} opacity 500
+  overlays:
+    woman: 1
+    man: 1
+```
+
+- `PRELOAD` / `SRC_GET` / show / change читают `overlays` из payload или `args`.
+- `ARGS_INJECT` (например [bg.speak.md](./bg.speak.md)) может дописать `overlays` в args перед резолвом src.
+- На слое child рисуется через `src` (массив URL: index + overlays), не через React-prop `overlays`.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SHOW` | `vne:layer_bg:show` | Запросить данные у обработчиков и продолжить цепочку. |
+| `HIDE` | `vne:layer_bg:hide` | Запросить данные у обработчиков и продолжить цепочку. |
+| `CHANGE` | `vne:layer_bg:change` | Запросить данные у обработчиков и продолжить цепочку. |
+| `PRELOAD` | `vne:layer_bg:preload` | Событие `PRELOAD` namespace плагина. |
+| `SRC_GET` | `vne:layer_bg:src_get` | Получить значение или ресурс. |
+| `ARGS_INJECT` | `vne:layer_bg:args_inject` | Событие `ARGS_INJECT` namespace плагина. |
+| `STATE_RM` | `vne:layer_bg:state_rm` | Событие `STATE_RM` namespace плагина. |
+| `STATE_GET` | `vne:layer_bg:state_get` | Получить значение или ресурс. |
+| `STATE_GET_ALL` | `vne:layer_bg:state_get_all` | Событие `STATE_GET_ALL` namespace плагина. |
+| `STATE_ADD` | `vne:layer_bg:state_add` | Событие `STATE_ADD` namespace плагина. |
+| `STATE_UPDATE` | `vne:layer_bg:state_update` | Обновить накопленное состояние модуля. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `TRANSITIONS_SHOW` | `string` | Значение по умолчанию: "TRANSITIONS_SHOW". |
+| `TRANSITIONS_HIDE` | `string` | Значение по умолчанию: "TRANSITIONS_HIDE". |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.bg.show` | Подмодуль `image.show` плагина. |
+| `layer.bg.hide` | Подмодуль `image.hide` плагина. |
+| `layer.bg.staff` | Подмодуль `image.staff` плагина. |
+| `layer.bg.state` | Обрабатывает STATE_UPDATE, STATE_GET, STATE_GET_ALL, STATE_ADD, …. |
+| `layer.bg.change` | Подмодуль `image.change` плагина. |
+| `layer.bg.preload` | Подмодуль `image.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.IMAGE, 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`: emitClone, EVENTS.UID
+
+### Остальные
+
+- [layer.md](./layer.md) — `LAYER`: EVENTS.UPDATE_FORCE, EVENTS.CHILD_CHANGE, EVENTS.CHILDS_RM, SETTINGS.QUALITY, EVENTS.CHILD_ADD

package/plugins/canvas/bg.speak.md

@@ -0,0 +1,54 @@
+# plugins/canvas/bg.speak/
+
+Пакет: `@vnejs/plugins.canvas.bg.speak` · namespace: `LAYER_BG_SPEAK`
+
+Переключение вариантов image по текущему спикеру реплики.
+
+На `LAYER_BG.ARGS_INJECT` возвращает `{ overlays: args.speak[speaker] }` — мержится в [bg.md](./bg.md) args. При `PRELOAD` с `overlays` и `speak` дополнительно прелоадит варианты с overrides спикеров.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `PUSH` | `vne:layer_bg_speak:push` | Добавить элемент в очередь или стек. |
+| `POP` | `vne:layer_bg_speak:pop` | Извлечь элемент из очереди или стека. |
+| `SPEAKER` | `vne:layer_bg_speak:speaker` | Запросить данные у обработчиков и продолжить цепочку. |
+| `START` | `vne:layer_bg_speak:start` | Начать процесс. |
+| `END` | `vne:layer_bg_speak:end` | Запросить данные у обработчиков и продолжить цепочку. |
+| `BGS_GET` | `vne:layer_bg_speak:bgs_get` | Получить значение или ресурс. |
+| `BGS_GET_ACTIVE` | `vne:layer_bg_speak:bgs_get_active` | Событие `BGS_GET_ACTIVE` namespace плагина. |
+| `OPTION_SET` | `vne:layer_bg_speak:option_set` | Записать или обновить значение. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `MIN_DURATION` | `number` | Значение по умолчанию: 2000. |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.bg.speak.sources` | Обрабатывает PUSH, POP. |
+| `layer.bg.speak.duration` | Подмодуль `image.speak.duration` плагина. |
+| `layer.bg.speak.preload` | Подмодуль `image.speak.preload` плагина. |
+| `layer.bg.speak.staff` | Обрабатывает ARGS_INJECT, BGS_GET, BGS_GET_ACTIVE, OPTION_SET. |
+| `layer.bg.speak` | Обрабатывает END, START, SPEAKER. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [vendors.md](../core/vendors.md) — `VENDORS`: emitClone
+
+### Остальные
+
+- [image.md](./image.md) — `LAYER_BG`: EVENTS.PRELOAD, EVENTS.ARGS_INJECT, EVENTS.CHANGE, EVENTS.STATE_GET_ALL

package/plugins/canvas/fill.md

@@ -0,0 +1,66 @@
+# plugins/canvas/fill/
+
+Пакет: `@vnejs/plugins.canvas.child.fill` · namespace: `LAYER_FILL`
+
+Показ, смена и скрытие цветовой заливки на весь canvas-слой.
+
+## Синтаксис сценария
+
+```
+$ bl.fill show fillId1 {rgba(255, 255, 255, 0.5)} 300
+$ bl.fill change fillId1 {rgba(0, 0, 0, 0.5)} 300
+$ bl.fill hide fillId1 300
+```
+
+Переход show/hide — всегда `opacity`. На слоях `bl` / `ml` / `fl` / `ul`: `$ {layer}.fill …`.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SHOW` | `vne:layer_fill:show` | Показать заливку по `id` и цвету. |
+| `CHANGE` | `vne:layer_fill:change` | Сменить цвет существующей заливки. |
+| `HIDE` | `vne:layer_fill:hide` | Скрыть заливку по `id`. |
+| `STATE_UPDATE` | `vne:layer_fill:state_update` | Обновить накопленное состояние модуля. |
+| `STATE_GET` | `vne:layer_fill:state_get` | Получить запись заливки по `id`. |
+| `STATE_ADD` | `vne:layer_fill:state_add` | Добавить запись в state. |
+| `STATE_RM` | `vne:layer_fill:state_rm` | Удалить запись из state. |
+
+## Константы
+
+| Ключ | Смысл |
+|------|-------|
+| `ACTIONS` | `show` / `change` / `hide` |
+| `LAYER_CHILD_TYPE` | `"fill"` |
+
+## Параметры
+
+| Ключ | Смысл |
+|------|-------|
+| `TRANSITIONS_SHOW` | Opacity fade-in для show. |
+| `TRANSITIONS_HIDE` | Opacity fade-out для hide. |
+| `TRANSITIONS_CHANGE` | Transition для change. |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.fill.show` | Показ заливки на слое. |
+| `layer.fill.change` | Смена цвета заливки. |
+| `layer.fill.hide` | Скрытие заливки. |
+| `layer.fill.state` | STATE_*, восстановление через `STATE.SET` / `STATE.CLEAR`. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [interact.md](../core/interact.md) — `INTERACT`: EVENTS.PUSH_POP, EVENTS.PUSH, EVENTS.POP
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
+
+### Остальные
+
+- [layer.md](./layer.md) — `LAYER`: EVENTS.CHILD_ADD, EVENTS.CHILD_CHANGE, EVENTS.CHILD_RM, EVENTS.UPDATE_FORCE

package/plugins/canvas/layer.md

@@ -0,0 +1,57 @@
+# plugins/canvas/layer/
+
+Пакет: `@vnejs/plugins.canvas.layer` · namespace: `LAYER`
+
+Качество canvas, размеры через CSS-переменные и viewport meta.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `UPDATE_FORCE` | `vne:layer:update_force` | Обновить состояние или отображение. |
+| `UPDATE_FAST` | `vne:layer:update_fast` | Обновить состояние или отображение. |
+| `CHILD_RM` | `vne:layer:child_rm` | Событие `CHILD_RM` namespace плагина. |
+| `CHILDS_RM` | `vne:layer:childs_rm` | Событие `CHILDS_RM` namespace плагина. |
+| `CHILD_ADD` | `vne:layer:child_add` | Событие `CHILD_ADD` namespace плагина. |
+| `CHILD_CHANGE` | `vne:layer:child_change` | Событие `CHILD_CHANGE` namespace плагина. |
+| `CHILDS_CHANGE` | `vne:layer:childs_change` | Событие `CHILDS_CHANGE` namespace плагина. |
+| `CHILD_GET` | `vne:layer:child_get` | Получить значение или ресурс. |
+| `PROPS_UPDATE` | `vne:layer:props_update` | Обновить состояние или отображение. |
+| `STATE_GET` | `vne:layer:state_get` | Получить значение или ресурс. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `DEFAULT_QUALITY` | `string` | Значение по умолчанию: "DEFAULT_QUALITY". |
+
+## Настройки
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `WIDTH` (`vne:canvas:width`) | `number` | Настройка `vne:canvas:width` в `shared.settings`. |
+| `HEIGHT` (`vne:canvas:height`) | `number` | Настройка `vne:canvas:height` в `shared.settings`. |
+| `QUALITY` (`vne:canvas:quality`) | `number` | Настройка `vne:canvas:quality` в `shared.settings`. |
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.quality` | Подмодуль `quality` плагина. |
+| `layer.viewport` | Обрабатывает CHANGED, STARTED. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEAR
+- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT, EVENTS.SET
+- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
+
+### Остальные
+
+— нет

package/plugins/canvas/sprite.md

@@ -0,0 +1,85 @@
+# plugins/canvas/sprite/
+
+Пакет: `@vnejs/plugins.canvas.sprite` · namespace: `LAYER_SPRITE`
+
+Показ, скрытие, перемещение и смена спрайтов на canvas-слоях.
+
+## Overlays
+
+Два связанных смысла одного имени:
+
+1. **Args / сценарий** — `args.overlays?: Record<string, string>`: карта слоёв вида `emotion` / `hair` / `wear` → значение; пути `{variation}/{key}/{value}` (+ `{variation}/index`).
+2. **Layer child / React** — после `SRC_GET` на child и в `<Sprite />` поле `overlays` — массив `{ src }` для отрисовки.
+
+```vne
+$ ul.sprite show co left {co/default} opacity 500
+  overlays:
+    emotion: default
+    hair: wild_hair
+    wear: medical_shirt
+```
+
+`PARAMS.LAYER_SPRITE.SPRITE_INFO[type]`:
+
+| Поле | Смысл |
+|------|-------|
+| `mapOverlays?` | Преобразование карты overlays перед резолвом путей |
+| `getSrc?` | Кастомный список src по `(variation, realOverlays, options, otherArgs)` |
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SHOW` | `vne:layer_sprite:show` | Запросить данные у обработчиков и продолжить цепочку. |
+| `HIDE` | `vne:layer_sprite:hide` | Скрыть UI или слой. |
+| `MOVE` | `vne:layer_sprite:move` | Событие `MOVE` namespace плагина. |
+| `CHANGE` | `vne:layer_sprite:change` | Запросить данные у обработчиков и продолжить цепочку. |
+| `PRELOAD` | `vne:layer_sprite:preload` | Событие `PRELOAD` namespace плагина. |
+| `SRC_GET` | `vne:layer_sprite:src_get` | Получить значение или ресурс. |
+| `STATE_UPDATE` | `vne:layer_sprite:state_update` | Обновить накопленное состояние модуля. |
+| `STATE_GET` | `vne:layer_sprite:state_get` | Получить значение или ресурс. |
+| `STATE_ADD` | `vne:layer_sprite:state_add` | Событие `STATE_ADD` namespace плагина. |
+| `STATE_RM` | `vne:layer_sprite:state_rm` | Событие `STATE_RM` namespace плагина. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `TRANSITIONS_SHOW` | `string` | Значение по умолчанию: "TRANSITIONS_SHOW". |
+| `TRANSITIONS_HIDE` | `string` | Значение по умолчанию: "TRANSITIONS_HIDE". |
+| `POSITIONS` | `string` | Значение по умолчанию: "POSITIONS". |
+| `SPRITE_INFO` | `string` | Значение по умолчанию: "SPRITE_INFO". |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.sprite.src` | Подмодуль `sprite.src` плагина. |
+| `layer.sprite.show` | Подмодуль `sprite.show` плагина. |
+| `layer.sprite.hide` | Подмодуль `sprite.hide` плагина. |
+| `layer.sprite.move` | Подмодуль `sprite.move` плагина. |
+| `layer.sprite.state` | Обрабатывает STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
+| `layer.sprite.change` | Подмодуль `sprite.change` плагина. |
+| `layer.sprite.preload` | Подмодуль `sprite.preload` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [interact.md](../core/interact.md) — `INTERACT`: EVENTS.PUSH_POP
+- [media.md](../core/media.md) — `MEDIA`: EVENTS.LOAD, CONST.TYPES.IMAGE, 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`: emitClone
+
+### Остальные
+
+- [layer.md](./layer.md) — `LAYER`: EVENTS.UPDATE_FORCE, EVENTS.CHILD_GET, EVENTS.CHILD_CHANGE, EVENTS.CHILD_RM, SETTINGS.QUALITY, EVENTS.CHILD_ADD

package/plugins/canvas/sprite.speak.md

@@ -0,0 +1,53 @@
+# plugins/canvas/sprite.speak/
+
+Пакет: `@vnejs/plugins.canvas.sprite.speak` · namespace: `LAYER_SPRITE_SPEAK`
+
+Включение опции speak у sprite при речи спикера.
+
+Args спрайта могут содержать `overlays` (как у [sprite.md](./sprite.md)); speak меняет `options.speak` и перезапускает change/preload с теми же args.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `PUSH` | `vne:layer_sprite_speak:push` | Добавить элемент в очередь или стек. |
+| `POP` | `vne:layer_sprite_speak:pop` | Извлечь элемент из очереди или стека. |
+| `SPEAKER` | `vne:layer_sprite_speak:speaker` | Запросить данные у обработчиков и продолжить цепочку. |
+| `START` | `vne:layer_sprite_speak:start` | Начать процесс. |
+| `END` | `vne:layer_sprite_speak:end` | Запросить данные у обработчиков и продолжить цепочку. |
+| `SPRITE_GET` | `vne:layer_sprite_speak:sprite_get` | Запросить данные у обработчиков и продолжить цепочку. |
+| `OPTION_SET` | `vne:layer_sprite_speak:option_set` | Записать или обновить значение. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `MIN_DURATION` | `number` | Значение по умолчанию: 2000. |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.sprite.speak.sources` | Обрабатывает PUSH, POP. |
+| `layer.sprite.speak.duration` | Подмодуль `sprite.speak.duration` плагина. |
+| `layer.sprite.speak.preload` | Подмодуль `sprite.speak.preload` плагина. |
+| `layer.sprite.speak.staff` | Обрабатывает SPRITE_GET, OPTION_SET. |
+| `layer.sprite.speak` | Обрабатывает END, START, SPEAKER. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [vendors.md](../core/vendors.md) — `VENDORS`: emitClone
+
+### Остальные
+
+- [sprite.md](./sprite.md) — `LAYER_SPRITE`: EVENTS.PRELOAD, EVENTS.STATE_GET, EVENTS.CHANGE

package/plugins/canvas/text.md

@@ -0,0 +1,63 @@
+# plugins/canvas/text/
+
+Пакет: `@vnejs/plugins.canvas.text` · namespace: `LAYER_TEXT`
+
+Показ, скрытие, смена и перемещение локализованного текста на слоях.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `SHOW` | `vne:layer_text:show` | Запросить данные у обработчиков и продолжить цепочку. |
+| `HIDE` | `vne:layer_text:hide` | Скрыть UI или слой. |
+| `CHANGE` | `vne:layer_text:change` | Запросить данные у обработчиков и продолжить цепочку. |
+| `MOVE` | `vne:layer_text:move` | Событие `MOVE` namespace плагина. |
+| `STATE_UPDATE` | `vne:layer_text:state_update` | Обновить накопленное состояние модуля. |
+| `STATE_GET` | `vne:layer_text:state_get` | Получить значение или ресурс. |
+| `STATE_ADD` | `vne:layer_text:state_add` | Событие `STATE_ADD` namespace плагина. |
+| `STATE_RM` | `vne:layer_text:state_rm` | Событие `STATE_RM` namespace плагина. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `TEXT_STYLE_KEYS` | `string` | Значение по умолчанию: "TEXT_STYLE_KEYS". |
+| `DEFAULT_TEXT_ARGS` | `string` | Значение по умолчанию: "DEFAULT_TEXT_ARGS". |
+| `TRANSITIONS_SHOW` | `string` | Значение по умолчанию: "TRANSITIONS_SHOW". |
+| `TRANSITIONS_HIDE` | `string` | Значение по умолчанию: "TRANSITIONS_HIDE". |
+| `TRANSITIONS_CHANGE` | `string` | Значение по умолчанию: "TRANSITIONS_CHANGE". |
+| `POSITIONS` | `string` | Значение по умолчанию: "POSITIONS". |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `layer.text.show` | Подмодуль `text.show` плагина. |
+| `layer.text.hide` | Подмодуль `text.hide` плагина. |
+| `layer.text.change` | Подмодуль `text.change` плагина. |
+| `layer.text.move` | Подмодуль `text.move` плагина. |
+| `layer.text.state` | Обрабатывает STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [components.md](../core/components.md) — `COMPONENTS`: EVENTS.EXTERNAL_UPDATE
+- [interact.md](../core/interact.md) — `INTERACT`: EVENTS.PUSH_POP
+- [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`: emitClone
+
+### Остальные
+
+- [layer.md](./layer.md) — `LAYER`: EVENTS.CHILD_GET, EVENTS.CHILD_CHANGE, EVENTS.UPDATE_FORCE, EVENTS.CHILD_RM, EVENTS.CHILD_ADD
+- [locs.md](../text/locs.md) — `LOCS`: EVENTS.LOAD
+- [text.md](../text/text.md) — `TEXT`: EVENTS.REPLACE