@vnejs/docs 0.2.1

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 (191) hide show
  1. package/README.md +49 -0
  2. package/architecture.md +507 -0
  3. package/manifest.json +44 -0
  4. package/package.json +27 -0
  5. package/plugins/audio/ambient.md +39 -0
  6. package/plugins/audio/audio.md +61 -0
  7. package/plugins/audio/music.md +39 -0
  8. package/plugins/audio/sound.md +39 -0
  9. package/plugins/audio/voice.md +43 -0
  10. package/plugins/canvas/bg.md +76 -0
  11. package/plugins/canvas/bg.speak.md +54 -0
  12. package/plugins/canvas/fill.md +66 -0
  13. package/plugins/canvas/layer.md +57 -0
  14. package/plugins/canvas/sprite.md +85 -0
  15. package/plugins/canvas/sprite.speak.md +53 -0
  16. package/plugins/canvas/text.md +63 -0
  17. package/plugins/canvas/video.md +71 -0
  18. package/plugins/canvas.layers/bl.md +47 -0
  19. package/plugins/canvas.layers/fl.md +47 -0
  20. package/plugins/canvas.layers/ml.md +47 -0
  21. package/plugins/canvas.layers/ul.md +46 -0
  22. package/plugins/canvas.props/animation.md +48 -0
  23. package/plugins/canvas.props/clip.md +43 -0
  24. package/plugins/canvas.props/filters.md +39 -0
  25. package/plugins/canvas.props/mask.md +44 -0
  26. package/plugins/canvas.props/scale.md +41 -0
  27. package/plugins/controls/controls.md +41 -0
  28. package/plugins/controls/cursor.md +59 -0
  29. package/plugins/controls/gamepad.md +37 -0
  30. package/plugins/controls/keyboard.md +37 -0
  31. package/plugins/core/components.md +47 -0
  32. package/plugins/core/interact.md +45 -0
  33. package/plugins/core/logs.md +46 -0
  34. package/plugins/core/media.md +59 -0
  35. package/plugins/core/memory.md +44 -0
  36. package/plugins/core/platforms.md +48 -0
  37. package/plugins/core/scenario.md +63 -0
  38. package/plugins/core/settings.md +43 -0
  39. package/plugins/core/stack.md +57 -0
  40. package/plugins/core/state.md +51 -0
  41. package/plugins/core/storage.md +89 -0
  42. package/plugins/core/system.md +56 -0
  43. package/plugins/core/vendors.md +45 -0
  44. package/plugins/entities/entities.md +35 -0
  45. package/plugins/entities/wallet.md +47 -0
  46. package/plugins/font/montserrat.md +35 -0
  47. package/plugins/platform/android.md +38 -0
  48. package/plugins/platform/electron.md +40 -0
  49. package/plugins/platform/metric.md +42 -0
  50. package/plugins/rpg/damage.md +46 -0
  51. package/plugins/rpg/hit.md +46 -0
  52. package/plugins/rpg/skills.md +47 -0
  53. package/plugins/save/auto.md +47 -0
  54. package/plugins/save/continue.md +43 -0
  55. package/plugins/save/save.md +62 -0
  56. package/plugins/scales/health.md +37 -0
  57. package/plugins/scales/mana.md +37 -0
  58. package/plugins/scales/scales.md +54 -0
  59. package/plugins/scenario/autoread.md +50 -0
  60. package/plugins/scenario/choose.md +111 -0
  61. package/plugins/scenario/fastforward.md +61 -0
  62. package/plugins/scenario/pause.md +43 -0
  63. package/plugins/scenario/point_and_click.md +95 -0
  64. package/plugins/scenario/qte.md +97 -0
  65. package/plugins/scenario/random.md +38 -0
  66. package/plugins/settings/filter.md +39 -0
  67. package/plugins/settings/potato.md +41 -0
  68. package/plugins/settings/ratio.md +41 -0
  69. package/plugins/settings/textsize.md +39 -0
  70. package/plugins/settings/volume.md +41 -0
  71. package/plugins/text/inject.md +41 -0
  72. package/plugins/text/locs.md +49 -0
  73. package/plugins/text/meet.md +40 -0
  74. package/plugins/text/smooth.md +51 -0
  75. package/plugins/text/text.md +78 -0
  76. package/plugins/text/wall.md +41 -0
  77. package/plugins/time/date.md +42 -0
  78. package/plugins/time/time.md +43 -0
  79. package/plugins/vars/counters.md +46 -0
  80. package/plugins/vars/flags.md +44 -0
  81. package/plugins/vars/vars.md +51 -0
  82. package/plugins/views/achievement.md +64 -0
  83. package/plugins/views/comment.md +49 -0
  84. package/plugins/views/cursor.md +39 -0
  85. package/plugins/views/fps.md +51 -0
  86. package/plugins/views/video.md +57 -0
  87. package/plugins/views.scenario/choose.md +79 -0
  88. package/plugins/views.scenario/interface.controls.md +50 -0
  89. package/plugins/views.scenario/interface.fastforward.md +50 -0
  90. package/plugins/views.scenario/interface.md +68 -0
  91. package/plugins/views.scenario/point_and_click.md +87 -0
  92. package/plugins/views.scenario/qte.md +105 -0
  93. package/plugins/views.screens/confirm.md +48 -0
  94. package/plugins/views.screens/credits.md +46 -0
  95. package/plugins/views.screens/eula.md +54 -0
  96. package/plugins/views.screens/gallery.full.md +48 -0
  97. package/plugins/views.screens/gallery.md +69 -0
  98. package/plugins/views.screens/gamemenu.md +52 -0
  99. package/plugins/views.screens/history.md +70 -0
  100. package/plugins/views.screens/intro.md +50 -0
  101. package/plugins/views.screens/loading.md +48 -0
  102. package/plugins/views.screens/mainmenu.md +61 -0
  103. package/plugins/views.screens/mainmenu.socials.md +45 -0
  104. package/plugins/views.screens/save.md +63 -0
  105. package/plugins/views.screens/settings.defaults.md +51 -0
  106. package/plugins/views.screens/settings.md +53 -0
  107. package/scenario.catalog/README.md +38 -0
  108. package/scenario.catalog/index.md +109 -0
  109. package/scenario.catalog/stubs/achievement.md +16 -0
  110. package/scenario.catalog/stubs/audio.ambient.md +16 -0
  111. package/scenario.catalog/stubs/audio.music.md +16 -0
  112. package/scenario.catalog/stubs/audio.sound.md +16 -0
  113. package/scenario.catalog/stubs/audio.voice.md +16 -0
  114. package/scenario.catalog/stubs/bl.animation.md +18 -0
  115. package/scenario.catalog/stubs/bl.bg.md +18 -0
  116. package/scenario.catalog/stubs/bl.clip.md +18 -0
  117. package/scenario.catalog/stubs/bl.fill.md +18 -0
  118. package/scenario.catalog/stubs/bl.filter.md +18 -0
  119. package/scenario.catalog/stubs/bl.mask.md +18 -0
  120. package/scenario.catalog/stubs/bl.scale.md +18 -0
  121. package/scenario.catalog/stubs/bl.sprite.md +18 -0
  122. package/scenario.catalog/stubs/bl.text.md +18 -0
  123. package/scenario.catalog/stubs/bl.video.md +18 -0
  124. package/scenario.catalog/stubs/choose.block.md +25 -0
  125. package/scenario.catalog/stubs/choose.md +18 -0
  126. package/scenario.catalog/stubs/choose.option.md +24 -0
  127. package/scenario.catalog/stubs/comment.md +17 -0
  128. package/scenario.catalog/stubs/counter.md +21 -0
  129. package/scenario.catalog/stubs/credits.md +17 -0
  130. package/scenario.catalog/stubs/date.md +17 -0
  131. package/scenario.catalog/stubs/fl.animation.md +18 -0
  132. package/scenario.catalog/stubs/fl.bg.md +18 -0
  133. package/scenario.catalog/stubs/fl.clip.md +18 -0
  134. package/scenario.catalog/stubs/fl.fill.md +18 -0
  135. package/scenario.catalog/stubs/fl.filter.md +18 -0
  136. package/scenario.catalog/stubs/fl.mask.md +18 -0
  137. package/scenario.catalog/stubs/fl.scale.md +18 -0
  138. package/scenario.catalog/stubs/fl.sprite.md +18 -0
  139. package/scenario.catalog/stubs/fl.text.md +18 -0
  140. package/scenario.catalog/stubs/fl.video.md +18 -0
  141. package/scenario.catalog/stubs/flag.md +24 -0
  142. package/scenario.catalog/stubs/interface.md +17 -0
  143. package/scenario.catalog/stubs/intro.md +16 -0
  144. package/scenario.catalog/stubs/mainmenu.md +16 -0
  145. package/scenario.catalog/stubs/ml.animation.md +18 -0
  146. package/scenario.catalog/stubs/ml.bg.md +18 -0
  147. package/scenario.catalog/stubs/ml.clip.md +18 -0
  148. package/scenario.catalog/stubs/ml.fill.md +18 -0
  149. package/scenario.catalog/stubs/ml.filter.md +18 -0
  150. package/scenario.catalog/stubs/ml.mask.md +18 -0
  151. package/scenario.catalog/stubs/ml.scale.md +18 -0
  152. package/scenario.catalog/stubs/ml.sprite.md +18 -0
  153. package/scenario.catalog/stubs/ml.text.md +18 -0
  154. package/scenario.catalog/stubs/ml.video.md +18 -0
  155. package/scenario.catalog/stubs/other.md +17 -0
  156. package/scenario.catalog/stubs/pause.md +16 -0
  157. package/scenario.catalog/stubs/point-and-click.block.md +21 -0
  158. package/scenario.catalog/stubs/point-and-click.md +18 -0
  159. package/scenario.catalog/stubs/point-and-click.option.md +20 -0
  160. package/scenario.catalog/stubs/qte.md +16 -0
  161. package/scenario.catalog/stubs/random.md +16 -0
  162. package/scenario.catalog/stubs/random.option.md +16 -0
  163. package/scenario.catalog/stubs/save.auto.md +16 -0
  164. package/scenario.catalog/stubs/save.md +16 -0
  165. package/scenario.catalog/stubs/scenario.md +17 -0
  166. package/scenario.catalog/stubs/settings.defaults.md +16 -0
  167. package/scenario.catalog/stubs/stack.md +18 -0
  168. package/scenario.catalog/stubs/text.meet.md +16 -0
  169. package/scenario.catalog/stubs/text.wall.md +17 -0
  170. package/scenario.catalog/stubs/time.md +17 -0
  171. package/scenario.catalog/stubs/ul.animation.md +18 -0
  172. package/scenario.catalog/stubs/ul.bg.md +18 -0
  173. package/scenario.catalog/stubs/ul.clip.md +18 -0
  174. package/scenario.catalog/stubs/ul.fill.md +18 -0
  175. package/scenario.catalog/stubs/ul.filter.md +18 -0
  176. package/scenario.catalog/stubs/ul.mask.md +18 -0
  177. package/scenario.catalog/stubs/ul.scale.md +18 -0
  178. package/scenario.catalog/stubs/ul.sprite.md +18 -0
  179. package/scenario.catalog/stubs/ul.text.md +18 -0
  180. package/scenario.catalog/stubs/video.md +16 -0
  181. package/scenario.catalog/stubs/wallet.md +17 -0
  182. package/scenario.guide/README.md +82 -0
  183. package/scenario.guide/audio.md +29 -0
  184. package/scenario.guide/canvas.md +46 -0
  185. package/scenario.guide/choose.md +54 -0
  186. package/scenario.guide/dialogue.md +58 -0
  187. package/scenario.guide/flow.md +71 -0
  188. package/scenario.guide/point-and-click.md +35 -0
  189. package/scenario.guide/qte-random.md +51 -0
  190. package/scenario.guide/vars.md +67 -0
  191. package/scenario.guide/views.md +65 -0
@@ -0,0 +1,48 @@
1
+ # plugins/views.screens/confirm/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.confirm` · namespace: `CONFIRM`
4
+
5
+ Модальный экран подтверждения с выбором принять или отклонить и колбэками.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `SHOW` | `vne:confirm:show` | Показать UI или слой. |
12
+ | `HIDE` | `vne:confirm:hide` | Скрыть UI или слой. |
13
+ | `EMIT` | `vne:confirm:emit` | Инициировать действие или цикл. |
14
+ | `UPDATE` | `vne:confirm:update` | Обновить состояние или отображение. |
15
+ | `ACCEPT` | `vne:confirm:accept` | Событие `ACCEPT` namespace плагина. |
16
+ | `DECLINE` | `vne:confirm:decline` | Событие `DECLINE` namespace плагина. |
17
+
18
+ ## Константы
19
+
20
+ Нет.
21
+
22
+ ## Параметры
23
+
24
+ | Ключ | Тип | Смысл |
25
+ |------|-----|-------|
26
+ | `TRANSITION` | `string` | Значение по умолчанию: "TRANSITION". |
27
+
28
+ ## Настройки
29
+
30
+ Нет.
31
+
32
+ ## Модули
33
+
34
+ | Модуль | Зона ответственности |
35
+ |--------|----------------------|
36
+ | `confirm.controller` | Обрабатывает UPDATE, ACCEPT, DECLINE, SHOW, …. |
37
+ | `confirm` | Обрабатывает EMIT, ACCEPT, DECLINE. |
38
+ | `confirm.view` | Подмодуль `view` плагина. |
39
+
40
+ ## Близкие плагины
41
+
42
+ ### plugins/core/
43
+
44
+ - [state.md](../core/state.md) — `STATE`: EVENTS.CLEAR
45
+
46
+ ### Остальные
47
+
48
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.INTERACT, CONST.BUTTONS.ACCEPT, CONST.BUTTONS.BACK, CONST.BUTTONS.ARROW_LEFT, CONST.BUTTONS.ARROW_RIGHT
@@ -0,0 +1,46 @@
1
+ # plugins/views.screens/credits/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.credits` · namespace: `CREDITS`
4
+
5
+ Экран титров, открываемый и закрываемый командами сценария show/hide.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `SHOW` | `vne:credits:show` | Показать UI или слой. |
12
+ | `HIDE` | `vne:credits:hide` | Скрыть UI или слой. |
13
+ | `UPDATE` | `vne:credits:update` | Обновить состояние или отображение. |
14
+
15
+ ## Константы
16
+
17
+ Нет.
18
+
19
+ ## Параметры
20
+
21
+ | Ключ | Тип | Смысл |
22
+ |------|-----|-------|
23
+ | `LINES` | `string` | Значение по умолчанию: "LINES". |
24
+
25
+ ## Настройки
26
+
27
+ Нет.
28
+
29
+ ## Модули
30
+
31
+ | Модуль | Зона ответственности |
32
+ |--------|----------------------|
33
+ | `credits.controller` | Обрабатывает HIDE, UPDATE, SHOW, CLEAR. |
34
+ | `credits` | Модуль `credits`. |
35
+ | `credits.view` | Подмодуль `view` плагина. |
36
+
37
+ ## Близкие плагины
38
+
39
+ ### plugins/core/
40
+
41
+ - [scenario.md](../core/scenario.md) — `SCENARIO`: emitNext, EVENTS.LINE_EXEC_REG
42
+ - [state.md](../core/state.md) — `STATE`: EVENTS.CLEAR
43
+
44
+ ### Остальные
45
+
46
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.ACCEPT, CONST.BUTTONS.INTERACT, CONST.BUTTONS.MENU
@@ -0,0 +1,54 @@
1
+ # plugins/views.screens/eula/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.eula` · namespace: `EULA`
4
+
5
+ Экран лицензионного соглашения перед главным меню, если версия ещё не принята.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `UPDATE` | `vne:eula:update` | Обновить состояние или отображение. |
12
+ | `SHOW` | `vne:eula:show` | Показать UI или слой. |
13
+ | `HIDE` | `vne:eula:hide` | Скрыть UI или слой. |
14
+ | `ACCEPT` | `vne:eula:accept` | Событие `ACCEPT` namespace плагина. |
15
+ | `EXIT` | `vne:eula:exit` | Событие `EXIT` namespace плагина. |
16
+
17
+ ## Константы
18
+
19
+ Нет.
20
+
21
+ ## Параметры
22
+
23
+ | Ключ | Тип | Смысл |
24
+ |------|-----|-------|
25
+ | `LANGS` | `string` | Значение по умолчанию: "LANGS". |
26
+
27
+ ## Настройки
28
+
29
+ | Ключ | Тип | Смысл |
30
+ |------|-----|-------|
31
+ | `ACCEPTED_VERSION` (`vne:eula:accepted_version`) | `string` | Настройка `vne:eula:accepted_version` в `shared.settings`. |
32
+ | `LANG` (`vne:eula:lang`) | `string` | Настройка `vne:eula:lang` в `shared.settings`. |
33
+
34
+ ## Модули
35
+
36
+ | Модуль | Зона ответственности |
37
+ |--------|----------------------|
38
+ | `eula.controller` | Обрабатывает UPDATE, SHOW, HIDE, EXTERNAL_UPDATE, …. |
39
+ | `eula` | Обрабатывает ACCEPT, EXIT, SHOW. |
40
+ | `eula.view` | Подмодуль `view` плагина. |
41
+
42
+ ## Близкие плагины
43
+
44
+ ### plugins/core/
45
+
46
+ - [components.md](../core/components.md) — `COMPONENTS`: EVENTS.EXTERNAL_UPDATE
47
+ - [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT, EVENTS.SET
48
+ - [state.md](../core/state.md) — `STATE`: EVENTS.CLEAR
49
+ - [system.md](../core/system.md) — `SYSTEM`: EVENTS.CLOSE
50
+
51
+ ### Остальные
52
+
53
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.ARROW_UP, CONST.BUTTONS.ARROW_BOTTOM, CONST.BUTTONS.ACCEPT, CONST.BUTTONS.BACK
54
+ - [mainmenu.md](./mainmenu.md) — `MAINMENU`: EVENTS.SHOW
@@ -0,0 +1,48 @@
1
+ # plugins/views.screens/gallery.full/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.gallery.full` · namespace: `GALLERY_FULL_VIEW`
4
+
5
+ Полноэкранный просмотр выбранного изображения из галереи.
6
+
7
+ Для вариаций с `layerChildType` фона src берётся через `LAYER_BG.SRC_GET` с `args.overlays` из выбранного варианта галереи.
8
+
9
+ ## События
10
+
11
+ | Ключ | Строка | Смысл |
12
+ |------|--------|-------|
13
+ | `SHOW` | `vne:gallery_full:show` | Показать UI или слой. |
14
+ | `HIDE` | `vne:gallery_full:hide` | Скрыть UI или слой. |
15
+ | `UPDATE` | `vne:gallery_full:update` | Обновить состояние или отображение. |
16
+
17
+ ## Константы
18
+
19
+ Нет.
20
+
21
+ ## Параметры
22
+
23
+ | Ключ | Тип | Смысл |
24
+ |------|-----|-------|
25
+ | `TRANSITION` | `string` | Значение по умолчанию: "TRANSITION". |
26
+
27
+ ## Настройки
28
+
29
+ Нет.
30
+
31
+ ## Модули
32
+
33
+ | Модуль | Зона ответственности |
34
+ |--------|----------------------|
35
+ | `gallery.full.controller` | Обрабатывает UPDATE, HIDE, SHOW, CHOOSE. |
36
+ | `gallery.full.view` | Подмодуль `full.view` плагина. |
37
+
38
+ ## Близкие плагины
39
+
40
+ ### plugins/core/
41
+
42
+ — нет
43
+
44
+ ### Остальные
45
+
46
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.BACK, CONST.BUTTONS.MENU, CONST.BUTTONS.GAMEMENU
47
+ - [gallery.md](./gallery.md) — `GALLERY`: EVENTS.CHOOSE
48
+ - [layer.md](../canvas/layer.md) — `LAYER`: SETTINGS.QUALITY
@@ -0,0 +1,69 @@
1
+ # plugins/views.screens/gallery/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.gallery` · namespace: `GALLERY`
4
+
5
+ Галерея CG с вкладками и сеткой; открытые изображения отмечаются в storage.
6
+
7
+ Вариации вкладки (`GalleryTabContentVariation`) несут `overlays: Record<string, string | number>` — та же карта, что у [bg.md](../canvas/bg.md) args; значения нормализуются в строки перед показом / full-view.
8
+
9
+ ## События
10
+
11
+ | Ключ | Строка | Смысл |
12
+ |------|--------|-------|
13
+ | `OPEN` | `vne:gallery:open` | Открыть экран или панель. |
14
+ | `CHECK` | `vne:gallery:check` | Проверить состояние или наличие ресурса. |
15
+ | `CLEAR` | `vne:gallery:clear` | Очистить накопленное состояние. |
16
+ | `SHOW` | `vne:gallery:show` | Показать UI или слой. |
17
+ | `HIDE` | `vne:gallery:hide` | Скрыть UI или слой. |
18
+ | `PAGE_SET` | `vne:gallery:page_set` | Записать или обновить значение. |
19
+ | `TAB_SET` | `vne:gallery:tab_set` | Выбрать вкладку галереи (`{ tab }`). |
20
+ | `UPDATE` | `vne:gallery:update` | Обновить состояние или отображение. |
21
+ | `PRELOAD` | `vne:gallery:preload` | Событие `PRELOAD` namespace плагина. |
22
+ | `CHOOSE` | `vne:gallery:choose` | Событие `CHOOSE` namespace плагина. |
23
+
24
+ ## Константы
25
+
26
+ Нет.
27
+
28
+ ## Параметры
29
+
30
+ | Ключ | Тип | Смысл |
31
+ |------|-----|-------|
32
+ | `TABS` | `string` | Значение по умолчанию: "TABS". |
33
+ | `BACKGROUND` | `string` | Значение по умолчанию: "save". |
34
+ | `TRANSITION` | `string` | Значение по умолчанию: "TRANSITION". |
35
+ | `ZINDEX` | `string` | Значение по умолчанию: "ZINDEX". |
36
+ | `LOC_LABEL` | `string` | Имя метки или стартовой точки. |
37
+ | `VIEW_PROPS` | `string` | Значение по умолчанию: "VIEW_PROPS". |
38
+ | `ROWS` | `string` | Значение по умолчанию: "ROWS". |
39
+ | `COLUMNS` | `string` | Значение по умолчанию: "COLUMNS". |
40
+ | `AUDIO_NAME` | `string` | Имя трека на слое `view` при открытии экрана; пустая строка — без overlay-музыки. |
41
+
42
+ ## Настройки
43
+
44
+ Нет.
45
+
46
+ ## Модули
47
+
48
+ | Модуль | Зона ответственности |
49
+ |--------|----------------------|
50
+ | `gallery.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека. |
51
+ | `gallery.controller` | Обрабатывает UPDATE, HIDE, CHOOSE, TAB_SET, …. |
52
+ | `gallery.controller.tabs` | Наследник `ModuleControllerTabs`: TAB_PREV/TAB_NEXT → `TAB_SET`; PUSH/POP controls на SHOW/HIDE. |
53
+ | `gallery` | Обрабатывает OPEN, CHECK, CLEAR. |
54
+ | `gallery.view` | Подмодуль `view` плагина. |
55
+
56
+ ## Близкие плагины
57
+
58
+ ### plugins/core/
59
+
60
+ - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED, EVENTS.CLEAR
61
+ - [state.md](../core/state.md) — `STATE`: EVENTS.CLEAR
62
+ - [storage.md](../core/storage.md) — `STORAGE`: EVENTS.SET, EVENTS.GET, EVENTS.RM_ALL
63
+ - [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
64
+
65
+ ### Остальные
66
+
67
+ - [audio.md](../audio/audio.md) — `AUDIO`: EVENTS.GLOBAL_PAUSE, EVENTS.PLAY, EVENTS.STOP, EVENTS.GLOBAL_RESUME, EVENTS.MEDIA_LOAD
68
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.BACK, CONST.BUTTONS.MENU, CONST.BUTTONS.GAMEMENU, CONST.BUTTONS.ARROW_UP, CONST.BUTTONS.ARROW_RIGHT, CONST.BUTTONS.ARROW_BOTTOM
69
+ - [layer.md](../canvas/layer.md) — `LAYER`: SETTINGS.QUALITY
@@ -0,0 +1,52 @@
1
+ # plugins/views.screens/gamemenu/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.gamemenu` · namespace: `GAMEMENU`
4
+
5
+ Игровое меню паузы со списком настраиваемых пунктов.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `SHOW` | `vne:gamemenu:show` | Показать UI или слой. |
12
+ | `HIDE` | `vne:gamemenu:hide` | Скрыть UI или слой. |
13
+ | `CLICK` | `vne:gamemenu:click` | Событие `CLICK` namespace плагина. |
14
+ | `UPDATE` | `vne:gamemenu:update` | Обновить состояние или отображение. |
15
+ | `ACCEPT` | `vne:gamemenu:accept` | Событие `ACCEPT` namespace плагина. |
16
+
17
+ ## Константы
18
+
19
+ Нет.
20
+
21
+ ## Параметры
22
+
23
+ | Ключ | Тип | Смысл |
24
+ |------|-----|-------|
25
+ | `ITEMS` | `string` | Значение по умолчанию: "ITEMS". |
26
+ | `TRANSITION` | `string` | Значение по умолчанию: "TRANSITION". |
27
+ | `ZINDEX` | `string` | Значение по умолчанию: "ZINDEX". |
28
+ | `LOC_LABEL` | `string` | Имя метки или стартовой точки. |
29
+ | `VIEW_PROPS` | `string` | Значение по умолчанию: "VIEW_PROPS". |
30
+
31
+ ## Настройки
32
+
33
+ Нет.
34
+
35
+ ## Модули
36
+
37
+ | Модуль | Зона ответственности |
38
+ |--------|----------------------|
39
+ | `gameMenu.controller` | Обрабатывает UPDATE, HIDE, ACCEPT, SHOW, …. |
40
+ | `gameMenu` | Модуль `gameMenu`. |
41
+ | `gameMenu.view` | Подмодуль `view` плагина. |
42
+
43
+ ## Близкие плагины
44
+
45
+ ### plugins/core/
46
+
47
+ - [components.md](../core/components.md) — `COMPONENTS`: EVENTS.EXTERNAL_UPDATE
48
+ - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
49
+
50
+ ### Остальные
51
+
52
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.BACK, CONST.BUTTONS.MENU, CONST.BUTTONS.GAMEMENU, CONST.BUTTONS.ACCEPT, CONST.BUTTONS.ARROW_UP, CONST.BUTTONS.ARROW_BOTTOM
@@ -0,0 +1,70 @@
1
+ # plugins/views.screens/history/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.history` · namespace: `HISTORY`
4
+
5
+ Журнал диалогов с возвратом к сохранённым состояниям прошлых реплик.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `GET` | `vne:history:get` | Получить значение или ресурс. |
12
+ | `ADD` | `vne:history:add` | Добавить запись в журнал (snapshot state). Payload: реплика (`label`/`text`/`args`/`speaker`…) или маркер UI (`locKey` без speaker/text). |
13
+ | `LOAD` | `vne:history:load` | Запросить данные у обработчиков и продолжить цепочку. |
14
+ | `BACK` | `vne:history:back` | Событие `BACK` namespace плагина. |
15
+ | `KEYS` | `vne:history:keys` | Событие `KEYS` namespace плагина. |
16
+ | `HIDE` | `vne:history:hide` | Скрыть UI или слой. |
17
+ | `SHOW` | `vne:history:show` | Показать UI или слой. |
18
+ | `CLICK` | `vne:history:click` | Событие `CLICK` namespace плагина. |
19
+ | `UPDATE` | `vne:history:update` | Обновить состояние или отображение. |
20
+ | `ACCEPT` | `vne:history:accept` | Событие `ACCEPT` namespace плагина. |
21
+
22
+ ## Константы
23
+
24
+ Нет.
25
+
26
+ ## Параметры
27
+
28
+ | Ключ | Тип | Смысл |
29
+ |------|-----|-------|
30
+ | `MAX_LENGTH` | `string` | Значение по умолчанию: "MAX_LENGTH". |
31
+ | `ZINDEX` | `string` | Значение по умолчанию: "ZINDEX". |
32
+ | `TRANSITION` | `string` | Значение по умолчанию: "TRANSITION". |
33
+ | `LOC_LABEL` | `string` | Имя метки или стартовой точки. |
34
+ | `VIEW_PROPS` | `string` | Значение по умолчанию: "VIEW_PROPS". |
35
+
36
+ ## Настройки
37
+
38
+ Нет.
39
+
40
+ ## Модули
41
+
42
+ | Модуль | Зона ответственности |
43
+ |--------|----------------------|
44
+ | `history.controller` | SHOW/HIDE/ACCEPT/CLICK; перед SHOW резолвит тексты строк (`TEXT.REPLACE`). Для `locKey` — через `PARAMS.HISTORY.LOC_LABEL` (локализация view), иначе через label сценария. |
45
+ | `history` | Обрабатывает ADD, GET, LOAD, BACK, …. |
46
+ | `history.view` | Подмодуль `view` плагина. |
47
+
48
+ ## Compatibility
49
+
50
+ ### `compatibility/scenario.choose/views.screens.history/`
51
+
52
+ Пакет: `@vnejs/compatibility.scenario.choose-with-views.screens.history`
53
+
54
+ На `CHOOSE.OPTION_BEFORE_REG` добавляет в историю запись `{ locKey: "choice" }`. Перевод — ключ `choice` в `history.json` (например «Выбор...»).
55
+
56
+ ## Близкие плагины
57
+
58
+ ### plugins/core/
59
+
60
+ - [logs.md](../core/logs.md) — `LOGS`: emitLog
61
+ - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.REG, EVENTS.SET, EVENTS.KEYS, EVENTS.GET
62
+ - [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.LABEL_GET
63
+ - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.GET, EVENTS.LOAD
64
+ - [vendors.md](../core/vendors.md) — `VENDORS`: emitClone, EVENTS.UID
65
+
66
+ ### Остальные
67
+
68
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.BACK, CONST.BUTTONS.MENU, CONST.BUTTONS.GAMEMENU, CONST.BUTTONS.ARROW_UP, CONST.BUTTONS.ARROW_BOTTOM, CONST.BUTTONS.ACCEPT
69
+ - [text.md](../text/text.md) — `TEXT`: EVENTS.REPLACE
70
+ - [choose.md](../scenario/choose.md) — `CHOOSE`: связка через compatibility выше (`OPTION_BEFORE_REG`)
@@ -0,0 +1,50 @@
1
+ # plugins/views.screens/intro/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.intro` · namespace: `INTRO`
4
+
5
+ Вступительный экран сценария с пропуском по клику, interact или skip.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `SHOW` | `vne:intro:show` | Показать UI или слой. |
12
+ | `HIDE` | `vne:intro:hide` | Скрыть UI или слой. |
13
+ | `CLICK` | `vne:intro:click` | Продвинуть сценарий к следующей строке. |
14
+ | `UPDATE` | `vne:intro:update` | Обновить состояние или отображение. |
15
+ | `SKIP` | `vne:intro:skip` | Продвинуть сценарий к следующей строке. |
16
+ | `INTERACT` | `vne:intro:interact` | Продвинуть сценарий к следующей строке. |
17
+
18
+ ## Константы
19
+
20
+ Нет.
21
+
22
+ ## Параметры
23
+
24
+ | Ключ | Тип | Смысл |
25
+ |------|-----|-------|
26
+ | `BACKGROUND` | `string` | Значение по умолчанию: "BACKGROUND". |
27
+
28
+ ## Настройки
29
+
30
+ Нет.
31
+
32
+ ## Модули
33
+
34
+ | Модуль | Зона ответственности |
35
+ |--------|----------------------|
36
+ | `intro.controller` | Обрабатывает INTERACT, UPDATE, SHOW, HIDE, …. |
37
+ | `intro` | Связь со сценарием: шаг next после завершения действия. |
38
+ | `intro.view` | Подмодуль `view` плагина. |
39
+
40
+ ## Близкие плагины
41
+
42
+ ### plugins/core/
43
+
44
+ - [logs.md](../core/logs.md) — `LOGS`: emitLog
45
+ - [scenario.md](../core/scenario.md) — `SCENARIO`: emitNext, EVENTS.LINE_EXEC_REG, CONST.LINE_KEYWORDS.SKIP_IF_POSSIBLE
46
+ - [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
47
+
48
+ ### Остальные
49
+
50
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.ANY
@@ -0,0 +1,48 @@
1
+ # plugins/views.screens/loading/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.loading` · namespace: `LOADING`
4
+
5
+ Экран загрузки поверх игры на время асинхронных операций с минимальной длительностью.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `SHOW` | `vne:loading:show` | Показать UI или слой. |
12
+ | `HIDE` | `vne:loading:hide` | Скрыть UI или слой. |
13
+ | `EMIT` | `vne:loading:emit` | Записать диагностическое сообщение в лог. |
14
+ | `UPDATE` | `vne:loading:update` | Обновить состояние или отображение. |
15
+
16
+ ## Константы
17
+
18
+ Нет.
19
+
20
+ ## Параметры
21
+
22
+ | Ключ | Тип | Смысл |
23
+ |------|-----|-------|
24
+ | `MIN_SHOW_TIME` | `string` | Значение по умолчанию: "MIN_SHOW_TIME". |
25
+
26
+ ## Настройки
27
+
28
+ Нет.
29
+
30
+ ## Модули
31
+
32
+ | Модуль | Зона ответственности |
33
+ |--------|----------------------|
34
+ | `loading.controller` | Обрабатывает UPDATE, SHOW, HIDE, STARTED, …. |
35
+ | `loading` | Точка входа emit: подготовка и запуск process. |
36
+ | `loading.view` | Подмодуль `view` плагина. |
37
+
38
+ ## Близкие плагины
39
+
40
+ ### plugins/core/
41
+
42
+ - [logs.md](../core/logs.md) — `LOGS`: emitLog
43
+ - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
44
+ - [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
45
+
46
+ ### Остальные
47
+
48
+ — нет
@@ -0,0 +1,61 @@
1
+ # plugins/views.screens/mainmenu/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.mainmenu` · namespace: `MAINMENU`
4
+
5
+ Главное меню с пунктами, сменой фона и предзагрузкой меток сценария.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `HIDE` | `vne:mainmenu:hide` | Скрыть UI или слой. |
12
+ | `SHOW` | `vne:mainmenu:show` | Показать UI или слой. |
13
+ | `ITEMS` | `vne:mainmenu:items` | Событие `ITEMS` namespace плагина. |
14
+ | `CLICK` | `vne:mainmenu:click` | Событие `CLICK` namespace плагина. |
15
+ | `ACCEPT` | `vne:mainmenu:accept` | Событие `ACCEPT` namespace плагина. |
16
+ | `UPDATE` | `vne:mainmenu:update` | Обновить состояние или отображение. |
17
+
18
+ ## Константы
19
+
20
+ Нет.
21
+
22
+ ## Параметры
23
+
24
+ | Ключ | Тип | Смысл |
25
+ |------|-----|-------|
26
+ | `PRELOAD_LABELS` | `string` | Имя метки или стартовой точки. |
27
+ | `PRELOAD_EVENTS` | `string` | Значение по умолчанию: "PRELOAD_EVENTS". |
28
+ | `ITEMS` | `string` | Значение по умолчанию: "ITEMS". |
29
+ | `BACKGROUND` | `string` | Значение по умолчанию: "BACKGROUND". |
30
+ | `BACKGROUNDS` | `string` | Значение по умолчанию: "BACKGROUNDS". |
31
+ | `BACKGROUNDS_INTERVAL` | `string` | Значение по умолчанию: "BACKGROUNDS_INTERVAL". |
32
+ | `TRANSITION` | `string` | Значение по умолчанию: "TRANSITION". |
33
+ | `ZINDEX` | `string` | Значение по умолчанию: "ZINDEX". |
34
+ | `LOC_LABEL` | `string` | Имя метки или стартовой точки. |
35
+ | `VIEW_PROPS` | `string` | Значение по умолчанию: "VIEW_PROPS". |
36
+
37
+ ## Настройки
38
+
39
+ Нет.
40
+
41
+ ## Модули
42
+
43
+ | Модуль | Зона ответственности |
44
+ |--------|----------------------|
45
+ | `mainmenu.controller` | Обрабатывает ACCEPT, UPDATE, SHOW, HIDE, …. |
46
+ | `mainmenu` | Обрабатывает SHOW, HIDE, ITEMS, CLEARED. |
47
+ | `mainmenu.view` | Подмодуль `view` плагина. |
48
+
49
+ ## Близкие плагины
50
+
51
+ ### plugins/core/
52
+
53
+ - [components.md](../core/components.md) — `COMPONENTS`: EVENTS.EXTERNAL_UPDATE
54
+ - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
55
+ - [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.LINE_EXEC_REG, EVENTS.LINE_LOAD_REG, EVENTS.LABEL_GET
56
+ - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
57
+ - [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
58
+
59
+ ### Остальные
60
+
61
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.ARROW_UP, CONST.BUTTONS.ARROW_BOTTOM, CONST.BUTTONS.ACCEPT, CONST.BUTTONS.INTERACT
@@ -0,0 +1,45 @@
1
+ # plugins/views.screens/mainmenu.socials/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.mainmenu.socials` · namespace: `MAINMENU_SOCIALS_VIEW`
4
+
5
+ Блок иконок соцсетей, показываемый вместе с главным меню.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `UPDATE` | `vne:mainmenu_socials:update` | Обновить состояние или отображение. |
12
+
13
+ ## Константы
14
+
15
+ Нет.
16
+
17
+ ## Параметры
18
+
19
+ | Ключ | Тип | Смысл |
20
+ |------|-----|-------|
21
+ | `VIEW_PROPS` | `string` | Значение по умолчанию: "VIEW_PROPS". |
22
+
23
+ ## Настройки
24
+
25
+ Нет.
26
+
27
+ ## Модули
28
+
29
+ | Модуль | Зона ответственности |
30
+ |--------|----------------------|
31
+ | `mainmenu.socials.controller` | Обрабатывает UPDATE, SHOW, HIDE, CLEAR, …. |
32
+ | `mainmenu.socials.view` | Подмодуль `socials.view` плагина. |
33
+
34
+ ## Близкие плагины
35
+
36
+ ### plugins/core/
37
+
38
+ - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
39
+ - [state.md](../core/state.md) — `STATE`: EVENTS.CLEAR, EVENTS.SET
40
+ - [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
41
+
42
+ ### Остальные
43
+
44
+ - [layer.md](../canvas/layer.md) — `LAYER`: SETTINGS.QUALITY
45
+ - [mainmenu.md](./mainmenu.md) — `MAINMENU`: EVENTS.SHOW, EVENTS.HIDE, PARAMS.TRANSITION
@@ -0,0 +1,63 @@
1
+ # plugins/views.screens/save/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.save` · namespace: `SAVE_VIEW`
4
+
5
+ Экран сохранения и загрузки с сеткой слотов и вкладками save/load/autosave.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `SHOW` | `vne:save_view:show` | Показать UI или слой. |
12
+ | `HIDE` | `vne:save_view:hide` | Скрыть UI или слой. |
13
+ | `PAGE_SET` | `vne:save_view:page_set` | Записать или обновить значение. |
14
+ | `TAB_SET` | `vne:save_view:tab_set` | Выбрать вкладку save/load/autosave (`{ tab }`). |
15
+ | `CREATE` | `vne:save_view:create` | Создать слот (`{ key, group }`) → `SAVE.CREATE`. |
16
+ | `DELETE` | `vne:save_view:delete` | Удалить слот (`{ key, group }`) → `SAVE.DELETE`. |
17
+ | `LOAD` | `vne:save_view:load` | Загрузить слот (`{ key, group }`) → `SAVE.PRELOAD` / `SAVE.LOAD`. |
18
+ | `UPDATE` | `vne:save_view:update` | Обновить состояние или отображение. |
19
+ | `PRELOAD` | `vne:save_view:preload` | Событие `PRELOAD` namespace плагина. |
20
+
21
+ ## Константы
22
+
23
+ Нет.
24
+
25
+ ## Параметры
26
+
27
+ | Ключ | Тип | Смысл |
28
+ |------|-----|-------|
29
+ | `BACKGROUND` | `string` | Значение по умолчанию: "BACKGROUND". |
30
+ | `AUDIO_NAME` | `string` | Имя трека на слое `view` при открытии экрана; пустая строка — без overlay-музыки. |
31
+
32
+ ## Настройки
33
+
34
+ Нет.
35
+
36
+ ## Модули
37
+
38
+ | Модуль | Зона ответственности |
39
+ |--------|----------------------|
40
+ | `save.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека. |
41
+ | `save.controller` | Обрабатывает UPDATE, HIDE, LOAD, TAB_SET, …. SHOW принимает `{ tab }`; в `SAVE.*` передаёт `group` (номер страницы или `autosave`). |
42
+ | `save.controller.tabs` | Наследник `ModuleControllerTabs`: TAB_PREV/TAB_NEXT → `TAB_SET`; `getTabKeys` фильтрует SAVE vs LOAD/AUTOSAVE. |
43
+ | `save.controller.load` | Подмодуль `controller.load` плагина. |
44
+ | `save.view` | Подмодуль `view` плагина. |
45
+
46
+ ## Близкие плагины
47
+
48
+ ### plugins/core/
49
+
50
+ - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
51
+ - [scenario.md](../core/scenario.md) — `SCENARIO`: emitNext
52
+ - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, CONST.MIGRATE_STATUS.LINE_NOT_FOUND, CONST.MIGRATE_STATUS.OK
53
+ - [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
54
+ - [vendors.md](../core/vendors.md) — `VENDORS`: EVENTS.DATE
55
+
56
+ ### Остальные
57
+
58
+ - [audio.md](../audio/audio.md) — `AUDIO`: EVENTS.GLOBAL_PAUSE, EVENTS.PLAY, EVENTS.STOP, EVENTS.GLOBAL_RESUME, EVENTS.MEDIA_LOAD
59
+ - [confirm.md](./confirm.md) — `CONFIRM`: EVENTS.EMIT
60
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.BACK, CONST.BUTTONS.MENU, CONST.BUTTONS.GAMEMENU, CONST.BUTTONS.ARROW_UP, CONST.BUTTONS.ARROW_RIGHT, CONST.BUTTONS.ARROW_BOTTOM
61
+ - [loading.md](./loading.md) — `LOADING`: EVENTS.EMIT
62
+ - [locs.md](../text/locs.md) — `LOCS`: EVENTS.GET
63
+ - [save.md](../save/save.md) — `SAVE`: EVENTS.CREATE, EVENTS.DELETE, EVENTS.GET, EVENTS.PRELOAD, EVENTS.LOAD