@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,15 +1,15 @@
1
1
  # plugins/canvas/sprite/
2
2
 
3
- Пакет: `@vnejs/plugins.canvas.sprite` · namespace: `LAYER_SPRITE`
3
+ Package: `@vnejs/plugins.canvas.sprite` · namespace: `LAYER_SPRITE`
4
4
 
5
- Показ, скрытие, перемещение и смена спрайтов на canvas-слоях.
5
+ Show, hide, move, and change sprites on canvas layers.
6
6
 
7
7
  ## Overlays
8
8
 
9
- Два связанных смысла одного имени:
9
+ Two related meanings of one name:
10
10
 
11
- 1. **Args / сценарий** — `args.overlays?: Record<string, string>`: карта слоёв вида `emotion` / `hair` / `wear` → значение; пути `{variation}/{key}/{value}` (+ `{variation}/index`).
12
- 2. **Layer child / React** — после `SRC_GET` на child и в `<Sprite />` поле `overlays` — массив `{ src }` для отрисовки.
11
+ 1. **Args / scenario** — `args.overlays?: Record<string, string>`: layer map `emotion` / `hair` / `wear` → value; paths `{variation}/{key}/{value}` (+ `{variation}/index`).
12
+ 2. **Layer child / React** — after `SRC_GET`, on the child and in `<Sprite />`, field `overlays` is a `{ src }` array for drawing.
13
13
 
14
14
  ```vne
15
15
  $ ul.sprite show co left {co/default} opacity 500
@@ -21,58 +21,58 @@ $ ul.sprite show co left {co/default} opacity 500
21
21
 
22
22
  `PARAMS.LAYER_SPRITE.SPRITE_INFO[type]`:
23
23
 
24
- | Поле | Смысл |
25
- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | `mapOverlays?` | Преобразование карты overlays перед резолвом путей |
27
- | `getSrc?` | Кастомный список src по `(variation, realOverlays, options, otherArgs)`. Пустая строка и другие falsy-элементы сохраняют слот и рисуются как transparent-картинка (без `MEDIA.GET` / `MEDIA.LOAD`). |
24
+ | Field | Meaning |
25
+ | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
+ | `mapOverlays?` | Transform the overlay map before path resolve |
27
+ | `getSrc?` | Custom src list from `(variation, realOverlays, options, otherArgs)`. Empty string and other falsy entries keep the slot and draw as a transparent image (no `MEDIA.GET` / `MEDIA.LOAD`). |
28
28
 
29
- ## События
29
+ ## Events
30
30
 
31
- Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.canvas.child.sprite`.
31
+ Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.sprite`.
32
32
 
33
- | Ключ | Строка | Смысл |
34
- | -------------- | ------------------------------- | ----------------------------------------------------- |
35
- | `SHOW` | `vne:layer_sprite:show` | Запросить данные у обработчиков и продолжить цепочку. |
36
- | `HIDE` | `vne:layer_sprite:hide` | Скрыть UI или слой. |
37
- | `MOVE` | `vne:layer_sprite:move` | Событие `MOVE` namespace плагина. |
38
- | `CHANGE` | `vne:layer_sprite:change` | Запросить данные у обработчиков и продолжить цепочку. |
39
- | `PRELOAD` | `vne:layer_sprite:preload` | Событие `PRELOAD` namespace плагина. |
40
- | `SRC_GET` | `vne:layer_sprite:src_get` | Получить значение или ресурс. |
41
- | `STATE_UPDATE` | `vne:layer_sprite:state_update` | Обновить накопленное состояние модуля. |
42
- | `STATE_GET` | `vne:layer_sprite:state_get` | Получить значение или ресурс. |
43
- | `STATE_ADD` | `vne:layer_sprite:state_add` | Событие `STATE_ADD` namespace плагина. |
44
- | `STATE_RM` | `vne:layer_sprite:state_rm` | Событие `STATE_RM` namespace плагина. |
33
+ | Key | String | Meaning |
34
+ | -------------- | ------------------------------- | --------------------------------------------- |
35
+ | `SHOW` | `vne:layer_sprite:show` | Ask handlers for data and continue the chain. |
36
+ | `HIDE` | `vne:layer_sprite:hide` | Hide the UI or layer. |
37
+ | `MOVE` | `vne:layer_sprite:move` | Plugin namespace `MOVE` event. |
38
+ | `CHANGE` | `vne:layer_sprite:change` | Ask handlers for data and continue the chain. |
39
+ | `PRELOAD` | `vne:layer_sprite:preload` | Plugin namespace `PRELOAD` event. |
40
+ | `SRC_GET` | `vne:layer_sprite:src_get` | Get a value or resource. |
41
+ | `STATE_UPDATE` | `vne:layer_sprite:state_update` | Update accumulated module state. |
42
+ | `STATE_GET` | `vne:layer_sprite:state_get` | Get a value or resource. |
43
+ | `STATE_ADD` | `vne:layer_sprite:state_add` | Plugin namespace `STATE_ADD` event. |
44
+ | `STATE_RM` | `vne:layer_sprite:state_rm` | Plugin namespace `STATE_RM` event. |
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". |
56
- | `POSITIONS` | `string` | Значение по умолчанию: "POSITIONS". |
57
- | `SPRITE_INFO` | `string` | Значение по умолчанию: "SPRITE_INFO". |
52
+ | Key | Type | Meaning |
53
+ | ------------------ | -------- | ---------------------------- |
54
+ | `TRANSITIONS_SHOW` | `string` | Default: "TRANSITIONS_SHOW". |
55
+ | `TRANSITIONS_HIDE` | `string` | Default: "TRANSITIONS_HIDE". |
56
+ | `POSITIONS` | `string` | Default: "POSITIONS". |
57
+ | `SPRITE_INFO` | `string` | Default: "SPRITE_INFO". |
58
58
 
59
- ## Настройки
59
+ ## Settings
60
60
 
61
- Нет.
61
+ None.
62
62
 
63
- ## Модули
63
+ ## Modules
64
64
 
65
- | Модуль | Зона ответственности |
66
- | ---------------------- | ------------------------------------------------------------- |
67
- | `layer.sprite.src` | Подмодуль `sprite.src` плагина. |
68
- | `layer.sprite.show` | Подмодуль `sprite.show` плагина. |
69
- | `layer.sprite.hide` | Подмодуль `sprite.hide` плагина. |
70
- | `layer.sprite.move` | Подмодуль `sprite.move` плагина. |
71
- | `layer.sprite.state` | Обрабатывает STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
72
- | `layer.sprite.change` | Подмодуль `sprite.change` плагина. |
73
- | `layer.sprite.preload` | Подмодуль `sprite.preload` плагина. |
65
+ | Module | Role |
66
+ | ---------------------- | -------------------------------------------------------- |
67
+ | `layer.sprite.src` | Plugin `sprite.src` submodule. |
68
+ | `layer.sprite.show` | Plugin `sprite.show` submodule. |
69
+ | `layer.sprite.hide` | Plugin `sprite.hide` submodule. |
70
+ | `layer.sprite.move` | Plugin `sprite.move` submodule. |
71
+ | `layer.sprite.state` | Handles STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
72
+ | `layer.sprite.change` | Plugin `sprite.change` submodule. |
73
+ | `layer.sprite.preload` | Plugin `sprite.preload` submodule. |
74
74
 
75
- ## Близкие плагины
75
+ ## Related plugins
76
76
 
77
77
  ### plugins/core/
78
78
 
@@ -81,6 +81,6 @@ Payloads и результаты хендлеров типизированы ч
81
81
  - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
82
82
  - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.PRELOAD
83
83
 
84
- ### Остальные
84
+ ### Other
85
85
 
86
86
  - [layer.md](./layer.md) — `LAYER`: EVENTS.UPDATE_FORCE, EVENTS.CHILD_GET, EVENTS.CHILD_CHANGE, EVENTS.CHILD_RM, SETTINGS.QUALITY, EVENTS.CHILD_ADD
@@ -1,55 +1,55 @@
1
1
  # plugins/canvas/sprite.speak/
2
2
 
3
- Пакет: `@vnejs/plugins.canvas.sprite.speak` · namespace: `LAYER_SPRITE_SPEAK`
3
+ Package: `@vnejs/plugins.canvas.sprite.speak` · namespace: `LAYER_SPRITE_SPEAK`
4
4
 
5
- Включение опции speak у sprite при речи спикера.
5
+ Turn on sprite speak when the speaker talks.
6
6
 
7
- Args спрайта могут содержать `overlays` (как у [sprite.md](./sprite.md)); speak меняет `options.speak` и перезапускает change/preload с теми же args.
7
+ Sprite args may include `overlays` (as in [sprite.md](./sprite.md)); speak updates `options.speak` and reruns change/preload with the same args.
8
8
 
9
- ## События
9
+ ## Events
10
10
 
11
- Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.canvas.child.sprite.speak`.
11
+ Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.sprite.speak`.
12
12
 
13
- | Ключ | Строка | Смысл |
14
- | ------------ | ----------------------------------- | ----------------------------------------------------- |
15
- | `PUSH` | `vne:layer_sprite_speak:push` | Добавить элемент в очередь или стек. |
16
- | `POP` | `vne:layer_sprite_speak:pop` | Извлечь элемент из очереди или стека. |
17
- | `SPEAKER` | `vne:layer_sprite_speak:speaker` | Запросить данные у обработчиков и продолжить цепочку. |
18
- | `START` | `vne:layer_sprite_speak:start` | Начать процесс. |
19
- | `END` | `vne:layer_sprite_speak:end` | Запросить данные у обработчиков и продолжить цепочку. |
20
- | `SPRITE_GET` | `vne:layer_sprite_speak:sprite_get` | Запросить данные у обработчиков и продолжить цепочку. |
21
- | `OPTION_SET` | `vne:layer_sprite_speak:option_set` | Записать или обновить значение. |
13
+ | Key | String | Meaning |
14
+ | ------------ | ----------------------------------- | --------------------------------------------- |
15
+ | `PUSH` | `vne:layer_sprite_speak:push` | Add an item to a queue or stack. |
16
+ | `POP` | `vne:layer_sprite_speak:pop` | Remove an item from a queue or stack. |
17
+ | `SPEAKER` | `vne:layer_sprite_speak:speaker` | Ask handlers for data and continue the chain. |
18
+ | `START` | `vne:layer_sprite_speak:start` | Start a process. |
19
+ | `END` | `vne:layer_sprite_speak:end` | Ask handlers for data and continue the chain. |
20
+ | `SPRITE_GET` | `vne:layer_sprite_speak:sprite_get` | Ask handlers for data and continue the chain. |
21
+ | `OPTION_SET` | `vne:layer_sprite_speak:option_set` | Write or update a value. |
22
22
 
23
- ## Константы
23
+ ## Constants
24
24
 
25
- Нет.
25
+ None.
26
26
 
27
- ## Параметры
27
+ ## Parameters
28
28
 
29
- | Ключ | Тип | Смысл |
30
- | -------------- | -------- | ---------------------------- |
31
- | `MIN_DURATION` | `number` | Значение по умолчанию: 2000. |
29
+ | Key | Type | Meaning |
30
+ | -------------- | -------- | -------------- |
31
+ | `MIN_DURATION` | `number` | Default: 2000. |
32
32
 
33
- ## Настройки
33
+ ## Settings
34
34
 
35
- Нет.
35
+ None.
36
36
 
37
- ## Модули
37
+ ## Modules
38
38
 
39
- | Модуль | Зона ответственности |
40
- | ----------------------------- | ------------------------------------------------------------- |
41
- | `layer.sprite.speak.sources` | В `postinject` — `shared.layerSpriteSpeakSources`; PUSH, POP. |
42
- | `layer.sprite.speak.duration` | Подмодуль `sprite.speak.duration` плагина. |
43
- | `layer.sprite.speak.preload` | Подмодуль `sprite.speak.preload` плагина. |
44
- | `layer.sprite.speak.staff` | Обрабатывает SPRITE_GET, OPTION_SET. |
45
- | `layer.sprite.speak` | Обрабатывает END, START, SPEAKER. |
39
+ | Module | Role |
40
+ | ----------------------------- | -------------------------------------------------------------- |
41
+ | `layer.sprite.speak.sources` | In `postinject` — `shared.layerSpriteSpeakSources`; PUSH, POP. |
42
+ | `layer.sprite.speak.duration` | Plugin `sprite.speak.duration` submodule. |
43
+ | `layer.sprite.speak.preload` | Plugin `sprite.speak.preload` submodule. |
44
+ | `layer.sprite.speak.staff` | Handles SPRITE_GET, OPTION_SET. |
45
+ | `layer.sprite.speak` | Handles END, START, SPEAKER. |
46
46
 
47
- ## Близкие плагины
47
+ ## Related plugins
48
48
 
49
49
  ### plugins/core/
50
50
 
51
- — нет
51
+ — None
52
52
 
53
- ### Остальные
53
+ ### Other
54
54
 
55
55
  - [sprite.md](./sprite.md) — `LAYER_SPRITE`: EVENTS.PRELOAD, EVENTS.STATE_GET, EVENTS.CHANGE
@@ -1,54 +1,54 @@
1
1
  # plugins/canvas/text/
2
2
 
3
- Пакет: `@vnejs/plugins.canvas.text` · namespace: `LAYER_TEXT`
3
+ Package: `@vnejs/plugins.canvas.text` · namespace: `LAYER_TEXT`
4
4
 
5
- Показ, скрытие, смена и перемещение локализованного текста на слоях.
5
+ Show, hide, change, and move localized text on layers.
6
6
 
7
- ## События
7
+ ## Events
8
8
 
9
- Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.canvas.child.text`.
9
+ Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.text`.
10
10
 
11
- | Ключ | Строка | Смысл |
12
- | -------------- | ----------------------------- | ----------------------------------------------------- |
13
- | `SHOW` | `vne:layer_text:show` | Запросить данные у обработчиков и продолжить цепочку. |
14
- | `HIDE` | `vne:layer_text:hide` | Скрыть UI или слой. |
15
- | `CHANGE` | `vne:layer_text:change` | Запросить данные у обработчиков и продолжить цепочку. |
16
- | `MOVE` | `vne:layer_text:move` | Событие `MOVE` namespace плагина. |
17
- | `STATE_UPDATE` | `vne:layer_text:state_update` | Обновить накопленное состояние модуля. |
18
- | `STATE_GET` | `vne:layer_text:state_get` | Получить значение или ресурс. |
19
- | `STATE_ADD` | `vne:layer_text:state_add` | Событие `STATE_ADD` namespace плагина. |
20
- | `STATE_RM` | `vne:layer_text:state_rm` | Событие `STATE_RM` namespace плагина. |
11
+ | Key | String | Meaning |
12
+ | -------------- | ----------------------------- | --------------------------------------------- |
13
+ | `SHOW` | `vne:layer_text:show` | Ask handlers for data and continue the chain. |
14
+ | `HIDE` | `vne:layer_text:hide` | Hide the UI or layer. |
15
+ | `CHANGE` | `vne:layer_text:change` | Ask handlers for data and continue the chain. |
16
+ | `MOVE` | `vne:layer_text:move` | Plugin namespace `MOVE` event. |
17
+ | `STATE_UPDATE` | `vne:layer_text:state_update` | Update accumulated module state. |
18
+ | `STATE_GET` | `vne:layer_text:state_get` | Get a value or resource. |
19
+ | `STATE_ADD` | `vne:layer_text:state_add` | Plugin namespace `STATE_ADD` event. |
20
+ | `STATE_RM` | `vne:layer_text:state_rm` | Plugin namespace `STATE_RM` event. |
21
21
 
22
- ## Константы
22
+ ## Constants
23
23
 
24
- Нет.
24
+ None.
25
25
 
26
- ## Параметры
26
+ ## Parameters
27
27
 
28
- | Ключ | Тип | Смысл |
29
- | -------------------- | -------- | -------------------------------------------- |
30
- | `TEXT_STYLE_KEYS` | `string` | Значение по умолчанию: "TEXT_STYLE_KEYS". |
31
- | `DEFAULT_TEXT_ARGS` | `string` | Значение по умолчанию: "DEFAULT_TEXT_ARGS". |
32
- | `TRANSITIONS_SHOW` | `string` | Значение по умолчанию: "TRANSITIONS_SHOW". |
33
- | `TRANSITIONS_HIDE` | `string` | Значение по умолчанию: "TRANSITIONS_HIDE". |
34
- | `TRANSITIONS_CHANGE` | `string` | Значение по умолчанию: "TRANSITIONS_CHANGE". |
35
- | `POSITIONS` | `string` | Значение по умолчанию: "POSITIONS". |
28
+ | Key | Type | Meaning |
29
+ | -------------------- | -------- | ------------------------------ |
30
+ | `TEXT_STYLE_KEYS` | `string` | Default: "TEXT_STYLE_KEYS". |
31
+ | `DEFAULT_TEXT_ARGS` | `string` | Default: "DEFAULT_TEXT_ARGS". |
32
+ | `TRANSITIONS_SHOW` | `string` | Default: "TRANSITIONS_SHOW". |
33
+ | `TRANSITIONS_HIDE` | `string` | Default: "TRANSITIONS_HIDE". |
34
+ | `TRANSITIONS_CHANGE` | `string` | Default: "TRANSITIONS_CHANGE". |
35
+ | `POSITIONS` | `string` | Default: "POSITIONS". |
36
36
 
37
- ## Настройки
37
+ ## Settings
38
38
 
39
- Нет.
39
+ None.
40
40
 
41
- ## Модули
41
+ ## Modules
42
42
 
43
- | Модуль | Зона ответственности |
44
- | ------------------- | ------------------------------------------------------------- |
45
- | `layer.text.show` | Подмодуль `text.show` плагина. |
46
- | `layer.text.hide` | Подмодуль `text.hide` плагина. |
47
- | `layer.text.change` | Подмодуль `text.change` плагина. |
48
- | `layer.text.move` | Подмодуль `text.move` плагина. |
49
- | `layer.text.state` | Обрабатывает STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
43
+ | Module | Role |
44
+ | ------------------- | -------------------------------------------------------- |
45
+ | `layer.text.show` | Plugin `text.show` submodule. |
46
+ | `layer.text.hide` | Plugin `text.hide` submodule. |
47
+ | `layer.text.change` | Plugin `text.change` submodule. |
48
+ | `layer.text.move` | Plugin `text.move` submodule. |
49
+ | `layer.text.state` | Handles STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
50
50
 
51
- ## Близкие плагины
51
+ ## Related plugins
52
52
 
53
53
  ### plugins/core/
54
54
 
@@ -57,7 +57,7 @@ Payloads и результаты хендлеров типизированы ч
57
57
  - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
58
58
  - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.PRELOAD
59
59
 
60
- ### Остальные
60
+ ### Other
61
61
 
62
62
  - [layer.md](./layer.md) — `LAYER`: EVENTS.CHILD_GET, EVENTS.CHILD_CHANGE, EVENTS.UPDATE_FORCE, EVENTS.CHILD_RM, EVENTS.CHILD_ADD
63
63
  - [locs.md](../text/locs.md) — `LOCS`: EVENTS.LOAD
@@ -1,10 +1,10 @@
1
1
  # plugins/canvas/video/
2
2
 
3
- Пакет: `@vnejs/plugins.canvas.video` · namespace: `LAYER_VIDEO`
3
+ Package: `@vnejs/plugins.canvas.video` · namespace: `LAYER_VIDEO`
4
4
 
5
- Показ, скрытие, смена и preload видео на canvas-слоях.
5
+ Show, hide, change, and preload video on canvas layers.
6
6
 
7
- Then-bg после видео принимает те же args, что [bg.md](./bg.md), включая `overlays` (в сценарии — блок `bg:` под командой video).
7
+ Then-bg after video takes the same args as [bg.md](./bg.md), including `overlays` (in the scenario — a `bg:` block under the video command).
8
8
 
9
9
  ```vne
10
10
  $ bl.video show {logo} … then bg {castle/surgery_room} …
@@ -14,50 +14,50 @@ $ bl.video show {logo} … then bg {castle/surgery_room} …
14
14
  man: 1
15
15
  ```
16
16
 
17
- ## События
17
+ ## Events
18
18
 
19
- Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.canvas.child.video`.
19
+ Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.video`.
20
20
 
21
- | Ключ | Строка | Смысл |
22
- | -------------- | ------------------------------ | ----------------------------------------------------- |
23
- | `SHOW` | `vne:layer_video:show` | Запросить данные у обработчиков и продолжить цепочку. |
24
- | `HIDE` | `vne:layer_video:hide` | Запросить данные у обработчиков и продолжить цепочку. |
25
- | `CHANGE` | `vne:layer_video:change` | Запросить данные у обработчиков и продолжить цепочку. |
26
- | `ENDED` | `vne:layer_video:ended` | Запросить данные у обработчиков и продолжить цепочку. |
27
- | `PRELOAD` | `vne:layer_video:preload` | Событие `PRELOAD` namespace плагина. |
28
- | `SRC_GET` | `vne:layer_video:src_get` | Запросить данные у обработчиков и продолжить цепочку. |
29
- | `STATE_RM` | `vne:layer_video:state_rm` | Событие `STATE_RM` namespace плагина. |
30
- | `STATE_GET` | `vne:layer_video:state_get` | Получить значение или ресурс. |
31
- | `STATE_ADD` | `vne:layer_video:state_add` | Событие `STATE_ADD` namespace плагина. |
32
- | `STATE_UPDATE` | `vne:layer_video:state_update` | Обновить накопленное состояние модуля. |
21
+ | Key | String | Meaning |
22
+ | -------------- | ------------------------------ | --------------------------------------------- |
23
+ | `SHOW` | `vne:layer_video:show` | Ask handlers for data and continue the chain. |
24
+ | `HIDE` | `vne:layer_video:hide` | Ask handlers for data and continue the chain. |
25
+ | `CHANGE` | `vne:layer_video:change` | Ask handlers for data and continue the chain. |
26
+ | `ENDED` | `vne:layer_video:ended` | Ask handlers for data and continue the chain. |
27
+ | `PRELOAD` | `vne:layer_video:preload` | Plugin namespace `PRELOAD` event. |
28
+ | `SRC_GET` | `vne:layer_video:src_get` | Ask handlers for data and continue the chain. |
29
+ | `STATE_RM` | `vne:layer_video:state_rm` | Plugin namespace `STATE_RM` event. |
30
+ | `STATE_GET` | `vne:layer_video:state_get` | Get a value or resource. |
31
+ | `STATE_ADD` | `vne:layer_video:state_add` | Plugin namespace `STATE_ADD` event. |
32
+ | `STATE_UPDATE` | `vne:layer_video:state_update` | Update accumulated module state. |
33
33
 
34
- ## Константы
34
+ ## Constants
35
35
 
36
- Нет.
36
+ None.
37
37
 
38
- ## Параметры
38
+ ## Parameters
39
39
 
40
- | Ключ | Тип | Смысл |
41
- | ------------------ | -------- | ------------------------------------------ |
42
- | `TRANSITIONS_SHOW` | `string` | Значение по умолчанию: "TRANSITIONS_SHOW". |
43
- | `TRANSITIONS_HIDE` | `string` | Значение по умолчанию: "TRANSITIONS_HIDE". |
40
+ | Key | Type | Meaning |
41
+ | ------------------ | -------- | ---------------------------- |
42
+ | `TRANSITIONS_SHOW` | `string` | Default: "TRANSITIONS_SHOW". |
43
+ | `TRANSITIONS_HIDE` | `string` | Default: "TRANSITIONS_HIDE". |
44
44
 
45
- ## Настройки
45
+ ## Settings
46
46
 
47
- Нет.
47
+ None.
48
48
 
49
- ## Модули
49
+ ## Modules
50
50
 
51
- | Модуль | Зона ответственности |
52
- | --------------------- | ------------------------------------------------------------- |
53
- | `layer.video.show` | Обрабатывает SHOW, ENDED. |
54
- | `layer.video.hide` | Подмодуль `video.hide` плагина. |
55
- | `layer.video.change` | Подмодуль `video.change` плагина. |
56
- | `layer.video.state` | Обрабатывает STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
57
- | `layer.video.src.get` | Подмодуль `video.src.get` плагина. |
58
- | `layer.video.preload` | Подмодуль `video.preload` плагина. |
51
+ | Module | Role |
52
+ | --------------------- | -------------------------------------------------------- |
53
+ | `layer.video.show` | Handles SHOW, ENDED. |
54
+ | `layer.video.hide` | Plugin `video.hide` submodule. |
55
+ | `layer.video.change` | Plugin `video.change` submodule. |
56
+ | `layer.video.state` | Handles STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
57
+ | `layer.video.src.get` | Plugin `video.src.get` submodule. |
58
+ | `layer.video.preload` | Plugin `video.preload` submodule. |
59
59
 
60
- ## Близкие плагины
60
+ ## Related plugins
61
61
 
62
62
  ### plugins/core/
63
63
 
@@ -66,7 +66,7 @@ Payloads и результаты хендлеров типизированы ч
66
66
  - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
67
67
  - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.PRELOAD
68
68
 
69
- ### Остальные
69
+ ### Other
70
70
 
71
71
  - [layer.md](./layer.md) — `LAYER`: EVENTS.CHILD_CHANGE, EVENTS.UPDATE_FORCE, EVENTS.CHILDS_RM, SETTINGS.QUALITY, EVENTS.CHILD_ADD
72
72
  - [image.md](./image.md) — `LAYER_BG`: EVENTS.PRELOAD, EVENTS.SHOW
@@ -1,54 +1,54 @@
1
1
  # plugins/canvas.layers/bl/
2
2
 
3
- Пакет: `@vnejs/plugins.canvas.layers.bl` · namespace: `LAYER_BL`
3
+ Package: `@vnejs/plugins.canvas.layers.bl` · namespace: `LAYER_BL`
4
4
 
5
- Фоновый canvas-слой bl: контроллер, view и команды bg/sprite/text/video.
5
+ Back canvas layer `bl`: controller, view, and bg/sprite/text/video commands.
6
6
 
7
- ## События
7
+ ## Events
8
8
 
9
- Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.canvas.layers.bl`.
9
+ Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.layers.bl`.
10
10
 
11
- | Ключ | Строка | Смысл |
12
- | -------------- | --------------------------- | ----------------------------------------------- |
13
- | `SHOW` | `vne:layer_bl:show` | Показать UI или слой. |
14
- | `HIDE` | `vne:layer_bl:hide` | Скрыть UI или слой. |
15
- | `UPDATE` | `vne:layer_bl:update` | Обновить состояние или отображение. |
16
- | `UPDATE_FAST` | `vne:layer_bl:update_fast` | Быстрое обновление отображения. |
17
- | `UPDATE_FORCE` | `vne:layer_bl:update_force` | Перерисовать view с `isForce`, стейт не меняет. |
18
- | `UPDATE_STATE` | `vne:layer_bl:update_state` | Слить partial в стейт контроллера. |
11
+ | Key | String | Meaning |
12
+ | -------------- | --------------------------- | ------------------------------------------------------ |
13
+ | `SHOW` | `vne:layer_bl:show` | Show the UI or layer. |
14
+ | `HIDE` | `vne:layer_bl:hide` | Hide the UI or layer. |
15
+ | `UPDATE` | `vne:layer_bl:update` | Update state or display. |
16
+ | `UPDATE_FAST` | `vne:layer_bl:update_fast` | Fast display update. |
17
+ | `UPDATE_FORCE` | `vne:layer_bl:update_force` | Redraw the view with `isForce`; state does not change. |
18
+ | `UPDATE_STATE` | `vne:layer_bl:update_state` | Merge a partial into the controller state. |
19
19
 
20
- ## Константы
20
+ ## Constants
21
21
 
22
22
  - **`LAYER`** — "bl"
23
23
 
24
- ## Параметры
24
+ ## Parameters
25
25
 
26
- | Ключ | Тип | Смысл |
27
- | -------- | -------- | -------------------------------- |
28
- | `ZINDEX` | `string` | Значение по умолчанию: "ZINDEX". |
26
+ | Key | Type | Meaning |
27
+ | -------- | -------- | ------------------ |
28
+ | `ZINDEX` | `string` | Default: "ZINDEX". |
29
29
 
30
- ## Настройки
30
+ ## Settings
31
31
 
32
- Нет.
32
+ None.
33
33
 
34
- ## Модули
34
+ ## Modules
35
35
 
36
- | Модуль | Зона ответственности |
37
- | --------------------- | ---------------------------------- |
38
- | `layer.bl.controller` | Подмодуль `bl.controller` плагина. |
39
- | `layer.bl.props` | Подмодуль `bl.props` плагина. |
40
- | `layer.bl.bg` | Подмодуль `bl.bg` плагина. |
41
- | `layer.bl.sprite` | Подмодуль `bl.sprite` плагина. |
42
- | `layer.bl.text` | Подмодуль `bl.text` плагина. |
43
- | `layer.bl.video` | Подмодуль `bl.video` плагина. |
44
- | `layer.bl.view` | Подмодуль `bl.view` плагина. |
36
+ | Module | Role |
37
+ | --------------------- | --------------------------------- |
38
+ | `layer.bl.controller` | Plugin `bl.controller` submodule. |
39
+ | `layer.bl.props` | Plugin `bl.props` submodule. |
40
+ | `layer.bl.bg` | Plugin `bl.bg` submodule. |
41
+ | `layer.bl.sprite` | Plugin `bl.sprite` submodule. |
42
+ | `layer.bl.text` | Plugin `bl.text` submodule. |
43
+ | `layer.bl.video` | Plugin `bl.video` submodule. |
44
+ | `layer.bl.view` | Plugin `bl.view` submodule. |
45
45
 
46
- ## Близкие плагины
46
+ ## Related plugins
47
47
 
48
48
  ### plugins/core/
49
49
 
50
- — нет
50
+ — None
51
51
 
52
- ### Остальные
52
+ ### Other
53
53
 
54
- — нет
54
+ — None