@vnejs/docs 0.2.65 → 0.2.67

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (261) hide show
  1. package/README.md +35 -35
  2. package/architecture/backends.md +18 -0
  3. package/architecture/build.md +37 -0
  4. package/architecture/bundles.md +20 -0
  5. package/architecture/cli.md +25 -0
  6. package/architecture/compatibility.md +22 -0
  7. package/architecture/configs.md +19 -0
  8. package/architecture/contracts.md +30 -0
  9. package/architecture/dependencies.md +55 -0
  10. package/architecture/editor.md +7 -0
  11. package/architecture/games.md +38 -0
  12. package/architecture/helpers.md +14 -0
  13. package/architecture/model.md +43 -0
  14. package/architecture/modules.md +87 -0
  15. package/architecture/packages.md +43 -0
  16. package/architecture/plugins.md +36 -0
  17. package/architecture/uis.md +23 -0
  18. package/changelog/0.2.18.md +7 -0
  19. package/changelog/0.2.19.md +14 -0
  20. package/changelog/0.2.20.md +10 -0
  21. package/changelog/0.2.21.md +5 -0
  22. package/changelog/0.2.22.md +11 -0
  23. package/changelog/0.2.23.md +4 -0
  24. package/changelog/0.2.25.md +6 -0
  25. package/changelog/0.2.26.md +12 -0
  26. package/changelog/0.2.29.md +10 -0
  27. package/changelog/0.2.31.md +5 -0
  28. package/changelog/0.2.32.md +3 -0
  29. package/changelog/0.2.33.md +5 -0
  30. package/changelog/0.2.34.md +8 -0
  31. package/changelog/0.2.35.md +33 -0
  32. package/changelog/0.2.36.md +10 -0
  33. package/changelog/0.2.38.md +19 -0
  34. package/changelog/0.2.39.md +16 -0
  35. package/changelog/0.2.40.md +9 -0
  36. package/changelog/0.2.42.md +3 -0
  37. package/changelog/0.2.43.md +10 -0
  38. package/changelog/0.2.46.md +3 -0
  39. package/changelog/0.2.47.md +25 -0
  40. package/changelog/0.2.49.md +3 -0
  41. package/changelog/0.2.50.md +6 -0
  42. package/changelog/0.2.51.md +6 -0
  43. package/changelog/0.2.52.md +5 -0
  44. package/changelog/0.2.53.md +12 -0
  45. package/changelog/0.2.55.md +19 -0
  46. package/changelog/0.2.56.md +11 -0
  47. package/changelog/0.2.57.md +7 -0
  48. package/changelog/0.2.58.md +8 -0
  49. package/changelog/0.2.59.md +6 -0
  50. package/changelog/0.2.60.md +5 -0
  51. package/changelog/0.2.61.md +11 -0
  52. package/changelog/0.2.62.md +8 -0
  53. package/changelog/0.2.63.md +4 -0
  54. package/changelog/0.2.64.md +4 -0
  55. package/changelog/0.2.65.md +3 -0
  56. package/changelog/0.2.66.md +5 -0
  57. package/changelog/README.md +43 -0
  58. package/manifest.json +66 -5
  59. package/package.json +6 -4
  60. package/plugins/ai/ai.md +29 -29
  61. package/plugins/ai/checkers.md +26 -26
  62. package/plugins/audio/ambient.md +20 -20
  63. package/plugins/audio/audio.md +40 -40
  64. package/plugins/audio/music.md +20 -20
  65. package/plugins/audio/sound.md +20 -20
  66. package/plugins/audio/voice.md +23 -23
  67. package/plugins/canvas/bg.md +44 -44
  68. package/plugins/canvas/bg.speak.md +34 -34
  69. package/plugins/canvas/fill.md +33 -33
  70. package/plugins/canvas/layer.md +35 -35
  71. package/plugins/canvas/sprite.md +46 -46
  72. package/plugins/canvas/sprite.speak.md +33 -33
  73. package/plugins/canvas/text.md +37 -37
  74. package/plugins/canvas/video.md +37 -37
  75. package/plugins/canvas.layers/bl.md +33 -33
  76. package/plugins/canvas.layers/fl.md +33 -33
  77. package/plugins/canvas.layers/ml.md +33 -33
  78. package/plugins/canvas.layers/ul.md +32 -32
  79. package/plugins/canvas.props/animation.md +25 -25
  80. package/plugins/canvas.props/clip.md +22 -22
  81. package/plugins/canvas.props/filters.md +20 -20
  82. package/plugins/canvas.props/mask.md +23 -23
  83. package/plugins/canvas.props/scale.md +20 -20
  84. package/plugins/common/grid.md +23 -23
  85. package/plugins/common/turn.md +18 -18
  86. package/plugins/controls/controls.md +31 -31
  87. package/plugins/controls/cursor.md +54 -54
  88. package/plugins/controls/gamepad.md +56 -56
  89. package/plugins/controls/keyboard.md +17 -17
  90. package/plugins/core/components.md +28 -28
  91. package/plugins/core/interact.md +26 -26
  92. package/plugins/core/logs.md +28 -28
  93. package/plugins/core/media.md +38 -38
  94. package/plugins/core/memory.md +28 -28
  95. package/plugins/core/platforms.md +19 -19
  96. package/plugins/core/scenario.md +48 -48
  97. package/plugins/core/settings.md +24 -24
  98. package/plugins/core/stack.md +39 -39
  99. package/plugins/core/state.md +30 -30
  100. package/plugins/core/storage.md +56 -56
  101. package/plugins/core/system.md +37 -37
  102. package/plugins/core/vendors.md +19 -19
  103. package/plugins/entities/entities.md +16 -16
  104. package/plugins/entities/wallet.md +27 -27
  105. package/plugins/font/montserrat.md +16 -16
  106. package/plugins/game/checkers.md +38 -38
  107. package/plugins/platform/android.md +17 -17
  108. package/plugins/platform/electron.md +21 -21
  109. package/plugins/platform/metric.md +23 -23
  110. package/plugins/rpg/damage.md +22 -22
  111. package/plugins/rpg/hit.md +24 -24
  112. package/plugins/rpg/skills.md +26 -26
  113. package/plugins/save/auto.md +26 -26
  114. package/plugins/save/continue.md +23 -23
  115. package/plugins/save/quick.md +24 -24
  116. package/plugins/save/save.md +37 -37
  117. package/plugins/scales/health.md +17 -17
  118. package/plugins/scales/mana.md +17 -17
  119. package/plugins/scales/scales.md +31 -31
  120. package/plugins/scenario/autoread.md +36 -36
  121. package/plugins/scenario/choose.md +74 -65
  122. package/plugins/scenario/fastforward.md +46 -46
  123. package/plugins/scenario/history.md +41 -41
  124. package/plugins/scenario/pause.md +27 -27
  125. package/plugins/scenario/point_and_click.md +51 -51
  126. package/plugins/scenario/qte.md +54 -54
  127. package/plugins/scenario/random.md +17 -17
  128. package/plugins/settings/filter.md +19 -19
  129. package/plugins/settings/potato.md +22 -22
  130. package/plugins/settings/ratio.md +19 -19
  131. package/plugins/settings/textsize.md +19 -19
  132. package/plugins/settings/volume.md +21 -21
  133. package/plugins/text/inject.md +22 -22
  134. package/plugins/text/locs.md +36 -36
  135. package/plugins/text/meet.md +19 -19
  136. package/plugins/text/smooth.md +33 -33
  137. package/plugins/text/text.md +76 -69
  138. package/plugins/text/wall.md +20 -20
  139. package/plugins/time/date.md +22 -22
  140. package/plugins/time/time.md +23 -23
  141. package/plugins/vars/counters.md +28 -28
  142. package/plugins/vars/flags.md +24 -24
  143. package/plugins/vars/vars.md +29 -29
  144. package/plugins/views/achievement.md +44 -44
  145. package/plugins/views/comment.md +31 -31
  146. package/plugins/views/controls.hints.md +34 -34
  147. package/plugins/views/cursor.md +19 -19
  148. package/plugins/views/fps.md +33 -33
  149. package/plugins/views/gamepad.debug.md +32 -32
  150. package/plugins/views/settings.md +39 -39
  151. package/plugins/views/video.md +37 -37
  152. package/plugins/views.scenario/choose.md +41 -41
  153. package/plugins/views.scenario/interface.controls.md +31 -31
  154. package/plugins/views.scenario/interface.fastforward.md +29 -29
  155. package/plugins/views.scenario/interface.md +74 -74
  156. package/plugins/views.scenario/point_and_click.md +39 -39
  157. package/plugins/views.scenario/qte.md +51 -51
  158. package/plugins/views.screens/checkers.md +35 -35
  159. package/plugins/views.screens/confirm.md +35 -35
  160. package/plugins/views.screens/credits.md +31 -31
  161. package/plugins/views.screens/disclaimer.md +42 -42
  162. package/plugins/views.screens/eula.md +37 -37
  163. package/plugins/views.screens/gallery.full.md +41 -41
  164. package/plugins/views.screens/gallery.md +75 -75
  165. package/plugins/views.screens/gamemenu.md +41 -41
  166. package/plugins/views.screens/history.md +39 -39
  167. package/plugins/views.screens/intro.md +32 -32
  168. package/plugins/views.screens/loading.md +30 -30
  169. package/plugins/views.screens/mainmenu.md +49 -49
  170. package/plugins/views.screens/mainmenu.socials.md +25 -25
  171. package/plugins/views.screens/save.md +66 -66
  172. package/plugins/views.screens/settings.defaults.md +37 -37
  173. package/plugins/views.screens/settings.md +40 -40
  174. package/scenario.catalog/README.md +13 -13
  175. package/scenario.catalog/index.md +35 -35
  176. package/scenario.catalog/stubs/achievement.md +4 -4
  177. package/scenario.catalog/stubs/audio.ambient.md +4 -4
  178. package/scenario.catalog/stubs/audio.music.md +4 -4
  179. package/scenario.catalog/stubs/audio.sound.md +4 -4
  180. package/scenario.catalog/stubs/audio.voice.md +4 -4
  181. package/scenario.catalog/stubs/bl.animation.md +5 -5
  182. package/scenario.catalog/stubs/bl.bg.md +5 -5
  183. package/scenario.catalog/stubs/bl.clip.md +5 -5
  184. package/scenario.catalog/stubs/bl.fill.md +5 -5
  185. package/scenario.catalog/stubs/bl.filter.md +5 -5
  186. package/scenario.catalog/stubs/bl.mask.md +5 -5
  187. package/scenario.catalog/stubs/bl.scale.md +5 -5
  188. package/scenario.catalog/stubs/bl.sprite.md +5 -5
  189. package/scenario.catalog/stubs/bl.text.md +5 -5
  190. package/scenario.catalog/stubs/bl.video.md +5 -5
  191. package/scenario.catalog/stubs/choose.block.md +7 -7
  192. package/scenario.catalog/stubs/choose.md +4 -4
  193. package/scenario.catalog/stubs/choose.option.md +7 -7
  194. package/scenario.catalog/stubs/comment.md +5 -5
  195. package/scenario.catalog/stubs/counter.md +5 -5
  196. package/scenario.catalog/stubs/credits.md +4 -4
  197. package/scenario.catalog/stubs/date.md +4 -4
  198. package/scenario.catalog/stubs/disclaimer.md +5 -5
  199. package/scenario.catalog/stubs/fl.animation.md +5 -5
  200. package/scenario.catalog/stubs/fl.bg.md +5 -5
  201. package/scenario.catalog/stubs/fl.clip.md +5 -5
  202. package/scenario.catalog/stubs/fl.fill.md +5 -5
  203. package/scenario.catalog/stubs/fl.filter.md +5 -5
  204. package/scenario.catalog/stubs/fl.mask.md +5 -5
  205. package/scenario.catalog/stubs/fl.scale.md +5 -5
  206. package/scenario.catalog/stubs/fl.sprite.md +5 -5
  207. package/scenario.catalog/stubs/fl.text.md +5 -5
  208. package/scenario.catalog/stubs/fl.video.md +5 -5
  209. package/scenario.catalog/stubs/flag.md +13 -13
  210. package/scenario.catalog/stubs/interface.md +4 -4
  211. package/scenario.catalog/stubs/intro.md +4 -4
  212. package/scenario.catalog/stubs/mainmenu.md +4 -4
  213. package/scenario.catalog/stubs/ml.animation.md +5 -5
  214. package/scenario.catalog/stubs/ml.bg.md +5 -5
  215. package/scenario.catalog/stubs/ml.clip.md +5 -5
  216. package/scenario.catalog/stubs/ml.fill.md +5 -5
  217. package/scenario.catalog/stubs/ml.filter.md +5 -5
  218. package/scenario.catalog/stubs/ml.mask.md +5 -5
  219. package/scenario.catalog/stubs/ml.scale.md +5 -5
  220. package/scenario.catalog/stubs/ml.sprite.md +5 -5
  221. package/scenario.catalog/stubs/ml.text.md +5 -5
  222. package/scenario.catalog/stubs/ml.video.md +5 -5
  223. package/scenario.catalog/stubs/other.md +6 -6
  224. package/scenario.catalog/stubs/pause.md +5 -5
  225. package/scenario.catalog/stubs/point-and-click.block.md +4 -4
  226. package/scenario.catalog/stubs/point-and-click.md +4 -4
  227. package/scenario.catalog/stubs/point-and-click.option.md +4 -4
  228. package/scenario.catalog/stubs/qte.md +4 -4
  229. package/scenario.catalog/stubs/random.md +4 -4
  230. package/scenario.catalog/stubs/random.option.md +4 -4
  231. package/scenario.catalog/stubs/save.auto.md +4 -4
  232. package/scenario.catalog/stubs/save.md +5 -5
  233. package/scenario.catalog/stubs/scenario.md +4 -4
  234. package/scenario.catalog/stubs/settings.defaults.md +4 -4
  235. package/scenario.catalog/stubs/stack.md +4 -4
  236. package/scenario.catalog/stubs/text.meet.md +4 -4
  237. package/scenario.catalog/stubs/text.wall.md +4 -4
  238. package/scenario.catalog/stubs/time.md +4 -4
  239. package/scenario.catalog/stubs/ul.animation.md +5 -5
  240. package/scenario.catalog/stubs/ul.bg.md +5 -5
  241. package/scenario.catalog/stubs/ul.clip.md +5 -5
  242. package/scenario.catalog/stubs/ul.fill.md +5 -5
  243. package/scenario.catalog/stubs/ul.filter.md +5 -5
  244. package/scenario.catalog/stubs/ul.mask.md +5 -5
  245. package/scenario.catalog/stubs/ul.scale.md +5 -5
  246. package/scenario.catalog/stubs/ul.sprite.md +5 -5
  247. package/scenario.catalog/stubs/ul.text.md +5 -5
  248. package/scenario.catalog/stubs/video.md +4 -4
  249. package/scenario.catalog/stubs/wallet.md +4 -4
  250. package/scenario.guide/README.md +38 -38
  251. package/scenario.guide/audio.md +11 -11
  252. package/scenario.guide/canvas.md +23 -23
  253. package/scenario.guide/choose.md +28 -28
  254. package/scenario.guide/dialogue.md +23 -23
  255. package/scenario.guide/flow.md +21 -21
  256. package/scenario.guide/point-and-click.md +12 -12
  257. package/scenario.guide/qte-random.md +20 -20
  258. package/scenario.guide/vars.md +19 -19
  259. package/scenario.guide/views.md +20 -20
  260. package/CHANGELOG.md +0 -387
  261. package/architecture.md +0 -566
@@ -1,39 +1,39 @@
1
1
  # plugins/audio/sound/
2
2
 
3
- Пакет: `@vnejs/plugins.audio.sound` · namespace: `SOUND`
3
+ Package: `@vnejs/plugins.audio.sound` · namespace: `SOUND`
4
4
 
5
- Воспроизведение звуковых эффектов из сценария с отдельной громкостью.
5
+ Play sound effects from scenario with a separate volume.
6
6
 
7
- ## События
7
+ ## Events
8
8
 
9
- Нет.
9
+ None.
10
10
 
11
- ## Константы
11
+ ## Constants
12
12
 
13
- Нет.
13
+ None.
14
14
 
15
- ## Параметры
15
+ ## Parameters
16
16
 
17
- Нет.
17
+ None.
18
18
 
19
- ## Настройки
19
+ ## Settings
20
20
 
21
- | Ключ | Тип | Смысл |
22
- | ----------------------------- | -------- | ------------------ |
23
- | `VOLUME` (`vne:sound:volume`) | `number` | Уровень громкости. |
21
+ | Key | Type | Meaning |
22
+ | ----------------------------- | -------- | ------------- |
23
+ | `VOLUME` (`vne:sound:volume`) | `number` | Volume level. |
24
24
 
25
- ## Модули
25
+ ## Modules
26
26
 
27
- | Модуль | Зона ответственности |
28
- | ------- | -------------------- |
29
- | `sound` | Модуль `sound`. |
27
+ | Module | Role |
28
+ | ------- | --------------- |
29
+ | `sound` | `sound` module. |
30
30
 
31
- ## Близкие плагины
31
+ ## Related plugins
32
32
 
33
33
  ### plugins/core/
34
34
 
35
- — нет
35
+ — None
36
36
 
37
- ### Остальные
37
+ ### Other
38
38
 
39
- — нет
39
+ — None
@@ -1,43 +1,43 @@
1
1
  # plugins/audio/voice/
2
2
 
3
- Пакет: `@vnejs/plugins.audio.voice` · namespace: `VOICE`
3
+ Package: `@vnejs/plugins.audio.voice` · namespace: `VOICE`
4
4
 
5
- Озвучка реплик без loop, сброс при interact и настройка языка voice.
5
+ Line voice-over without loop, reset on interact, and voice language setting.
6
6
 
7
- ## События
7
+ ## Events
8
8
 
9
- Нет.
9
+ None.
10
10
 
11
- ## Константы
11
+ ## Constants
12
12
 
13
- Нет.
13
+ None.
14
14
 
15
- ## Параметры
15
+ ## Parameters
16
16
 
17
- | Ключ | Тип | Смысл |
18
- | -------------- | -------- | ---------------------------- |
19
- | `DEFAULT_LANG` | `string` | Значение по умолчанию: "ru". |
17
+ | Key | Type | Meaning |
18
+ | -------------- | -------- | ---------------- |
19
+ | `DEFAULT_LANG` | `string` | Default: `"ru"`. |
20
20
 
21
- ## Настройки
21
+ ## Settings
22
22
 
23
- | Ключ | Тип | Смысл |
24
- | ----------------------------- | -------- | ----------------------------------------------- |
25
- | `VOLUME` (`vne:voice:volume`) | `number` | Уровень громкости. |
26
- | `LANG` (`vne:voice:lang`) | `string` | Настройка `vne:voice:lang` в `shared.settings`. |
23
+ | Key | Type | Meaning |
24
+ | ----------------------------- | -------- | ---------------------------------------------- |
25
+ | `VOLUME` (`vne:voice:volume`) | `number` | Volume level. |
26
+ | `LANG` (`vne:voice:lang`) | `string` | Setting `vne:voice:lang` in `shared.settings`. |
27
27
 
28
- ## Модули
28
+ ## Modules
29
29
 
30
- | Модуль | Зона ответственности |
31
- | ------------ | ---------------------------------------------------------------------------------------------------- |
32
- | `voice` | Модуль `voice`. |
33
- | `voice.lang` | В `postinject` — `shared.voiceDisableSources`; `SETTINGS.INIT` LANG в `setup`; `voiceLang` в `init`. |
30
+ | Module | Role |
31
+ | ------------ | ------------------------------------------------------------------------------------------------------- |
32
+ | `voice` | `voice` module. |
33
+ | `voice.lang` | In `postinject` — `shared.voiceDisableSources`; `SETTINGS.INIT` LANG in `setup`; `voiceLang` in `init`. |
34
34
 
35
- ## Близкие плагины
35
+ ## Related plugins
36
36
 
37
37
  ### plugins/core/
38
38
 
39
39
  - [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT
40
40
 
41
- ### Остальные
41
+ ### Other
42
42
 
43
- — нет
43
+ — None
@@ -1,18 +1,18 @@
1
1
  # plugins/canvas/bg/
2
2
 
3
- Пакет: `@vnejs/plugins.canvas.child.bg` · namespace: `LAYER_BG`
3
+ Package: `@vnejs/plugins.canvas.child.bg` · namespace: `LAYER_BG`
4
4
 
5
- Показ, скрытие, смена и preload изображений на canvas-слоях.
5
+ Show, hide, change, and preload images on canvas layers.
6
6
 
7
7
  ## SHOW vs CHANGE
8
8
 
9
- - **`SHOW`** — новый child (часто fade через `opacity`), старые при необходимости снимаются.
10
- - **`CHANGE`** — смена `src` у уже существующего child. При `duration > 0`: `transition` → `waitRerender` → смена `src` (как `sprite.move`), без opacity-кроссфейда `SHOW`.
11
- - Bg-`Image` всегда с `isSwitchDisabled` — overlay-массив `src` не крутится как slideshow-кадры.
9
+ - **`SHOW`** — new child (often fade via `opacity`); remove old ones when needed.
10
+ - **`CHANGE`** — change `src` on an existing child. When `duration > 0`: `transition` → `waitRerender` → change `src` (like `sprite.move`), without the opacity crossfade of `SHOW`.
11
+ - Bg `Image` always has `isSwitchDisabled` — the overlay `src` array does not rotate like slideshow frames.
12
12
 
13
13
  ## Overlays
14
14
 
15
- В args сценария / событий поле `overlays?: Record<string, string>` задаёт слои поверх базового `{name}/index`: каждый ключ `key → value` резолвится в медиа `{name}/{key}/{value}`.
15
+ In scenario or event args, `overlays?: Record<string, string>` defines layers on top of base `{name}/index`: each key `key → value` resolves to media `{name}/{key}/{value}`.
16
16
 
17
17
  ```vne
18
18
  $ bl.bg show {castle/surgery_room} opacity 500
@@ -21,55 +21,55 @@ $ bl.bg show {castle/surgery_room} opacity 500
21
21
  man: 1
22
22
  ```
23
23
 
24
- - `PRELOAD` / `SRC_GET` / show / change читают `overlays` из payload или `args`.
25
- - `ARGS_INJECT` (например [bg.speak.md](./bg.speak.md)) может дописать `overlays` в args перед резолвом src.
26
- - На слое child рисуется через `src` (массив URL: index + overlays), не через React-prop `overlays`.
24
+ - `PRELOAD` / `SRC_GET` / show / change read `overlays` from payload or `args`.
25
+ - `ARGS_INJECT` (for example [bg.speak.md](./bg.speak.md)) can append `overlays` to args before src resolve.
26
+ - On the layer, the child draws via `src` (URL array: index + overlays), not via the React `overlays` prop.
27
27
 
28
- ## События
28
+ ## Events
29
29
 
30
- Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.canvas.child.bg`.
30
+ Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.bg`.
31
31
 
32
- | Ключ | Строка | Смысл |
33
- | --------------- | ---------------------------- | ----------------------------------------------------- |
34
- | `SHOW` | `vne:layer_bg:show` | Запросить данные у обработчиков и продолжить цепочку. |
35
- | `HIDE` | `vne:layer_bg:hide` | Запросить данные у обработчиков и продолжить цепочку. |
36
- | `CHANGE` | `vne:layer_bg:change` | Запросить данные у обработчиков и продолжить цепочку. |
37
- | `PRELOAD` | `vne:layer_bg:preload` | Событие `PRELOAD` namespace плагина. |
38
- | `SRC_GET` | `vne:layer_bg:src_get` | Получить значение или ресурс. |
39
- | `ARGS_INJECT` | `vne:layer_bg:args_inject` | Событие `ARGS_INJECT` namespace плагина. |
40
- | `STATE_RM` | `vne:layer_bg:state_rm` | Событие `STATE_RM` namespace плагина. |
41
- | `STATE_GET` | `vne:layer_bg:state_get` | Получить значение или ресурс. |
42
- | `STATE_GET_ALL` | `vne:layer_bg:state_get_all` | Событие `STATE_GET_ALL` namespace плагина. |
43
- | `STATE_ADD` | `vne:layer_bg:state_add` | Событие `STATE_ADD` namespace плагина. |
44
- | `STATE_UPDATE` | `vne:layer_bg:state_update` | Обновить накопленное состояние модуля. |
32
+ | Key | String | Meaning |
33
+ | --------------- | ---------------------------- | --------------------------------------------- |
34
+ | `SHOW` | `vne:layer_bg:show` | Ask handlers for data and continue the chain. |
35
+ | `HIDE` | `vne:layer_bg:hide` | Ask handlers for data and continue the chain. |
36
+ | `CHANGE` | `vne:layer_bg:change` | Ask handlers for data and continue the chain. |
37
+ | `PRELOAD` | `vne:layer_bg:preload` | Plugin namespace `PRELOAD` event. |
38
+ | `SRC_GET` | `vne:layer_bg:src_get` | Get a value or resource. |
39
+ | `ARGS_INJECT` | `vne:layer_bg:args_inject` | Plugin namespace `ARGS_INJECT` event. |
40
+ | `STATE_RM` | `vne:layer_bg:state_rm` | Plugin namespace `STATE_RM` event. |
41
+ | `STATE_GET` | `vne:layer_bg:state_get` | Get a value or resource. |
42
+ | `STATE_GET_ALL` | `vne:layer_bg:state_get_all` | Plugin namespace `STATE_GET_ALL` event. |
43
+ | `STATE_ADD` | `vne:layer_bg:state_add` | Plugin namespace `STATE_ADD` event. |
44
+ | `STATE_UPDATE` | `vne:layer_bg:state_update` | Update accumulated module state. |
45
45
 
46
- ## Константы
46
+ ## Constants
47
47
 
48
- Нет.
48
+ None.
49
49
 
50
- ## Параметры
50
+ ## Parameters
51
51
 
52
- | Ключ | Тип | Смысл |
53
- | ------------------ | -------- | ------------------------------------------ |
54
- | `TRANSITIONS_SHOW` | `string` | Значение по умолчанию: "TRANSITIONS_SHOW". |
55
- | `TRANSITIONS_HIDE` | `string` | Значение по умолчанию: "TRANSITIONS_HIDE". |
52
+ | Key | Type | Meaning |
53
+ | ------------------ | -------- | ---------------------------- |
54
+ | `TRANSITIONS_SHOW` | `string` | Default: "TRANSITIONS_SHOW". |
55
+ | `TRANSITIONS_HIDE` | `string` | Default: "TRANSITIONS_HIDE". |
56
56
 
57
- ## Настройки
57
+ ## Settings
58
58
 
59
- Нет.
59
+ None.
60
60
 
61
- ## Модули
61
+ ## Modules
62
62
 
63
- | Модуль | Зона ответственности |
64
- | ------------------ | ------------------------------------------------------------------ |
65
- | `layer.bg.show` | Подмодуль `image.show` плагина. |
66
- | `layer.bg.hide` | Подмодуль `image.hide` плагина. |
67
- | `layer.bg.staff` | Подмодуль `image.staff` плагина. |
68
- | `layer.bg.state` | Обрабатывает STATE_UPDATE, STATE_GET, STATE_GET_ALL, STATE_ADD, …. |
69
- | `layer.bg.change` | Подмодуль `image.change` плагина. |
70
- | `layer.bg.preload` | Подмодуль `image.preload` плагина. |
63
+ | Module | Role |
64
+ | ------------------ | ------------------------------------------------------------- |
65
+ | `layer.bg.show` | Plugin `image.show` submodule. |
66
+ | `layer.bg.hide` | Plugin `image.hide` submodule. |
67
+ | `layer.bg.staff` | Plugin `image.staff` submodule. |
68
+ | `layer.bg.state` | Handles STATE_UPDATE, STATE_GET, STATE_GET_ALL, STATE_ADD, …. |
69
+ | `layer.bg.change` | Plugin `image.change` submodule. |
70
+ | `layer.bg.preload` | Plugin `image.preload` submodule. |
71
71
 
72
- ## Близкие плагины
72
+ ## Related plugins
73
73
 
74
74
  ### plugins/core/
75
75
 
@@ -78,6 +78,6 @@ Payloads и результаты хендлеров типизированы ч
78
78
  - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
79
79
  - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.PRELOAD
80
80
 
81
- ### Остальные
81
+ ### Other
82
82
 
83
83
  - [layer.md](./layer.md) — `LAYER`: EVENTS.UPDATE_FORCE, EVENTS.CHILD_CHANGE, EVENTS.CHILDS_RM, SETTINGS.QUALITY, EVENTS.CHILD_ADD
@@ -1,56 +1,56 @@
1
1
  # plugins/canvas/bg.speak/
2
2
 
3
- Пакет: `@vnejs/plugins.canvas.bg.speak` · namespace: `LAYER_BG_SPEAK`
3
+ Package: `@vnejs/plugins.canvas.bg.speak` · namespace: `LAYER_BG_SPEAK`
4
4
 
5
- Переключение вариантов image по текущему спикеру реплики.
5
+ Switch image variants by the current line speaker.
6
6
 
7
- На `LAYER_BG.ARGS_INJECT` возвращает `{ overlays: args.speak[speaker] }` — мержится в [bg.md](./bg.md) args. При `PRELOAD` с `overlays` и `speak` дополнительно прелоадит варианты с overrides спикеров.
7
+ On `LAYER_BG.ARGS_INJECT` it returns `{ overlays: args.speak[speaker] }` — merged into [bg.md](./bg.md) args. On `PRELOAD` with `overlays` and `speak`, also preloads variants with speaker overrides.
8
8
 
9
- ## События
9
+ ## Events
10
10
 
11
- Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.canvas.child.bg.speak`.
11
+ Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.bg.speak`.
12
12
 
13
- | Ключ | Строка | Смысл |
14
- | ---------------- | ----------------------------------- | ----------------------------------------------------- |
15
- | `PUSH` | `vne:layer_bg_speak:push` | Добавить элемент в очередь или стек. |
16
- | `POP` | `vne:layer_bg_speak:pop` | Извлечь элемент из очереди или стека. |
17
- | `SPEAKER` | `vne:layer_bg_speak:speaker` | Запросить данные у обработчиков и продолжить цепочку. |
18
- | `START` | `vne:layer_bg_speak:start` | Начать процесс. |
19
- | `END` | `vne:layer_bg_speak:end` | Запросить данные у обработчиков и продолжить цепочку. |
20
- | `BGS_GET` | `vne:layer_bg_speak:bgs_get` | Получить значение или ресурс. |
21
- | `BGS_GET_ACTIVE` | `vne:layer_bg_speak:bgs_get_active` | Событие `BGS_GET_ACTIVE` namespace плагина. |
22
- | `OPTION_SET` | `vne:layer_bg_speak:option_set` | Записать или обновить значение. |
13
+ | Key | String | Meaning |
14
+ | ---------------- | ----------------------------------- | --------------------------------------------- |
15
+ | `PUSH` | `vne:layer_bg_speak:push` | Add an item to a queue or stack. |
16
+ | `POP` | `vne:layer_bg_speak:pop` | Remove an item from a queue or stack. |
17
+ | `SPEAKER` | `vne:layer_bg_speak:speaker` | Ask handlers for data and continue the chain. |
18
+ | `START` | `vne:layer_bg_speak:start` | Start a process. |
19
+ | `END` | `vne:layer_bg_speak:end` | Ask handlers for data and continue the chain. |
20
+ | `BGS_GET` | `vne:layer_bg_speak:bgs_get` | Get a value or resource. |
21
+ | `BGS_GET_ACTIVE` | `vne:layer_bg_speak:bgs_get_active` | Plugin namespace `BGS_GET_ACTIVE` event. |
22
+ | `OPTION_SET` | `vne:layer_bg_speak:option_set` | Write or update a value. |
23
23
 
24
- ## Константы
24
+ ## Constants
25
25
 
26
- Нет.
26
+ None.
27
27
 
28
- ## Параметры
28
+ ## Parameters
29
29
 
30
- | Ключ | Тип | Смысл |
31
- | -------------- | -------- | ---------------------------- |
32
- | `MIN_DURATION` | `number` | Значение по умолчанию: 2000. |
30
+ | Key | Type | Meaning |
31
+ | -------------- | -------- | -------------- |
32
+ | `MIN_DURATION` | `number` | Default: 2000. |
33
33
 
34
- ## Настройки
34
+ ## Settings
35
35
 
36
- Нет.
36
+ None.
37
37
 
38
- ## Модули
38
+ ## Modules
39
39
 
40
- | Модуль | Зона ответственности |
41
- | ------------------------- | -------------------------------------------------------------- |
42
- | `layer.bg.speak.sources` | В `postinject` — `shared.layerBgSpeakSources`; PUSH, POP. |
43
- | `layer.bg.speak.duration` | Подмодуль `image.speak.duration` плагина. |
44
- | `layer.bg.speak.preload` | Подмодуль `image.speak.preload` плагина. |
45
- | `layer.bg.speak.staff` | Обрабатывает ARGS_INJECT, BGS_GET, BGS_GET_ACTIVE, OPTION_SET. |
46
- | `layer.bg.speak` | Обрабатывает END, START, SPEAKER. |
40
+ | Module | Role |
41
+ | ------------------------- | ---------------------------------------------------------- |
42
+ | `layer.bg.speak.sources` | In `postinject` — `shared.layerBgSpeakSources`; PUSH, POP. |
43
+ | `layer.bg.speak.duration` | Plugin `image.speak.duration` submodule. |
44
+ | `layer.bg.speak.preload` | Plugin `image.speak.preload` submodule. |
45
+ | `layer.bg.speak.staff` | Handles ARGS_INJECT, BGS_GET, BGS_GET_ACTIVE, OPTION_SET. |
46
+ | `layer.bg.speak` | Handles END, START, SPEAKER. |
47
47
 
48
- ## Близкие плагины
48
+ ## Related plugins
49
49
 
50
50
  ### plugins/core/
51
51
 
52
- — нет
52
+ — None
53
53
 
54
- ### Остальные
54
+ ### Other
55
55
 
56
56
  - [image.md](./image.md) — `LAYER_BG`: EVENTS.PRELOAD, EVENTS.ARGS_INJECT, EVENTS.CHANGE, EVENTS.STATE_GET_ALL
@@ -1,10 +1,10 @@
1
1
  # plugins/canvas/fill/
2
2
 
3
- Пакет: `@vnejs/plugins.canvas.child.fill` · namespace: `LAYER_FILL`
3
+ Package: `@vnejs/plugins.canvas.child.fill` · namespace: `LAYER_FILL`
4
4
 
5
- Показ, смена и скрытие цветовой заливки на весь canvas-слой.
5
+ Show, change, and hide a full-layer color fill on a canvas layer.
6
6
 
7
- ## Синтаксис сценария
7
+ ## Scenario syntax
8
8
 
9
9
  ```
10
10
  $ bl.fill show fillId1 {rgba(255, 255, 255, 0.5)} 300
@@ -12,57 +12,57 @@ $ bl.fill change fillId1 {rgba(0, 0, 0, 0.5)} 300
12
12
  $ bl.fill hide fillId1 300
13
13
  ```
14
14
 
15
- Переход show/hide — всегда `opacity`. На слоях `bl` / `ml` / `fl` / `ul`: `$ {layer}.fill …`.
15
+ Show/hide transition is always `opacity`. On layers `bl` / `ml` / `fl` / `ul`: `$ {layer}.fill …`.
16
16
 
17
- ## События
17
+ ## Events
18
18
 
19
- Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.canvas.child.fill`.
19
+ Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.fill`.
20
20
 
21
- | Ключ | Строка | Смысл |
22
- | -------------- | ----------------------------- | -------------------------------------- |
23
- | `SHOW` | `vne:layer_fill:show` | Показать заливку по `id` и цвету. |
24
- | `CHANGE` | `vne:layer_fill:change` | Сменить цвет существующей заливки. |
25
- | `HIDE` | `vne:layer_fill:hide` | Скрыть заливку по `id`. |
26
- | `STATE_UPDATE` | `vne:layer_fill:state_update` | Обновить накопленное состояние модуля. |
27
- | `STATE_GET` | `vne:layer_fill:state_get` | Получить запись заливки по `id`. |
28
- | `STATE_ADD` | `vne:layer_fill:state_add` | Добавить запись в state. |
29
- | `STATE_RM` | `vne:layer_fill:state_rm` | Удалить запись из state. |
21
+ | Key | String | Meaning |
22
+ | -------------- | ----------------------------- | --------------------------------- |
23
+ | `SHOW` | `vne:layer_fill:show` | Show fill by `id` and color. |
24
+ | `CHANGE` | `vne:layer_fill:change` | Change color of an existing fill. |
25
+ | `HIDE` | `vne:layer_fill:hide` | Hide fill by `id`. |
26
+ | `STATE_UPDATE` | `vne:layer_fill:state_update` | Update accumulated module state. |
27
+ | `STATE_GET` | `vne:layer_fill:state_get` | Get fill record by `id`. |
28
+ | `STATE_ADD` | `vne:layer_fill:state_add` | Add a record to state. |
29
+ | `STATE_RM` | `vne:layer_fill:state_rm` | Remove a record from state. |
30
30
 
31
- ## Константы
31
+ ## Constants
32
32
 
33
- | Ключ | Смысл |
33
+ | Key | Meaning |
34
34
  | ------------------ | -------------------------- |
35
35
  | `ACTIONS` | `show` / `change` / `hide` |
36
36
  | `LAYER_CHILD_TYPE` | `"fill"` |
37
37
 
38
- ## Параметры
38
+ ## Parameters
39
39
 
40
- | Ключ | Смысл |
40
+ | Key | Meaning |
41
41
  | -------------------- | -------------------------- |
42
- | `TRANSITIONS_SHOW` | Opacity fade-in для show. |
43
- | `TRANSITIONS_HIDE` | Opacity fade-out для hide. |
44
- | `TRANSITIONS_CHANGE` | Transition для change. |
42
+ | `TRANSITIONS_SHOW` | Opacity fade-in for show. |
43
+ | `TRANSITIONS_HIDE` | Opacity fade-out for hide. |
44
+ | `TRANSITIONS_CHANGE` | Transition for change. |
45
45
 
46
- ## Настройки
46
+ ## Settings
47
47
 
48
- Нет.
48
+ None.
49
49
 
50
- ## Модули
50
+ ## Modules
51
51
 
52
- | Модуль | Зона ответственности |
53
- | ------------------- | ---------------------------------------------------------- |
54
- | `layer.fill.show` | Показ заливки на слое. |
55
- | `layer.fill.change` | Смена цвета заливки. |
56
- | `layer.fill.hide` | Скрытие заливки. |
57
- | `layer.fill.state` | STATE_*, восстановление через `STATE.SET` / `STATE.CLEAR`. |
52
+ | Module | Role |
53
+ | ------------------- | ------------------------------------------------- |
54
+ | `layer.fill.show` | Show fill on the layer. |
55
+ | `layer.fill.change` | Change fill color. |
56
+ | `layer.fill.hide` | Hide fill. |
57
+ | `layer.fill.state` | STATE_*; restore via `STATE.SET` / `STATE.CLEAR`. |
58
58
 
59
- ## Близкие плагины
59
+ ## Related plugins
60
60
 
61
61
  ### plugins/core/
62
62
 
63
63
  - [interact.md](../core/interact.md) — `INTERACT`: EVENTS.PUSH_POP, EVENTS.PUSH, EVENTS.POP
64
64
  - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
65
65
 
66
- ### Остальные
66
+ ### Other
67
67
 
68
68
  - [layer.md](./layer.md) — `LAYER`: EVENTS.CHILD_ADD, EVENTS.CHILD_CHANGE, EVENTS.CHILD_RM, EVENTS.UPDATE_FORCE
@@ -1,51 +1,51 @@
1
1
  # plugins/canvas/layer/
2
2
 
3
- Пакет: `@vnejs/plugins.canvas.layer` · namespace: `LAYER`
3
+ Package: `@vnejs/plugins.canvas.layer` · namespace: `LAYER`
4
4
 
5
- Качество canvas и размеры через CSS-переменные. Viewport meta и `overflow: hidden` на `html`/`body` задаёт `entry/index.html` игры, не этот плагин. У `html` и `body` должна быть `height: 100%`, у `body` — flex-центрирование: иначе 16:9-бокс `#app` от `ratio` прилипает к верху окна.
5
+ Canvas quality and size via CSS variables. Viewport meta and `overflow: hidden` on `html`/`body` come from the game `entry/index.html`, not this plugin. `html` and `body` need `height: 100%`; `body` needs flex centering. Otherwise the 16:9 `#app` box from `ratio` sticks to the top of the window.
6
6
 
7
- ## События
7
+ ## Events
8
8
 
9
- Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.canvas.layer`.
9
+ Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.layer`.
10
10
 
11
- | Ключ | Строка | Смысл |
12
- | --------------- | ------------------------- | ------------------------------------------ |
13
- | `UPDATE_FORCE` | `vne:layer:update_force` | Обновить состояние или отображение. |
14
- | `UPDATE_FAST` | `vne:layer:update_fast` | Обновить состояние или отображение. |
15
- | `CHILD_RM` | `vne:layer:child_rm` | Событие `CHILD_RM` namespace плагина. |
16
- | `CHILDS_RM` | `vne:layer:childs_rm` | Событие `CHILDS_RM` namespace плагина. |
17
- | `CHILD_ADD` | `vne:layer:child_add` | Событие `CHILD_ADD` namespace плагина. |
18
- | `CHILD_CHANGE` | `vne:layer:child_change` | Событие `CHILD_CHANGE` namespace плагина. |
19
- | `CHILDS_CHANGE` | `vne:layer:childs_change` | Событие `CHILDS_CHANGE` namespace плагина. |
20
- | `CHILD_GET` | `vne:layer:child_get` | Получить значение или ресурс. |
21
- | `PROPS_UPDATE` | `vne:layer:props_update` | Обновить состояние или отображение. |
22
- | `STATE_GET` | `vne:layer:state_get` | Получить значение или ресурс. |
11
+ | Key | String | Meaning |
12
+ | --------------- | ------------------------- | --------------------------------------- |
13
+ | `UPDATE_FORCE` | `vne:layer:update_force` | Update state or display. |
14
+ | `UPDATE_FAST` | `vne:layer:update_fast` | Update state or display. |
15
+ | `CHILD_RM` | `vne:layer:child_rm` | Plugin namespace `CHILD_RM` event. |
16
+ | `CHILDS_RM` | `vne:layer:childs_rm` | Plugin namespace `CHILDS_RM` event. |
17
+ | `CHILD_ADD` | `vne:layer:child_add` | Plugin namespace `CHILD_ADD` event. |
18
+ | `CHILD_CHANGE` | `vne:layer:child_change` | Plugin namespace `CHILD_CHANGE` event. |
19
+ | `CHILDS_CHANGE` | `vne:layer:childs_change` | Plugin namespace `CHILDS_CHANGE` event. |
20
+ | `CHILD_GET` | `vne:layer:child_get` | Get a value or resource. |
21
+ | `PROPS_UPDATE` | `vne:layer:props_update` | Update state or display. |
22
+ | `STATE_GET` | `vne:layer:state_get` | Get a value or resource. |
23
23
 
24
- ## Константы
24
+ ## Constants
25
25
 
26
- Нет.
26
+ None.
27
27
 
28
- ## Параметры
28
+ ## Parameters
29
29
 
30
- | Ключ | Тип | Смысл |
31
- | ----------------- | -------- | ----------------------------------------- |
32
- | `DEFAULT_QUALITY` | `string` | Значение по умолчанию: "DEFAULT_QUALITY". |
30
+ | Key | Type | Meaning |
31
+ | ----------------- | -------- | --------------------------- |
32
+ | `DEFAULT_QUALITY` | `string` | Default: "DEFAULT_QUALITY". |
33
33
 
34
- ## Настройки
34
+ ## Settings
35
35
 
36
- | Ключ | Тип | Смысл |
37
- | -------------------------------- | -------- | --------------------------------------------------- |
38
- | `WIDTH` (`vne:canvas:width`) | `number` | Настройка `vne:canvas:width` в `shared.settings`. |
39
- | `HEIGHT` (`vne:canvas:height`) | `number` | Настройка `vne:canvas:height` в `shared.settings`. |
40
- | `QUALITY` (`vne:canvas:quality`) | `number` | Настройка `vne:canvas:quality` в `shared.settings`. |
36
+ | Key | Type | Meaning |
37
+ | -------------------------------- | -------- | -------------------------------------------------- |
38
+ | `WIDTH` (`vne:canvas:width`) | `number` | `vne:canvas:width` setting in `shared.settings`. |
39
+ | `HEIGHT` (`vne:canvas:height`) | `number` | `vne:canvas:height` setting in `shared.settings`. |
40
+ | `QUALITY` (`vne:canvas:quality`) | `number` | `vne:canvas:quality` setting in `shared.settings`. |
41
41
 
42
- ## Модули
42
+ ## Modules
43
43
 
44
- | Модуль | Зона ответственности |
45
- | --------------- | --------------------------------------------------------------------------------- |
46
- | `layer.quality` | Качество → CSS-размеры и `SETTINGS.LAYER.WIDTH` / `HEIGHT`, затем `MEMORY.CLEAR`. |
44
+ | Module | Role |
45
+ | --------------- | ------------------------------------------------------------------------------- |
46
+ | `layer.quality` | Quality → CSS sizes and `SETTINGS.LAYER.WIDTH` / `HEIGHT`, then `MEMORY.CLEAR`. |
47
47
 
48
- ## Близкие плагины
48
+ ## Related plugins
49
49
 
50
50
  ### plugins/core/
51
51
 
@@ -53,6 +53,6 @@ Payloads и результаты хендлеров типизированы ч
53
53
  - [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT, EVENTS.SET
54
54
  - [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
55
55
 
56
- ### Остальные
56
+ ### Other
57
57
 
58
- — нет
58
+ — None