@vnejs/docs 0.2.22 → 0.2.24

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 (193) hide show
  1. package/CHANGELOG.md +5 -0
  2. package/README.md +6 -6
  3. package/architecture.md +75 -75
  4. package/manifest.json +1 -7
  5. package/package.json +1 -1
  6. package/plugins/audio/ambient.md +5 -5
  7. package/plugins/audio/audio.md +26 -26
  8. package/plugins/audio/music.md +5 -5
  9. package/plugins/audio/sound.md +5 -5
  10. package/plugins/audio/voice.md +9 -9
  11. package/plugins/canvas/bg.md +23 -23
  12. package/plugins/canvas/bg.speak.md +19 -19
  13. package/plugins/canvas/fill.md +23 -23
  14. package/plugins/canvas/layer.md +20 -20
  15. package/plugins/canvas/sprite.md +29 -29
  16. package/plugins/canvas/sprite.speak.md +16 -16
  17. package/plugins/canvas/text.md +24 -24
  18. package/plugins/canvas/video.md +22 -22
  19. package/plugins/canvas.layers/bl.md +12 -12
  20. package/plugins/canvas.layers/fl.md +12 -12
  21. package/plugins/canvas.layers/ml.md +12 -12
  22. package/plugins/canvas.layers/ul.md +11 -11
  23. package/plugins/canvas.props/animation.md +10 -10
  24. package/plugins/canvas.props/clip.md +7 -7
  25. package/plugins/canvas.props/filters.md +2 -2
  26. package/plugins/canvas.props/mask.md +8 -8
  27. package/plugins/canvas.props/scale.md +5 -5
  28. package/plugins/controls/controls.md +15 -15
  29. package/plugins/controls/cursor.md +34 -34
  30. package/plugins/controls/gamepad.md +27 -27
  31. package/plugins/controls/keyboard.md +2 -2
  32. package/plugins/core/components.md +10 -10
  33. package/plugins/core/interact.md +12 -12
  34. package/plugins/core/logs.md +10 -10
  35. package/plugins/core/media.md +21 -21
  36. package/plugins/core/memory.md +10 -10
  37. package/plugins/core/platforms.md +11 -11
  38. package/plugins/core/scenario.md +22 -22
  39. package/plugins/core/settings.md +9 -9
  40. package/plugins/core/stack.md +18 -18
  41. package/plugins/core/state.md +13 -13
  42. package/plugins/core/storage.md +29 -29
  43. package/plugins/core/system.md +24 -24
  44. package/plugins/core/vendors.md +6 -6
  45. package/plugins/entities/wallet.md +11 -11
  46. package/plugins/platform/android.md +2 -2
  47. package/plugins/platform/electron.md +2 -2
  48. package/plugins/platform/metric.md +7 -7
  49. package/plugins/rpg/damage.md +7 -7
  50. package/plugins/rpg/hit.md +8 -8
  51. package/plugins/rpg/skills.md +11 -11
  52. package/plugins/save/auto.md +11 -11
  53. package/plugins/save/continue.md +8 -8
  54. package/plugins/save/save.md +23 -23
  55. package/plugins/scales/health.md +2 -2
  56. package/plugins/scales/mana.md +2 -2
  57. package/plugins/scales/scales.md +15 -15
  58. package/plugins/scenario/autoread.md +14 -14
  59. package/plugins/scenario/choose.md +36 -36
  60. package/plugins/scenario/fastforward.md +34 -34
  61. package/plugins/scenario/pause.md +6 -6
  62. package/plugins/scenario/point_and_click.md +30 -30
  63. package/plugins/scenario/qte.md +16 -16
  64. package/plugins/scenario/random.md +3 -3
  65. package/plugins/settings/filter.md +5 -5
  66. package/plugins/settings/potato.md +6 -6
  67. package/plugins/settings/ratio.md +4 -4
  68. package/plugins/settings/textsize.md +5 -5
  69. package/plugins/settings/volume.md +7 -7
  70. package/plugins/text/inject.md +7 -7
  71. package/plugins/text/locs.md +13 -13
  72. package/plugins/text/meet.md +4 -4
  73. package/plugins/text/smooth.md +18 -18
  74. package/plugins/text/text.md +41 -41
  75. package/plugins/text/wall.md +4 -4
  76. package/plugins/time/date.md +6 -6
  77. package/plugins/time/time.md +7 -7
  78. package/plugins/vars/counters.md +12 -12
  79. package/plugins/vars/flags.md +10 -10
  80. package/plugins/vars/vars.md +16 -16
  81. package/plugins/views/achievement.md +26 -26
  82. package/plugins/views/comment.md +13 -13
  83. package/plugins/views/controls.hints.md +12 -12
  84. package/plugins/views/cursor.md +3 -3
  85. package/plugins/views/fps.md +13 -13
  86. package/plugins/views/gamepad.debug.md +16 -16
  87. package/plugins/views/settings.md +22 -22
  88. package/plugins/views/video.md +18 -18
  89. package/plugins/views.scenario/choose.md +21 -21
  90. package/plugins/views.scenario/interface.controls.md +13 -13
  91. package/plugins/views.scenario/interface.fastforward.md +11 -11
  92. package/plugins/views.scenario/interface.md +29 -29
  93. package/plugins/views.scenario/point_and_click.md +15 -15
  94. package/plugins/views.scenario/qte.md +25 -25
  95. package/plugins/views.screens/confirm.md +20 -20
  96. package/plugins/views.screens/credits.md +14 -14
  97. package/plugins/views.screens/disclaimer.md +20 -20
  98. package/plugins/views.screens/eula.md +21 -21
  99. package/plugins/views.screens/gallery.full.md +10 -10
  100. package/plugins/views.screens/gallery.md +30 -30
  101. package/plugins/views.screens/gamemenu.md +21 -21
  102. package/plugins/views.screens/history.md +26 -26
  103. package/plugins/views.screens/intro.md +14 -14
  104. package/plugins/views.screens/loading.md +13 -13
  105. package/plugins/views.screens/mainmenu.md +33 -33
  106. package/plugins/views.screens/mainmenu.socials.md +7 -7
  107. package/plugins/views.screens/save.md +21 -21
  108. package/plugins/views.screens/settings.defaults.md +14 -14
  109. package/plugins/views.screens/settings.md +16 -16
  110. package/scenario.catalog/index.md +69 -69
  111. package/scenario.catalog/stubs/achievement.md +6 -6
  112. package/scenario.catalog/stubs/audio.ambient.md +6 -6
  113. package/scenario.catalog/stubs/audio.music.md +6 -6
  114. package/scenario.catalog/stubs/audio.sound.md +6 -6
  115. package/scenario.catalog/stubs/audio.voice.md +6 -6
  116. package/scenario.catalog/stubs/bl.animation.md +6 -6
  117. package/scenario.catalog/stubs/bl.bg.md +6 -6
  118. package/scenario.catalog/stubs/bl.clip.md +6 -6
  119. package/scenario.catalog/stubs/bl.fill.md +6 -6
  120. package/scenario.catalog/stubs/bl.filter.md +6 -6
  121. package/scenario.catalog/stubs/bl.mask.md +6 -6
  122. package/scenario.catalog/stubs/bl.scale.md +6 -6
  123. package/scenario.catalog/stubs/bl.sprite.md +6 -6
  124. package/scenario.catalog/stubs/bl.text.md +6 -6
  125. package/scenario.catalog/stubs/bl.video.md +6 -6
  126. package/scenario.catalog/stubs/choose.block.md +4 -4
  127. package/scenario.catalog/stubs/choose.md +5 -5
  128. package/scenario.catalog/stubs/choose.option.md +4 -4
  129. package/scenario.catalog/stubs/comment.md +6 -6
  130. package/scenario.catalog/stubs/counter.md +5 -5
  131. package/scenario.catalog/stubs/credits.md +6 -6
  132. package/scenario.catalog/stubs/date.md +6 -6
  133. package/scenario.catalog/stubs/disclaimer.md +6 -6
  134. package/scenario.catalog/stubs/fl.animation.md +6 -6
  135. package/scenario.catalog/stubs/fl.bg.md +6 -6
  136. package/scenario.catalog/stubs/fl.clip.md +6 -6
  137. package/scenario.catalog/stubs/fl.fill.md +6 -6
  138. package/scenario.catalog/stubs/fl.filter.md +6 -6
  139. package/scenario.catalog/stubs/fl.mask.md +6 -6
  140. package/scenario.catalog/stubs/fl.scale.md +6 -6
  141. package/scenario.catalog/stubs/fl.sprite.md +6 -6
  142. package/scenario.catalog/stubs/fl.text.md +6 -6
  143. package/scenario.catalog/stubs/fl.video.md +6 -6
  144. package/scenario.catalog/stubs/flag.md +7 -7
  145. package/scenario.catalog/stubs/interface.md +6 -6
  146. package/scenario.catalog/stubs/intro.md +6 -6
  147. package/scenario.catalog/stubs/mainmenu.md +6 -6
  148. package/scenario.catalog/stubs/ml.animation.md +6 -6
  149. package/scenario.catalog/stubs/ml.bg.md +6 -6
  150. package/scenario.catalog/stubs/ml.clip.md +6 -6
  151. package/scenario.catalog/stubs/ml.fill.md +6 -6
  152. package/scenario.catalog/stubs/ml.filter.md +6 -6
  153. package/scenario.catalog/stubs/ml.mask.md +6 -6
  154. package/scenario.catalog/stubs/ml.scale.md +6 -6
  155. package/scenario.catalog/stubs/ml.sprite.md +6 -6
  156. package/scenario.catalog/stubs/ml.text.md +6 -6
  157. package/scenario.catalog/stubs/ml.video.md +6 -6
  158. package/scenario.catalog/stubs/other.md +6 -6
  159. package/scenario.catalog/stubs/pause.md +6 -6
  160. package/scenario.catalog/stubs/point-and-click.block.md +4 -4
  161. package/scenario.catalog/stubs/point-and-click.md +5 -5
  162. package/scenario.catalog/stubs/point-and-click.option.md +4 -4
  163. package/scenario.catalog/stubs/qte.md +6 -6
  164. package/scenario.catalog/stubs/random.md +6 -6
  165. package/scenario.catalog/stubs/random.option.md +6 -6
  166. package/scenario.catalog/stubs/save.auto.md +6 -6
  167. package/scenario.catalog/stubs/save.md +6 -6
  168. package/scenario.catalog/stubs/scenario.md +6 -6
  169. package/scenario.catalog/stubs/settings.defaults.md +6 -6
  170. package/scenario.catalog/stubs/stack.md +6 -6
  171. package/scenario.catalog/stubs/text.meet.md +6 -6
  172. package/scenario.catalog/stubs/text.wall.md +6 -6
  173. package/scenario.catalog/stubs/time.md +6 -6
  174. package/scenario.catalog/stubs/ul.animation.md +6 -6
  175. package/scenario.catalog/stubs/ul.bg.md +6 -6
  176. package/scenario.catalog/stubs/ul.clip.md +6 -6
  177. package/scenario.catalog/stubs/ul.fill.md +6 -6
  178. package/scenario.catalog/stubs/ul.filter.md +6 -6
  179. package/scenario.catalog/stubs/ul.mask.md +6 -6
  180. package/scenario.catalog/stubs/ul.scale.md +6 -6
  181. package/scenario.catalog/stubs/ul.sprite.md +6 -6
  182. package/scenario.catalog/stubs/ul.text.md +6 -6
  183. package/scenario.catalog/stubs/video.md +6 -6
  184. package/scenario.catalog/stubs/wallet.md +6 -6
  185. package/scenario.guide/README.md +21 -21
  186. package/scenario.guide/audio.md +6 -6
  187. package/scenario.guide/canvas.md +13 -13
  188. package/scenario.guide/choose.md +5 -5
  189. package/scenario.guide/flow.md +10 -10
  190. package/scenario.guide/point-and-click.md +5 -5
  191. package/scenario.guide/qte-random.md +4 -4
  192. package/scenario.guide/vars.md +6 -6
  193. package/scenario.guide/views.md +12 -12
@@ -6,12 +6,12 @@
6
6
 
7
7
  ## События
8
8
 
9
- | Ключ | Строка | Смысл |
10
- |------|--------|-------|
11
- | `EMIT` | `vne:skills:emit` | Инициировать действие или цикл. |
12
- | `EMIT_START` | `vne:skills:emit_start` | Начать процесс. |
13
- | `EMIT_FINISH` | `vne:skills:emit_finish` | Инициировать действие или цикл. |
14
- | `CHECK` | `vne:skills:check` | Проверить состояние или наличие ресурса. |
9
+ | Ключ | Строка | Смысл |
10
+ | ------------- | ------------------------ | ---------------------------------------- |
11
+ | `EMIT` | `vne:skills:emit` | Инициировать действие или цикл. |
12
+ | `EMIT_START` | `vne:skills:emit_start` | Начать процесс. |
13
+ | `EMIT_FINISH` | `vne:skills:emit_finish` | Инициировать действие или цикл. |
14
+ | `CHECK` | `vne:skills:check` | Проверить состояние или наличие ресурса. |
15
15
 
16
16
  Payload `EMIT`: `{ id?, caster?, target? }`. Lifecycle (`EMIT_START` / `EMIT_FINISH`): `{ skillId?, caster?, target? }`. `caster` — кто применяет навык, `target` — цель.
17
17
 
@@ -21,10 +21,10 @@ Payload `EMIT`: `{ id?, caster?, target? }`. Lifecycle (`EMIT_START` / `EMIT_FIN
21
21
 
22
22
  ## Параметры
23
23
 
24
- | Ключ | Тип | Смысл |
25
- |------|-----|-------|
24
+ | Ключ | Тип | Смысл |
25
+ | ------- | -------- | ----------------------------------- |
26
26
  | `TYPES` | `string` | Виды навыков (`damage`, `heal`, …). |
27
- | `ITEMS` | `object` | Параметр `ITEMS`. |
27
+ | `ITEMS` | `object` | Параметр `ITEMS`. |
28
28
 
29
29
  ## Настройки
30
30
 
@@ -32,8 +32,8 @@ Payload `EMIT`: `{ id?, caster?, target? }`. Lifecycle (`EMIT_START` / `EMIT_FIN
32
32
 
33
33
  ## Модули
34
34
 
35
- | Модуль | Зона ответственности |
36
- |--------|----------------------|
35
+ | Модуль | Зона ответственности |
36
+ | -------- | ------------------------------------------- |
37
37
  | `skills` | Обрабатывает EMIT, EMIT_START, EMIT_FINISH. |
38
38
 
39
39
  ## Близкие плагины
@@ -6,33 +6,33 @@
6
6
 
7
7
  ## События
8
8
 
9
- | Ключ | Строка | Смысл |
10
- |------|--------|-------|
9
+ | Ключ | Строка | Смысл |
10
+ | ------ | ------------------- | --------------------------------- |
11
11
  | `MAKE` | `vne:autosave:make` | Событие `MAKE` namespace плагина. |
12
12
 
13
13
  ## Константы
14
14
 
15
- | Ключ | Смысл |
16
- |------|--------|
15
+ | Ключ | Смысл |
16
+ | ------------ | ------------------------------------------------------------------------------------------------ |
17
17
  | `SAVE_GROUP` | Storage group для автосохранений (`"autosave"`); доступ через `this.CONST.SAVE_AUTO.SAVE_GROUP`. |
18
18
 
19
19
  ## Параметры
20
20
 
21
- | Ключ | Тип | Смысл |
22
- |------|-----|-------|
21
+ | Ключ | Тип | Смысл |
22
+ | ------------------ | -------- | --------------------------- |
23
23
  | `DEFAULT_INTERVAL` | `number` | Значение по умолчанию: 300. |
24
- | `MAX_INDEX` | `number` | Значение по умолчанию: 9. |
24
+ | `MAX_INDEX` | `number` | Значение по умолчанию: 9. |
25
25
 
26
26
  ## Настройки
27
27
 
28
- | Ключ | Тип | Смысл |
29
- |------|-----|-------|
28
+ | Ключ | Тип | Смысл |
29
+ | ------------------------------------ | -------- | ------------------------------------------------------ |
30
30
  | `INTERVAL` (`vne:autosave:interval`) | `string` | Настройка `vne:autosave:interval` в `shared.settings`. |
31
31
 
32
32
  ## Модули
33
33
 
34
- | Модуль | Зона ответственности |
35
- |--------|----------------------|
34
+ | Модуль | Зона ответственности |
35
+ | ----------- | -------------------------------------------------------------- |
36
36
  | `save.auto` | Подмодуль `auto` плагина; `SAVE.CREATE` с `group: "autosave"`. |
37
37
 
38
38
  ## Близкие плагины
@@ -6,16 +6,16 @@
6
6
 
7
7
  ## События
8
8
 
9
- | Ключ | Строка | Смысл |
10
- |------|--------|-------|
11
- | `MAKE` | `vne:save_continue:make` | Событие `MAKE` namespace плагина. |
12
- | `LOAD` | `vne:save_continue:load` | Загрузить данные или ресурс. |
9
+ | Ключ | Строка | Смысл |
10
+ | --------- | --------------------------- | ------------------------------------ |
11
+ | `MAKE` | `vne:save_continue:make` | Событие `MAKE` namespace плагина. |
12
+ | `LOAD` | `vne:save_continue:load` | Загрузить данные или ресурс. |
13
13
  | `PRELOAD` | `vne:save_continue:preload` | Событие `PRELOAD` namespace плагина. |
14
14
 
15
15
  ## Константы
16
16
 
17
- | Ключ | Смысл |
18
- |------|--------|
17
+ | Ключ | Смысл |
18
+ | ------------ | ---------------------------------------------------------------------------------------------------- |
19
19
  | `SAVE_GROUP` | Storage group для слота continue (`"continue"`); доступ через `this.CONST.SAVE_CONTINUE.SAVE_GROUP`. |
20
20
 
21
21
  ## Параметры
@@ -28,8 +28,8 @@
28
28
 
29
29
  ## Модули
30
30
 
31
- | Модуль | Зона ответственности |
32
- |--------|----------------------|
31
+ | Модуль | Зона ответственности |
32
+ | --------------- | ---------------------------------------------------------------------- |
33
33
  | `save.continue` | Обрабатывает MAKE, LOAD, PRELOAD; слот в `SAVE` с `group: "continue"`. |
34
34
 
35
35
  ## Близкие плагины
@@ -6,16 +6,16 @@
6
6
 
7
7
  ## События
8
8
 
9
- | Ключ | Строка | Смысл |
10
- |------|--------|-------|
11
- | `GET` | `vne:save:get` | Прочитать слот (`{ key, group? }`) из `STORAGE`. |
12
- | `CLEAR` | `vne:save:clear` | Удалить все слоты модуля `save` в `STORAGE`. |
13
- | `DELETE` | `vne:save:delete` | Удалить слот (`{ key, group? }`). |
14
- | `CREATE` | `vne:save:create` | Создать слот (`{ key, group?, withScreenshot? }`). |
15
- | `KEY` | `vne:save:key` | Событие `KEY` namespace плагина. |
16
- | `SCREENSHOT` | `vne:save:screenshot` | Сделать скриншот для слота. |
17
- | `LOAD` | `vne:save:load` | Загрузить слот в `STATE` (`{ key, group? }`). |
18
- | `PRELOAD` | `vne:save:preload` | Предзагрузить слот (`{ key, group? }`). |
9
+ | Ключ | Строка | Смысл |
10
+ | ------------ | --------------------- | -------------------------------------------------- |
11
+ | `GET` | `vne:save:get` | Прочитать слот (`{ key, group? }`) из `STORAGE`. |
12
+ | `CLEAR` | `vne:save:clear` | Удалить все слоты модуля `save` в `STORAGE`. |
13
+ | `DELETE` | `vne:save:delete` | Удалить слот (`{ key, group? }`). |
14
+ | `CREATE` | `vne:save:create` | Создать слот (`{ key, group?, withScreenshot? }`). |
15
+ | `KEY` | `vne:save:key` | Событие `KEY` namespace плагина. |
16
+ | `SCREENSHOT` | `vne:save:screenshot` | Сделать скриншот для слота. |
17
+ | `LOAD` | `vne:save:load` | Загрузить слот в `STATE` (`{ key, group? }`). |
18
+ | `PRELOAD` | `vne:save:preload` | Предзагрузить слот (`{ key, group? }`). |
19
19
 
20
20
  ## Константы
21
21
 
@@ -23,11 +23,11 @@
23
23
 
24
24
  ## Параметры
25
25
 
26
- | Ключ | Тип | Смысл |
27
- |------|-----|-------|
28
- | `SCREENSHOT_QUALITY` | `number` | Значение по умолчанию: 0.5. |
29
- | `SCREENSHOT_WIDTH` | `number` | Значение по умолчанию: 1280. |
30
- | `SCREENSHOT_HEIGHT` | `number` | Значение по умолчанию: 720. |
26
+ | Ключ | Тип | Смысл |
27
+ | -------------------- | -------- | ---------------------------- |
28
+ | `SCREENSHOT_QUALITY` | `number` | Значение по умолчанию: 0.5. |
29
+ | `SCREENSHOT_WIDTH` | `number` | Значение по умолчанию: 1280. |
30
+ | `SCREENSHOT_HEIGHT` | `number` | Значение по умолчанию: 720. |
31
31
 
32
32
  События `GET` / `CREATE` / `DELETE` / `LOAD` / `PRELOAD` принимают опциональный `group` и пробрасывают его в `STORAGE`. Конкретные группы задают вызывающие плагины (номер страницы в save view, `autosave`, `continue`).
33
33
 
@@ -37,14 +37,14 @@
37
37
 
38
38
  ## Модули
39
39
 
40
- | Модуль | Зона ответственности |
41
- |--------|----------------------|
42
- | `save.exec` | Подмодуль `exec` плагина. |
43
- | `save.key` | Обрабатывает KEY, SET, CLEAR. |
44
- | `save.load` | Обрабатывает LOAD, PRELOAD. |
45
- | `save.logs` | Обрабатывает GET, KEY, CLEAR, CREATE, …. |
46
- | `save` | Обрабатывает GET, CLEAR, DELETE, CREATE. |
47
- | `save.screen` | Подмодуль `screen` плагина. |
40
+ | Модуль | Зона ответственности |
41
+ | ------------- | ---------------------------------------- |
42
+ | `save.exec` | Подмодуль `exec` плагина. |
43
+ | `save.key` | Обрабатывает KEY, SET, CLEAR. |
44
+ | `save.load` | Обрабатывает LOAD, PRELOAD. |
45
+ | `save.logs` | Обрабатывает GET, KEY, CLEAR, CREATE, …. |
46
+ | `save` | Обрабатывает GET, CLEAR, DELETE, CREATE. |
47
+ | `save.screen` | Подмодуль `screen` плагина. |
48
48
 
49
49
  ## Близкие плагины
50
50
 
@@ -22,8 +22,8 @@
22
22
 
23
23
  ## Модули
24
24
 
25
- | Модуль | Зона ответственности |
26
- |--------|----------------------|
25
+ | Модуль | Зона ответственности |
26
+ | --------------- | --------------------------- |
27
27
  | `scales.health` | Подмодуль `health` плагина. |
28
28
 
29
29
  ## Близкие плагины
@@ -22,8 +22,8 @@
22
22
 
23
23
  ## Модули
24
24
 
25
- | Модуль | Зона ответственности |
26
- |--------|----------------------|
25
+ | Модуль | Зона ответственности |
26
+ | ------------- | ------------------------- |
27
27
  | `scales.mana` | Подмодуль `mana` плагина. |
28
28
 
29
29
  ## Близкие плагины
@@ -6,17 +6,17 @@
6
6
 
7
7
  ## События
8
8
 
9
- | Ключ | Строка | Смысл |
10
- |------|--------|-------|
11
- | `SPAWN` | `vne:scales:spawn` | Событие `SPAWN` namespace плагина. |
12
- | `DESTROY` | `vne:scales:destroy` | Событие `DESTROY` namespace плагина. |
13
- | `SET` | `vne:scales:set` | Записать или обновить значение. |
14
- | `RESET` | `vne:scales:reset` | Событие `RESET` namespace плагина. |
15
- | `CHANGE` | `vne:scales:change` | Событие `CHANGE` namespace плагина. |
16
- | `CHANGED` | `vne:scales:changed` | Зафиксировать изменение состояния. |
17
- | `CHECK` | `vne:scales:check` | Проверить состояние или наличие ресурса. |
18
- | `OVERFLOW` | `vne:scales:overflow` | Событие `OVERFLOW` namespace плагина. |
19
- | `UNDERFLOW` | `vne:scales:underflow` | Событие `UNDERFLOW` namespace плагина. |
9
+ | Ключ | Строка | Смысл |
10
+ | ----------- | ---------------------- | ---------------------------------------- |
11
+ | `SPAWN` | `vne:scales:spawn` | Событие `SPAWN` namespace плагина. |
12
+ | `DESTROY` | `vne:scales:destroy` | Событие `DESTROY` namespace плагина. |
13
+ | `SET` | `vne:scales:set` | Записать или обновить значение. |
14
+ | `RESET` | `vne:scales:reset` | Событие `RESET` namespace плагина. |
15
+ | `CHANGE` | `vne:scales:change` | Событие `CHANGE` namespace плагина. |
16
+ | `CHANGED` | `vne:scales:changed` | Зафиксировать изменение состояния. |
17
+ | `CHECK` | `vne:scales:check` | Проверить состояние или наличие ресурса. |
18
+ | `OVERFLOW` | `vne:scales:overflow` | Событие `OVERFLOW` namespace плагина. |
19
+ | `UNDERFLOW` | `vne:scales:underflow` | Событие `UNDERFLOW` namespace плагина. |
20
20
 
21
21
  ## Константы
22
22
 
@@ -24,8 +24,8 @@
24
24
 
25
25
  ## Параметры
26
26
 
27
- | Ключ | Тип | Смысл |
28
- |------|-----|-------|
27
+ | Ключ | Тип | Смысл |
28
+ | ------- | -------- | ------------------------------------------------------------------- |
29
29
  | `TYPES` | `string` | Виды шкал (`health`, `mana`, …), расширяются дочерними контрактами. |
30
30
 
31
31
  ## Ключи
@@ -38,8 +38,8 @@
38
38
 
39
39
  ## Модули
40
40
 
41
- | Модуль | Зона ответственности |
42
- |--------|----------------------|
41
+ | Модуль | Зона ответственности |
42
+ | -------- | ---------------------------------------------- |
43
43
  | `scales` | Обрабатывает SPAWN, DESTROY, RESET, CHANGE, …. |
44
44
 
45
45
  ## Близкие плагины
@@ -6,11 +6,11 @@
6
6
 
7
7
  ## События
8
8
 
9
- | Ключ | Строка | Смысл |
10
- |------|--------|-------|
11
- | `TRY` | `vne:autoread:try` | Записать диагностическое сообщение в лог. |
12
- | `PUSH` | `vne:autoread:push` | Добавить элемент в очередь или стек. |
13
- | `POP` | `vne:autoread:pop` | Извлечь элемент из очереди или стека. |
9
+ | Ключ | Строка | Смысл |
10
+ | ------ | ------------------- | ----------------------------------------- |
11
+ | `TRY` | `vne:autoread:try` | Записать диагностическое сообщение в лог. |
12
+ | `PUSH` | `vne:autoread:push` | Добавить элемент в очередь или стек. |
13
+ | `POP` | `vne:autoread:pop` | Извлечь элемент из очереди или стека. |
14
14
 
15
15
  ## Константы
16
16
 
@@ -18,22 +18,22 @@
18
18
 
19
19
  ## Параметры
20
20
 
21
- | Ключ | Тип | Смысл |
22
- |------|-----|-------|
23
- | `DEFAULT_DELAY` | `number` | Значение по умолчанию: 5000. |
21
+ | Ключ | Тип | Смысл |
22
+ | ----------------- | --------- | -------------------------------------------- |
23
+ | `DEFAULT_DELAY` | `number` | Значение по умолчанию: 5000. |
24
24
  | `DEFAULT_ENABLED` | `boolean` | Значение по умолчанию для включения функции. |
25
25
 
26
26
  ## Настройки
27
27
 
28
- | Ключ | Тип | Смысл |
29
- |------|-----|-------|
30
- | `ENABLED` (`vne:autoread:enabled`) | `boolean` | Включить или выключить функцию. |
31
- | `DELAY` (`vne:autoread:delay`) | `number` | Настройка `vne:autoread:delay` в `shared.settings`. |
28
+ | Ключ | Тип | Смысл |
29
+ | ---------------------------------- | --------- | --------------------------------------------------- |
30
+ | `ENABLED` (`vne:autoread:enabled`) | `boolean` | Включить или выключить функцию. |
31
+ | `DELAY` (`vne:autoread:delay`) | `number` | Настройка `vne:autoread:delay` в `shared.settings`. |
32
32
 
33
33
  ## Модули
34
34
 
35
- | Модуль | Зона ответственности |
36
- |--------|----------------------|
35
+ | Модуль | Зона ответственности |
36
+ | ---------- | ---------------------------------------- |
37
37
  | `autoread` | Обрабатывает TRY, PUSH, POP, CHANGED, …. |
38
38
 
39
39
  ## Близкие плагины
@@ -6,11 +6,11 @@
6
6
 
7
7
  ## Сценарные команды
8
8
 
9
- | Синтаксис | Смысл |
10
- |-----------|--------|
11
- | `% choose` | Открыть выбор: собрать `% choose.option`, emit `EMIT`. Если все опции `hided` (или список пуст) — `SKIP` и переход за блок. |
12
- | `% choose.option "…"` | Ветка опции; при проходе мимо невыбранной — skip тела по indent. |
13
- | `$ choose repeat` | Вернуться к ближайшему `% choose` **выше** текущей строки в том же label и `emitNext`. |
9
+ | Синтаксис | Смысл |
10
+ | --------------------- | --------------------------------------------------------------------------------------------------------------------------- |
11
+ | `% choose` | Открыть выбор: собрать `% choose.option`, emit `EMIT`. Если все опции `hided` (или список пуст) — `SKIP` и переход за блок. |
12
+ | `% choose.option "…"` | Ветка опции; при проходе мимо невыбранной — skip тела по indent. |
13
+ | `$ choose repeat` | Вернуться к ближайшему `% choose` **выше** текущей строки в том же label и `emitNext`. |
14
14
 
15
15
  Пример цикла «осмотреть → вернуться в меню»:
16
16
 
@@ -26,27 +26,27 @@
26
26
 
27
27
  ## События
28
28
 
29
- | Ключ | Строка | Смысл |
30
- |------|--------|-------|
31
- | `EMIT` | `vne:choose:emit` | Принять опции и args; если есть видимые — `STATE_UPDATE` и `SHOW`; иначе `SKIP`. |
32
- | `OPTION` | `vne:choose:option` | Принять выбор по UI-индексу: прогнать `OPTION_BEFORE`, затем `HIDE`, `OPTION_REPLACE`, установить `curLine`, сброс state, `emitNext`. |
33
- | `OPTION_BEFORE` | `vne:choose:option_before` | Side effects до применения выбора (handlers с приоритетами; `ModuleHandlers`). |
34
- | `OPTION_BEFORE_REG` | `vne:choose:option_before_reg` | Зарегистрировать обработчик `OPTION_BEFORE`. |
35
- | `OPTION_REPLACE` | `vne:choose:option_replace` | Подменить UI-индекс принятой опции (цепочка handlers перед переходом по ветке). |
36
- | `OPTION_REPLACE_REG` | `vne:choose:option_replace_reg` | Зарегистрировать обработчик `OPTION_REPLACE`. |
37
- | `SKIP` | `vne:choose:skip` | Пропустить блок: `curLine` на первую строку после indent-дерева `% choose`, `emitNext`. |
38
- | `SHOW` | `vne:choose:show` | Выбор активен (state готов). Слушает view-плагин. |
39
- | `HIDE` | `vne:choose:hide` | Выбор закрыт. Слушает view-плагин. |
40
- | `EXEC_REG` | `vne:choose:exec_reg` | Зарегистрировать exec-обработчик для подстановки в опции. |
41
- | `EXEC_GET` | `vne:choose:exec_get` | Получить значение через зарегистрированный exec-обработчик. |
42
- | `STATE_UPDATE` | `vne:choose:state_update` | Обновить накопленное состояние модуля `choose`. |
29
+ | Ключ | Строка | Смысл |
30
+ | -------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
31
+ | `EMIT` | `vne:choose:emit` | Принять опции и args; если есть видимые — `STATE_UPDATE` и `SHOW`; иначе `SKIP`. |
32
+ | `OPTION` | `vne:choose:option` | Принять выбор по UI-индексу: прогнать `OPTION_BEFORE`, затем `HIDE`, `OPTION_REPLACE`, установить `curLine`, сброс state, `emitNext`. |
33
+ | `OPTION_BEFORE` | `vne:choose:option_before` | Side effects до применения выбора (handlers с приоритетами; `ModuleHandlers`). |
34
+ | `OPTION_BEFORE_REG` | `vne:choose:option_before_reg` | Зарегистрировать обработчик `OPTION_BEFORE`. |
35
+ | `OPTION_REPLACE` | `vne:choose:option_replace` | Подменить UI-индекс принятой опции (цепочка handlers перед переходом по ветке). |
36
+ | `OPTION_REPLACE_REG` | `vne:choose:option_replace_reg` | Зарегистрировать обработчик `OPTION_REPLACE`. |
37
+ | `SKIP` | `vne:choose:skip` | Пропустить блок: `curLine` на первую строку после indent-дерева `% choose`, `emitNext`. |
38
+ | `SHOW` | `vne:choose:show` | Выбор активен (state готов). Слушает view-плагин. |
39
+ | `HIDE` | `vne:choose:hide` | Выбор закрыт. Слушает view-плагин. |
40
+ | `EXEC_REG` | `vne:choose:exec_reg` | Зарегистрировать exec-обработчик для подстановки в опции. |
41
+ | `EXEC_GET` | `vne:choose:exec_get` | Получить значение через зарегистрированный exec-обработчик. |
42
+ | `STATE_UPDATE` | `vne:choose:state_update` | Обновить накопленное состояние модуля `choose`. |
43
43
 
44
44
  ## Константы
45
45
 
46
- | Ключ | Смысл |
47
- |------|--------|
48
- | `EXEC_ACTIONS.REPEAT` | Литерал `repeat` для `$ choose repeat`. |
49
- | `LOGS_ACTIONS` | Метки для логов: `EMIT`, `OPTION`, `SKIP`, `SHOW`, `HIDE`, `REPEAT`. |
46
+ | Ключ | Смысл |
47
+ | --------------------- | -------------------------------------------------------------------- |
48
+ | `EXEC_ACTIONS.REPEAT` | Литерал `repeat` для `$ choose repeat`. |
49
+ | `LOGS_ACTIONS` | Метки для логов: `EMIT`, `OPTION`, `SKIP`, `SHOW`, `HIDE`, `REPEAT`. |
50
50
 
51
51
  ## Параметры
52
52
 
@@ -58,19 +58,19 @@
58
58
 
59
59
  ## Модули
60
60
 
61
- | Модуль | Зона ответственности |
62
- |--------|----------------------|
63
- | `choose` | State: `STATE_UPDATE`, синхронизация с `STATE.SET` / `STATE.CLEAR` (→ `SHOW` / `HIDE`). |
64
- | `choose.emit` | Обрабатывает `EMIT` (→ `STATE_UPDATE` + `SHOW` или `SKIP`). |
65
- | `choose.option` | Обрабатывает `OPTION`. |
66
- | `choose.skip` | Обрабатывает `SKIP`. |
67
- | `choose.logs` | Логирование `EMIT` / `OPTION` / `SKIP` / `SHOW` / `HIDE`. |
68
- | `choose.option_before` | Реестр обработчиков `OPTION_BEFORE_REG`; наследник `@vnejs/module.handlers`. |
69
- | `choose.replace` | Реестр обработчиков `OPTION_REPLACE_REG`; наследник `@vnejs/module.replace`. |
70
- | `choose.exec` | Реестр обработчиков EXEC_REG / EXEC_GET. |
71
- | `choose.scenario` | Регистрация `% choose`: сбор option-строк, emit `EMIT`. |
72
- | `choose.scenario.option` | Регистрация `% choose.option`: skip невыбранных веток. |
73
- | `choose.scenario.module` | Регистрация `$ choose`: action `repeat`. |
61
+ | Модуль | Зона ответственности |
62
+ | ------------------------ | --------------------------------------------------------------------------------------- |
63
+ | `choose` | State: `STATE_UPDATE`, синхронизация с `STATE.SET` / `STATE.CLEAR` (→ `SHOW` / `HIDE`). |
64
+ | `choose.emit` | Обрабатывает `EMIT` (→ `STATE_UPDATE` + `SHOW` или `SKIP`). |
65
+ | `choose.option` | Обрабатывает `OPTION`. |
66
+ | `choose.skip` | Обрабатывает `SKIP`. |
67
+ | `choose.logs` | Логирование `EMIT` / `OPTION` / `SKIP` / `SHOW` / `HIDE`. |
68
+ | `choose.option_before` | Реестр обработчиков `OPTION_BEFORE_REG`; наследник `@vnejs/module.handlers`. |
69
+ | `choose.replace` | Реестр обработчиков `OPTION_REPLACE_REG`; наследник `@vnejs/module.replace`. |
70
+ | `choose.exec` | Реестр обработчиков EXEC_REG / EXEC_GET. |
71
+ | `choose.scenario` | Регистрация `% choose`: сбор option-строк, emit `EMIT`. |
72
+ | `choose.scenario.option` | Регистрация `% choose.option`: skip невыбранных веток. |
73
+ | `choose.scenario.module` | Регистрация `$ choose`: action `repeat`. |
74
74
 
75
75
  ## Compatibility
76
76
 
@@ -6,56 +6,56 @@
6
6
 
7
7
  ## События
8
8
 
9
- | Ключ | Строка | Смысл |
10
- |------|--------|-------|
11
- | `STOP` | `vne:fastforward:stop` | Остановить воспроизведение. |
12
- | `START` | `vne:fastforward:start` | Начать процесс. |
13
- | `TOGGLE` | `vne:fastforward:toggle` | Событие `TOGGLE` namespace плагина. |
14
- | `EMIT` | `vne:fastforward:emit` | Инициировать действие или цикл. |
15
- | `EMIT_CHECK` | `vne:fastforward:emit_check` | Инициировать действие или цикл. |
16
- | `CHECK` | `vne:fastforward:check` | Проверить состояние или наличие ресурса. |
17
- | `CHANGED` | `vne:fastforward:changed` | Зафиксировать изменение состояния. |
18
- | `VISIT_ADD` | `vne:fastforward:visit_add` | Записать визит: `shared.fastforwardStorage` + стейт и `STORAGE.SET`. Payload: `key`, `group`, поля `SCENARIO.EXEC`. |
19
- | `CLEAR` | `vne:fastforward:clear` | Очистить накопленное состояние. |
9
+ | Ключ | Строка | Смысл |
10
+ | ------------ | ---------------------------- | ------------------------------------------------------------------------------------------------------------------- |
11
+ | `STOP` | `vne:fastforward:stop` | Остановить воспроизведение. |
12
+ | `START` | `vne:fastforward:start` | Начать процесс. |
13
+ | `TOGGLE` | `vne:fastforward:toggle` | Событие `TOGGLE` namespace плагина. |
14
+ | `EMIT` | `vne:fastforward:emit` | Инициировать действие или цикл. |
15
+ | `EMIT_CHECK` | `vne:fastforward:emit_check` | Инициировать действие или цикл. |
16
+ | `CHECK` | `vne:fastforward:check` | Проверить состояние или наличие ресурса. |
17
+ | `CHANGED` | `vne:fastforward:changed` | Зафиксировать изменение состояния. |
18
+ | `VISIT_ADD` | `vne:fastforward:visit_add` | Записать визит: `shared.fastforwardStorage` + стейт и `STORAGE.SET`. Payload: `key`, `group`, поля `SCENARIO.EXEC`. |
19
+ | `CLEAR` | `vne:fastforward:clear` | Очистить накопленное состояние. |
20
20
 
21
21
  ## Константы
22
22
 
23
- | Ключ | Смысл |
24
- |------|--------|
23
+ | Ключ | Смысл |
24
+ | -------- | ------------------------------------------------------ |
25
25
  | `SOURCE` | `"fastforward"` — ключ в SourcesSet соседних плагинов. |
26
26
 
27
27
  ## Параметры
28
28
 
29
- | Ключ | Тип | Смысл |
30
- |------|-----|-------|
31
- | `DEFAULT_CHECK_VISITED` | `boolean` | Значение по умолчанию: true. |
32
- | `DEFAULT_DELAY` | `number` | Значение по умолчанию: 50. |
33
- | `DEFAULT_ENABLED` | `boolean` | Значение по умолчанию для включения функции. |
29
+ | Ключ | Тип | Смысл |
30
+ | ----------------------- | --------- | -------------------------------------------- |
31
+ | `DEFAULT_CHECK_VISITED` | `boolean` | Значение по умолчанию: true. |
32
+ | `DEFAULT_DELAY` | `number` | Значение по умолчанию: 50. |
33
+ | `DEFAULT_ENABLED` | `boolean` | Значение по умолчанию для включения функции. |
34
34
 
35
35
  ## Настройки
36
36
 
37
- | Ключ | Тип | Смысл |
38
- |------|-----|-------|
39
- | `CHECK_VISITED` (`vne:fastforward:check_visited`) | `string` | Настройка `vne:fastforward:check_visited` в `shared.settings`. |
40
- | `DELAY` (`vne:fastforward:delay`) | `number` | Настройка `vne:fastforward:delay` в `shared.settings`. |
41
- | `ENABLED` (`vne:fastforward:enabled`) | `boolean` | Включить или выключить функцию. |
37
+ | Ключ | Тип | Смысл |
38
+ | ------------------------------------------------- | --------- | -------------------------------------------------------------- |
39
+ | `CHECK_VISITED` (`vne:fastforward:check_visited`) | `string` | Настройка `vne:fastforward:check_visited` в `shared.settings`. |
40
+ | `DELAY` (`vne:fastforward:delay`) | `number` | Настройка `vne:fastforward:delay` в `shared.settings`. |
41
+ | `ENABLED` (`vne:fastforward:enabled`) | `boolean` | Включить или выключить функцию. |
42
42
 
43
43
  ## Shared
44
44
 
45
- | Поле | Тип | Смысл |
46
- |------|-----|--------|
47
- | `isFastforwardOn` | `boolean` | Режим прокрутки включён. В `init` модуля `fastforward` сбрасывается через `setValue(false)`; дальше — `START` / `STOP` / `TOGGLE`. |
48
- | `fastforwardStorage` | `Set<string>` | Хеши уже просмотренных строк; наполняется из `STORAGE` в `init` модуля `fastforward.storage`. |
45
+ | Поле | Тип | Смысл |
46
+ | -------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
47
+ | `isFastforwardOn` | `boolean` | Режим прокрутки включён. В `init` модуля `fastforward` сбрасывается через `setValue(false)`; дальше — `START` / `STOP` / `TOGGLE`. |
48
+ | `fastforwardStorage` | `Set<string>` | Хеши уже просмотренных строк; наполняется из `STORAGE` в `init` модуля `fastforward.storage`. |
49
49
 
50
50
  ## Модули
51
51
 
52
- | Модуль | Зона ответственности |
53
- |--------|----------------------|
54
- | `fastforward` | `STOP`, `START`, `CHECK`, `TOGGLE`; в `init` — `setValue(false)`. |
55
- | `fastforward.emit` | Цикл `EMIT` / `EMIT_CHECK`: `CHECK` → `INTERACT.EMIT`; провал `CHECK` → `STOP`. |
56
- | `fastforward.scenario` | `SCENARIO.EXEC` → hash стейта `fastforward.visits` и `VISIT_ADD`. |
57
- | `fastforward.visits` | `VISIT_ADD` пишет в `shared.fastforwardStorage` и снимок стейта. `CHECK` читает Set. |
58
- | `fastforward.storage` | `VISIT_ADD` → `STORAGE.SET` с `module` = `this.name`. `GET_ALL` / `RM_ALL` / `CLEAR`. `group` = label, `key` = hash; при init hash берётся из хвоста ключа. На диске: `fastforward.storage/{label}.json`. |
52
+ | Модуль | Зона ответственности |
53
+ | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
54
+ | `fastforward` | `STOP`, `START`, `CHECK`, `TOGGLE`; в `init` — `setValue(false)`. |
55
+ | `fastforward.emit` | Цикл `EMIT` / `EMIT_CHECK`: `CHECK` → `INTERACT.EMIT`; провал `CHECK` → `STOP`. |
56
+ | `fastforward.scenario` | `SCENARIO.EXEC` → hash стейта `fastforward.visits` и `VISIT_ADD`. |
57
+ | `fastforward.visits` | `VISIT_ADD` пишет в `shared.fastforwardStorage` и снимок стейта. `CHECK` читает Set. |
58
+ | `fastforward.storage` | `VISIT_ADD` → `STORAGE.SET` с `module` = `this.name`. `GET_ALL` / `RM_ALL` / `CLEAR`. `group` = label, `key` = hash; при init hash берётся из хвоста ключа. На диске: `fastforward.storage/{label}.json`. |
59
59
 
60
60
  ## Близкие плагины
61
61
 
@@ -6,10 +6,10 @@
6
6
 
7
7
  ## События
8
8
 
9
- | Ключ | Строка | Смысл |
10
- |------|--------|-------|
11
- | `START` | `vne:pause:start` | Продвинуть сценарий к следующей строке. |
12
- | `END` | `vne:pause:end` | Записать диагностическое сообщение в лог. |
9
+ | Ключ | Строка | Смысл |
10
+ | ------- | ----------------- | ----------------------------------------- |
11
+ | `START` | `vne:pause:start` | Продвинуть сценарий к следующей строке. |
12
+ | `END` | `vne:pause:end` | Записать диагностическое сообщение в лог. |
13
13
 
14
14
  ## Константы
15
15
 
@@ -25,8 +25,8 @@
25
25
 
26
26
  ## Модули
27
27
 
28
- | Модуль | Зона ответственности |
29
- |--------|----------------------|
28
+ | Модуль | Зона ответственности |
29
+ | ------- | ------------------------------- |
30
30
  | `pause` | Обрабатывает END, START, CLEAR. |
31
31
 
32
32
  ## Близкие плагины