@vnejs/docs 0.2.46 → 0.2.48

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 (99) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/package.json +1 -1
  3. package/plugins/ai/ai.md +2 -0
  4. package/plugins/ai/checkers.md +2 -0
  5. package/plugins/audio/audio.md +2 -0
  6. package/plugins/canvas/bg.md +2 -0
  7. package/plugins/canvas/bg.speak.md +2 -0
  8. package/plugins/canvas/fill.md +2 -0
  9. package/plugins/canvas/layer.md +2 -0
  10. package/plugins/canvas/sprite.md +2 -0
  11. package/plugins/canvas/sprite.speak.md +2 -0
  12. package/plugins/canvas/text.md +2 -0
  13. package/plugins/canvas/video.md +2 -0
  14. package/plugins/canvas.layers/bl.md +2 -0
  15. package/plugins/canvas.layers/fl.md +2 -0
  16. package/plugins/canvas.layers/ml.md +2 -0
  17. package/plugins/canvas.layers/ul.md +2 -0
  18. package/plugins/canvas.props/animation.md +2 -0
  19. package/plugins/canvas.props/clip.md +2 -0
  20. package/plugins/canvas.props/filters.md +7 -2
  21. package/plugins/canvas.props/mask.md +2 -0
  22. package/plugins/canvas.props/scale.md +2 -0
  23. package/plugins/common/grid.md +2 -0
  24. package/plugins/common/turn.md +2 -0
  25. package/plugins/controls/controls.md +2 -0
  26. package/plugins/controls/cursor.md +2 -0
  27. package/plugins/controls/gamepad.md +2 -0
  28. package/plugins/core/components.md +2 -0
  29. package/plugins/core/interact.md +2 -0
  30. package/plugins/core/logs.md +2 -0
  31. package/plugins/core/media.md +2 -0
  32. package/plugins/core/memory.md +2 -0
  33. package/plugins/core/scenario.md +2 -0
  34. package/plugins/core/settings.md +5 -3
  35. package/plugins/core/stack.md +2 -0
  36. package/plugins/core/state.md +2 -0
  37. package/plugins/core/storage.md +8 -6
  38. package/plugins/core/system.md +14 -12
  39. package/plugins/core/vendors.md +2 -0
  40. package/plugins/entities/wallet.md +2 -0
  41. package/plugins/game/checkers.md +2 -0
  42. package/plugins/platform/electron.md +5 -1
  43. package/plugins/platform/metric.md +2 -0
  44. package/plugins/rpg/damage.md +2 -0
  45. package/plugins/rpg/hit.md +2 -0
  46. package/plugins/rpg/skills.md +2 -0
  47. package/plugins/save/auto.md +2 -0
  48. package/plugins/save/continue.md +2 -0
  49. package/plugins/save/quick.md +2 -0
  50. package/plugins/save/save.md +2 -0
  51. package/plugins/scales/scales.md +2 -0
  52. package/plugins/scenario/autoread.md +2 -0
  53. package/plugins/scenario/choose.md +2 -0
  54. package/plugins/scenario/fastforward.md +2 -0
  55. package/plugins/scenario/history.md +19 -17
  56. package/plugins/scenario/pause.md +10 -8
  57. package/plugins/scenario/point_and_click.md +2 -0
  58. package/plugins/scenario/qte.md +2 -0
  59. package/plugins/settings/potato.md +2 -0
  60. package/plugins/text/inject.md +2 -0
  61. package/plugins/text/locs.md +2 -0
  62. package/plugins/text/meet.md +2 -0
  63. package/plugins/text/smooth.md +2 -0
  64. package/plugins/text/text.md +2 -0
  65. package/plugins/text/wall.md +6 -3
  66. package/plugins/time/date.md +2 -0
  67. package/plugins/time/time.md +2 -0
  68. package/plugins/vars/counters.md +8 -6
  69. package/plugins/vars/flags.md +2 -0
  70. package/plugins/vars/vars.md +2 -0
  71. package/plugins/views/achievement.md +2 -0
  72. package/plugins/views/comment.md +2 -0
  73. package/plugins/views/controls.hints.md +5 -3
  74. package/plugins/views/fps.md +2 -0
  75. package/plugins/views/gamepad.debug.md +2 -0
  76. package/plugins/views/settings.md +2 -0
  77. package/plugins/views/video.md +2 -0
  78. package/plugins/views.scenario/choose.md +2 -0
  79. package/plugins/views.scenario/interface.controls.md +2 -0
  80. package/plugins/views.scenario/interface.fastforward.md +2 -0
  81. package/plugins/views.scenario/interface.md +2 -0
  82. package/plugins/views.scenario/point_and_click.md +2 -0
  83. package/plugins/views.scenario/qte.md +5 -3
  84. package/plugins/views.screens/checkers.md +2 -0
  85. package/plugins/views.screens/confirm.md +2 -0
  86. package/plugins/views.screens/credits.md +9 -7
  87. package/plugins/views.screens/disclaimer.md +2 -0
  88. package/plugins/views.screens/eula.md +2 -0
  89. package/plugins/views.screens/gallery.full.md +2 -0
  90. package/plugins/views.screens/gallery.md +2 -0
  91. package/plugins/views.screens/gamemenu.md +2 -0
  92. package/plugins/views.screens/history.md +23 -21
  93. package/plugins/views.screens/intro.md +2 -0
  94. package/plugins/views.screens/loading.md +2 -0
  95. package/plugins/views.screens/mainmenu.md +2 -0
  96. package/plugins/views.screens/mainmenu.socials.md +2 -0
  97. package/plugins/views.screens/save.md +3 -1
  98. package/plugins/views.screens/settings.defaults.md +2 -0
  99. package/plugins/views.screens/settings.md +2 -0
package/plugins/views.screens/gamemenu.md CHANGED
@@ -6,6 +6,8 @@
6
6
 
7
7
  ## События
8
8
 
9
+ Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.views.screens.gamemenu`.
10
+
9
11
  | Ключ | Строка | Смысл |
10
12
  | -------------- | --------------------------- | -------------------------------------------------- |
11
13
  | `SHOW` | `vne:gamemenu:show` | Показать UI или слой. |
package/plugins/views.screens/history.md CHANGED
@@ -6,15 +6,17 @@
6
6
 
7
7
  ## События
8
8
 
9
- | Ключ | Строка | Смысл |
10
- | -------------- | ------------------------------- | --------------------------------------------------------------------- |
11
- | `HIDE` | `vne:history_view:hide` | Скрыть экран. |
12
- | `SHOW` | `vne:history_view:show` | Показать экран. |
13
- | `CLICK` | `vne:history_view:click` | Клик по строке. Если `uid` есть в ключах журнала — `HISTORY.LOAD`. |
14
- | `UPDATE` | `vne:history_view:update` | Перерисовать view. |
15
- | `STATE_UPDATE` | `vne:history_view:state_update` | Слить partial в стейт контроллера без UPDATE view. |
16
- | `UPDATE_FAST` | `vne:history_view:update_fast` | Перерисовать view с `isFast`, стейт не меняет. |
17
- | `ACCEPT` | `vne:history_view:accept` | `ACCEPT` / `INTERACT` → `CLICK` по `currentArrowVerticalItem`. |
9
+ Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.views.screens.history`.
10
+
11
+ | Ключ | Строка | Смысл |
12
+ | -------------- | ------------------------------- | ------------------------------------------------------------------ |
13
+ | `HIDE` | `vne:history_view:hide` | Скрыть экран. |
14
+ | `SHOW` | `vne:history_view:show` | Показать экран. |
15
+ | `CLICK` | `vne:history_view:click` | Клик по строке. Если `uid` есть в ключах журнала — `HISTORY.LOAD`. |
16
+ | `UPDATE` | `vne:history_view:update` | Перерисовать view. |
17
+ | `STATE_UPDATE` | `vne:history_view:state_update` | Слить partial в стейт контроллера без UPDATE view. |
18
+ | `UPDATE_FAST` | `vne:history_view:update_fast` | Перерисовать view с `isFast`, стейт не меняет. |
19
+ | `ACCEPT` | `vne:history_view:accept` | `ACCEPT` / `INTERACT` → `CLICK` по `currentArrowVerticalItem`. |
18
20
 
19
21
  Строки журнала и шаг назад — `EVENTS.HISTORY.GET` / `KEYS` / `LOAD` / `BACK` / `ADD` (`scenario/history`).
20
22
 
@@ -24,11 +26,11 @@
24
26
 
25
27
  ## Параметры
26
28
 
27
- | Ключ | Тип | Смысл |
28
- | ------------ | -------- | ------------------------------------ |
29
- | `ZINDEX` | `number` | Значение по умолчанию: 2000. |
30
- | `TRANSITION` | `number` | Значение по умолчанию: 300. |
31
- | `LOC_LABEL` | `string` | Метка локализации view (`history`). |
29
+ | Ключ | Тип | Смысл |
30
+ | ------------ | -------- | ------------------------------------------ |
31
+ | `ZINDEX` | `number` | Значение по умолчанию: 2000. |
32
+ | `TRANSITION` | `number` | Значение по умолчанию: 300. |
33
+ | `LOC_LABEL` | `string` | Метка локализации view (`history`). |
32
34
  | `VIEW_PROPS` | `object` | Раскладка экрана, строк и кнопки закрытия. |
33
35
 
34
36
  ## Настройки
@@ -37,14 +39,14 @@
37
39
 
38
40
  ## Модули
39
41
 
40
- | Модуль | Зона ответственности |
41
- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
42
+ | Модуль | Зона ответственности |
43
+ | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
42
44
  | `history.controller` | SHOW/HIDE/CLICK/STATE_UPDATE/UPDATE_FAST; перед SHOW резолвит тексты строк (`TEXT.REPLACE`). Для `locKey` — через `PARAMS.HISTORY_VIEW.LOC_LABEL` (локализация view), иначе через label сценария. Пустой `controls` на `ZINDEX`, чтобы стопорить слои ниже. |
43
- | `history.controller.accept` | Наследует `@vnejs/module.controller.accept`: `ACCEPT` / `INTERACT` → `ACCEPT` → `CLICK` по `currentArrowVerticalItem`; зеркалит `STATE_UPDATE`; PUSH/POP на SHOW/HIDE. |
44
- | `history.controller.arrows` | Наследует `@vnejs/module.controller.arrows.vertical`: `ARROW_UP` / `ARROW_BOTTOM` по записям журнала; PUSH/POP controls на SHOW/HIDE; эмитит `STATE_UPDATE` с `{ currentArrowVerticalItem }` и `UPDATE_FAST`. |
45
- | `history.hide.controls` | Наследует `@vnejs/module.controller.hide.on.controls`: `BACK` / `MENU` / `GAMEMENU` → `HIDE`; PUSH/POP на SHOW/HIDE. |
46
- | `history.hide.state` | Наследует `@vnejs/module.controller.hide.on.state`: `STATE.SET` → `HIDE` с `{ isForce: true }` (`IS_STATE_CLEAR_ENABLED = false`). |
47
- | `history.view` | Подмодуль `view` плагина. |
45
+ | `history.controller.accept` | Наследует `@vnejs/module.controller.accept`: `ACCEPT` / `INTERACT` → `ACCEPT` → `CLICK` по `currentArrowVerticalItem`; зеркалит `STATE_UPDATE`; PUSH/POP на SHOW/HIDE. |
46
+ | `history.controller.arrows` | Наследует `@vnejs/module.controller.arrows.vertical`: `ARROW_UP` / `ARROW_BOTTOM` по записям журнала; PUSH/POP controls на SHOW/HIDE; эмитит `STATE_UPDATE` с `{ currentArrowVerticalItem }` и `UPDATE_FAST`. |
47
+ | `history.hide.controls` | Наследует `@vnejs/module.controller.hide.on.controls`: `BACK` / `MENU` / `GAMEMENU` → `HIDE`; PUSH/POP на SHOW/HIDE. |
48
+ | `history.hide.state` | Наследует `@vnejs/module.controller.hide.on.state`: `STATE.SET` → `HIDE` с `{ isForce: true }` (`IS_STATE_CLEAR_ENABLED = false`). |
49
+ | `history.view` | Подмодуль `view` плагина. |
48
50
 
49
51
  ## Близкие плагины
50
52
 
package/plugins/views.screens/intro.md CHANGED
@@ -6,6 +6,8 @@
6
6
 
7
7
  ## События
8
8
 
9
+ Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.views.screens.intro`.
10
+
9
11
  | Ключ | Строка | Смысл |
10
12
  | -------------- | ------------------------ | --------------------------------------- |
11
13
  | `SHOW` | `vne:intro:show` | Показать UI или слой. |
package/plugins/views.screens/loading.md CHANGED
@@ -6,6 +6,8 @@
6
6
 
7
7
  ## События
8
8
 
9
+ Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.views.screens.loading`.
10
+
9
11
  | Ключ | Строка | Смысл |
10
12
  | -------------- | -------------------------- | ----------------------------------------- |
11
13
  | `SHOW` | `vne:loading:show` | Показать UI или слой. |
package/plugins/views.screens/mainmenu.md CHANGED
@@ -8,6 +8,8 @@
8
8
 
9
9
  ## События
10
10
 
11
+ Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.views.screens.mainmenu`.
12
+
11
13
  | Ключ | Строка | Смысл |
12
14
  | -------------- | --------------------------- | -------------------------------------------------------------------- |
13
15
  | `HIDE` | `vne:mainmenu:hide` | Скрыть UI или слой. |
package/plugins/views.screens/mainmenu.socials.md CHANGED
@@ -6,6 +6,8 @@
6
6
 
7
7
  ## События
8
8
 
9
+ Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.views.screens.mainmenu.socials`.
10
+
9
11
  | Ключ | Строка | Смысл |
10
12
  | -------- | ----------------------------- | ----------------------------------- |
11
13
  | `UPDATE` | `vne:mainmenu_socials:update` | Обновить состояние или отображение. |
package/plugins/views.screens/save.md CHANGED
@@ -8,6 +8,8 @@ ACCEPT/INTERACT повторяет клик по слоту: на вкладке
8
8
 
9
9
  ## События
10
10
 
11
+ Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.views.screens.save`.
12
+
11
13
  | Ключ | Строка | Смысл |
12
14
  | ------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
13
15
  | `SHOW` | `vne:save_view:show` | Показать UI или слой. |
@@ -27,7 +29,7 @@ ACCEPT/INTERACT повторяет клик по слоту: на вкладке
27
29
  | `GRID_PREV` | `vne:save_view:grid_prev` | Край сетки назад; `save.controller.pages` слушает как `EVENT_PAGE_PREV`. |
28
30
  | `GRID_CLEAR` | `vne:save_view:grid_clear` | Сбросить выбор ячейки: `gridRow` / `gridColumn` → `null` (+ `STATE_UPDATE`). |
29
31
  | `GRID_UPDATE_ITEMS` | `vne:save_view:grid_update_items` | Пересобрать сетку из стейта (без payload) → `STATE_UPDATE` `{ gridItems }`. Meta (`gridIndex` / `gridsCount` / `tab`) — заранее через `STATE_UPDATE`. |
30
- | `SLOT_CREATE` | `vne:save_view:slot_create` | Собрать UI-слот (`{ key, group, index }`) → `SAVE.GET` + дата/время; возврат item. |
32
+ | `SLOT_CREATE` | `vne:save_view:slot_create` | Собрать UI-слот → `SAVE.GET` + дата/время; result: `SaveViewSlotCreateResult`. |
31
33
 
32
34
  ## Константы
33
35
 
package/plugins/views.screens/settings.defaults.md CHANGED
@@ -8,6 +8,8 @@ Breaking: раньше namespace был `SETTINGS_DEFAULTS`, события `vne
8
8
 
9
9
  ## События
10
10
 
11
+ Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.views.screens.settings.defaults`.
12
+
11
13
  | Ключ | Строка | Смысл |
12
14
  | -------------- | ---------------------------------------- | --------------------------------------- |
13
15
  | `UPDATE` | `vne:settings_default_view:update` | Обновить состояние или отображение. |
package/plugins/views.screens/settings.md CHANGED
@@ -6,6 +6,8 @@
6
6
 
7
7
  ## События
8
8
 
9
+ Payloads и результаты хендлеров типизированы через module augmentation контракта (`VneEventPayloadMap` / `VneEventResultMap`); типы — в `@vnejs/contracts.views.screens.settings`.
10
+
9
11
  | Ключ | Строка | Смысл |
10
12
  | -------------- | --------------------------------------- | ----------------------------------------------------------------------------------- |
11
13
  | `SHOW` | `vne:settings_screen_view:show` | Показать UI или слой. |