@vnejs/docs 0.2.24 → 0.2.25

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 (15) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/package.json +1 -1
  3. package/plugins/canvas/video.md +1 -1
  4. package/plugins/controls/cursor.md +8 -8
  5. package/plugins/platform/metric.md +3 -3
  6. package/plugins/scales/health.md +3 -3
  7. package/plugins/scales/mana.md +3 -3
  8. package/plugins/scenario/choose.md +1 -1
  9. package/plugins/scenario/point_and_click.md +4 -4
  10. package/plugins/text/locs.md +4 -4
  11. package/plugins/text/text.md +1 -1
  12. package/plugins/views.scenario/qte.md +2 -2
  13. package/plugins/views.screens/gamemenu.md +7 -7
  14. package/plugins/views.screens/settings.defaults.md +6 -6
  15. package/plugins/views.screens/settings.md +7 -7
package/CHANGELOG.md CHANGED
@@ -2,6 +2,13 @@
2
2
 
3
3
  Краткая история изменений движка (плагины, helpers, packages, CLI и прочий runtime) и внешнего API. Версии — релизы пакета `@vnejs/docs`.
4
4
 
5
+ ## 0.2.25
6
+
7
+ - `module.components` — `updateEvent` → `EVENT_UPDATE_VIEW`; у `ModuleView`: `locLabel` → `LOC_LABEL`, `animationTime` → `TRANSITION`, `updateHandler` по умолчанию `onUpdateStoreComponent`; у `ModuleController`: `bgName` → `BGNAME`, `controls` / `controlsIndex` / `controlsCheckNext` → `CONTROLS` / `CONTROLS_INDEX` / `CONTROLS_CHECK_NEXT` (плюс `CONTROLS_UNVISIBLE` у interface). То же поле `CONTROLS` у accept / hide.on.controls / arrows / tabs.
8
+ - `module.controller.audio` — `SHOW_EVENT` / `HIDE_EVENT` / `LOAD_EVENT` → `EVENT_SHOW` / `EVENT_HIDE` / `EVENT_LOAD`.
9
+ - Имена модулей приведены к slug `PLUGIN_NAME`: `gamemenu.*`, `point_and_click.*` (не дефис), `metric`, `locs`, `scale_health` / `scale_mana`, `settings.screen.*`, `settings.default.*`, `choose.option.before`, `text.emit.before`, `cursor.view.set`, `layer.video.src.get`. Сценарные команды (`% point-and-click`, `$ settings.defaults`) не менялись; `$ settings.defaults` регистрируется через `execName`.
10
+ - Классы модулей = CamelCase от `name` (сегменты `.` `_` `-`): `GamemenuControllerAccept`, `CursorViewSet`, `Metric`, `Locs`, `SettingsScreenView`; compatibility — `CompatibilityTextWithAudioVoice`. Не `GameMenu*` / `YaMetrika` / `TextLocs`. Если имя совпадает с глобальным конструктором — суффикс `Module`: `DateModule`, `TextModule`, `CommentModule`, `HistoryModule`, `StorageModule` (не `Date` / `Text` / `Comment` / `History` / `Storage`).
11
+
5
12
  ## 0.2.23
6
13
 
7
14
  - `cli/desktop`, `cli/tools` — Fastify `~5.12.3` (security 5.12.2+). API не меняется.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vnejs/docs",
3
- "version": "0.2.24",
3
+ "version": "0.2.25",
4
4
  "description": "VNEJS documentation for engine consumers and coding agents",
5
5
  "files": [
6
6
  "*.md",
package/plugins/canvas/video.md CHANGED
@@ -52,7 +52,7 @@ $ bl.video show {logo} … then bg {castle/surgery_room} …
52
52
  | `layer.video.hide` | Подмодуль `video.hide` плагина. |
53
53
  | `layer.video.change` | Подмодуль `video.change` плагина. |
54
54
  | `layer.video.state` | Обрабатывает STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
55
- | `layer.video.src_get` | Подмодуль `video.src_get` плагина. |
55
+ | `layer.video.src.get` | Подмодуль `video.src.get` плагина. |
56
56
  | `layer.video.preload` | Подмодуль `video.preload` плагина. |
57
57
 
58
58
  ## Близкие плагины
package/plugins/controls/cursor.md CHANGED
@@ -46,14 +46,14 @@
46
46
 
47
47
  ## Модули
48
48
 
49
- | Модуль | Зона ответственности |
50
- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
51
- | `cursor` (`Cursor`) | SET_X_Y, resize; владеет `globalState.cursor` (x/y). |
52
- | `cursor.view_set` (`CursorView`) | VIEW_SET + STATE/STARTED для проставления `view`. Имя `view_set`, чтобы не пересечься с `plugins/views/cursor` (`cursor.view`). |
53
- | `cursor.move` (`CursorMove`) | MOVE (мышь) → `CONTROLS.DEVICE_SET` (keyboard) + SHOW + SET_X_Y; скрывает системный курсор. |
54
- | `cursor.shift` (`CursorShift`) | SHIFT + INIT `SHIFT_SPEED` / `SHIFT_REVERSE_*`. |
55
- | `cursor.click` (`CursorClick`) | CLICK по координатам курсора. |
56
- | `cursor.scroll` (`CursorScroll`) | SCROLL + INIT `SCROLL_SPEED`. |
49
+ | Модуль | Зона ответственности |
50
+ | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
51
+ | `cursor` (`Cursor`) | SET_X_Y, resize; владеет `globalState.cursor` (x/y). |
52
+ | `cursor.view.set` (`CursorViewSet`) | VIEW_SET + STATE/STARTED для проставления `view`. Имя `view.set`, чтобы не пересечься с `plugins/views/cursor` (`cursor.view`). |
53
+ | `cursor.move` (`CursorMove`) | MOVE (мышь) → `CONTROLS.DEVICE_SET` (keyboard) + SHOW + SET_X_Y; скрывает системный курсор. |
54
+ | `cursor.shift` (`CursorShift`) | SHIFT + INIT `SHIFT_SPEED` / `SHIFT_REVERSE_*`. |
55
+ | `cursor.click` (`CursorClick`) | CLICK по координатам курсора. |
56
+ | `cursor.scroll` (`CursorScroll`) | SCROLL + INIT `SCROLL_SPEED`. |
57
57
 
58
58
  ## Близкие плагины
59
59
 
package/plugins/platform/metric.md CHANGED
@@ -27,9 +27,9 @@
27
27
 
28
28
  ## Модули
29
29
 
30
- | Модуль | Зона ответственности |
31
- | ------------ | -------------------------------- |
32
- | `ya-metrika` | Обрабатывает EMIT, GOAL, PARAMS. |
30
+ | Модуль | Зона ответственности |
31
+ | -------- | -------------------------------- |
32
+ | `metric` | Обрабатывает EMIT, GOAL, PARAMS. |
33
33
 
34
34
  ## Близкие плагины
35
35
 
package/plugins/scales/health.md CHANGED
@@ -22,9 +22,9 @@
22
22
 
23
23
  ## Модули
24
24
 
25
- | Модуль | Зона ответственности |
26
- | --------------- | --------------------------- |
27
- | `scales.health` | Подмодуль `health` плагина. |
25
+ | Модуль | Зона ответственности |
26
+ | -------------- | --------------------------- |
27
+ | `scale_health` | Подмодуль `health` плагина. |
28
28
 
29
29
  ## Близкие плагины
30
30
 
package/plugins/scales/mana.md CHANGED
@@ -22,9 +22,9 @@
22
22
 
23
23
  ## Модули
24
24
 
25
- | Модуль | Зона ответственности |
26
- | ------------- | ------------------------- |
27
- | `scales.mana` | Подмодуль `mana` плагина. |
25
+ | Модуль | Зона ответственности |
26
+ | ------------ | ------------------------- |
27
+ | `scale_mana` | Подмодуль `mana` плагина. |
28
28
 
29
29
  ## Близкие плагины
30
30
 
package/plugins/scenario/choose.md CHANGED
@@ -65,7 +65,7 @@
65
65
  | `choose.option` | Обрабатывает `OPTION`. |
66
66
  | `choose.skip` | Обрабатывает `SKIP`. |
67
67
  | `choose.logs` | Логирование `EMIT` / `OPTION` / `SKIP` / `SHOW` / `HIDE`. |
68
- | `choose.option_before` | Реестр обработчиков `OPTION_BEFORE_REG`; наследник `@vnejs/module.handlers`. |
68
+ | `choose.option.before` | Реестр обработчиков `OPTION_BEFORE_REG`; наследник `@vnejs/module.handlers`. |
69
69
  | `choose.replace` | Реестр обработчиков `OPTION_REPLACE_REG`; наследник `@vnejs/module.replace`. |
70
70
  | `choose.exec` | Реестр обработчиков EXEC_REG / EXEC_GET. |
71
71
  | `choose.scenario` | Регистрация `% choose`: сбор option-строк, emit `EMIT`. |
package/plugins/scenario/point_and_click.md CHANGED
@@ -61,10 +61,10 @@
61
61
  | `point_and_click.option` | Обрабатывает `OPTION`. |
62
62
  | `point_and_click.skip` | Обрабатывает `SKIP`. |
63
63
  | `point_and_click.logs` | Логирование `EMIT` / `OPTION` / `SKIP` / `SHOW` / `HIDE`. |
64
- | `point-and-click.exec` | Реестр обработчиков EXEC_REG / EXEC_GET. |
65
- | `point-and-click.scenario` | Регистрация `% point-and-click`: сбор option-строк, emit `EMIT`. |
66
- | `point-and-click.scenario.option` | Регистрация `% point-and-click.option`: skip невыбранных веток. |
67
- | `point-and-click.scenario.module` | Регистрация `$ point-and-click`: action `repeat`. |
64
+ | `point_and_click.exec` | Реестр обработчиков EXEC_REG / EXEC_GET. |
65
+ | `point_and_click.scenario` | Регистрация `% point-and-click`: сбор option-строк, emit `EMIT`. |
66
+ | `point_and_click.scenario.option` | Регистрация `% point-and-click.option`: skip невыбранных веток. |
67
+ | `point_and_click.scenario.module` | Регистрация `$ point-and-click`: action `repeat`. |
68
68
 
69
69
  ## Compatibility
70
70
 
package/plugins/text/locs.md CHANGED
@@ -25,7 +25,7 @@
25
25
  | `DEFAULT_LANG` | `string` | Значение по умолчанию: "ru". |
26
26
  | `GROUPS` | `object` | `VIEWS: "views"`, `LABELS: "labels"` — папки после `{lang}/`. |
27
27
 
28
- `LOCS.GET` / `LOCS.LOAD` требуют `group`. `TEXT.REPLACE` без `group` в locs-handler подставляет `GROUPS.LABELS`. View-inject (`locLabel`) берёт `GROUPS.VIEWS`.
28
+ `LOCS.GET` / `LOCS.LOAD` требуют `group`. `TEXT.REPLACE` без `group` в locs-handler подставляет `GROUPS.LABELS`. View-inject (`LOC_LABEL`) берёт `GROUPS.VIEWS`.
29
29
 
30
30
  ## Настройки
31
31
 
@@ -35,9 +35,9 @@
35
35
 
36
36
  ## Модули
37
37
 
38
- | Модуль | Зона ответственности |
39
- | ----------- | -------------------------------- |
40
- | `text.locs` | Обрабатывает LOAD, GET, CHANGED. |
38
+ | Модуль | Зона ответственности |
39
+ | ------ | -------------------------------- |
40
+ | `locs` | Обрабатывает LOAD, GET, CHANGED. |
41
41
 
42
42
  ## Близкие плагины
43
43
 
package/plugins/text/text.md CHANGED
@@ -50,7 +50,7 @@
50
50
 
51
51
  | Модуль | Зона ответственности |
52
52
  | ---------------------- | ------------------------------------------------------ |
53
- | `text.emit_before` | Подмодуль `emit_before` плагина. |
53
+ | `text.emit.before` | Подмодуль `emit.before` плагина. |
54
54
  | `text.emit.end` | Завершение emit и переход к next или финальному state. |
55
55
  | `text.emit.next` | Подмодуль `emit.next` плагина. |
56
56
  | `text.emit` | Точка входа emit: подготовка и запуск process. |
package/plugins/views.scenario/qte.md CHANGED
@@ -44,7 +44,7 @@ React-UI Quick Time Event: фазы анимации, зона успеха в
44
44
  | Модуль | Зона ответственности |
45
45
  | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
46
46
  | `qte_view.controller` | Bridge `QTE.OPENED/CLOSED` → `SHOW/HIDE`; фазы `initial → intro → active → resolved → outro`; таймер fail; controls ACCEPT/INTERACT; emit `QTE.RESULT`. |
47
- | `qte_view.view` | React-render круга / зоны / указателя; `locLabel` для статусов. |
47
+ | `qte_view.view` | React-render круга / зоны / указателя; `LOC_LABEL` для статусов. |
48
48
 
49
49
  ## Фазы
50
50
 
@@ -102,4 +102,4 @@ sequenceDiagram
102
102
 
103
103
  - [controls.md](../controls/controls.md) — `CONTROLS`: ACCEPT, INTERACT
104
104
  - [interface.md](interface.md) — compatibility скрывает interface на `QTE_VIEW.SHOW_BEFORE`
105
- - [locs.md](../text/locs.md) — тексты статуса через `locLabel`
105
+ - [locs.md](../text/locs.md) — тексты статуса через `LOC_LABEL`
package/plugins/views.screens/gamemenu.md CHANGED
@@ -38,13 +38,13 @@
38
38
 
39
39
  | Модуль | Зона ответственности |
40
40
  | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
41
- | `gameMenu.controller` | Обрабатывает UPDATE, HIDE, SHOW, STATE_UPDATE, UPDATE_FAST, …. Пустой `controls` на `ZINDEX`, чтобы стопорить слои ниже. |
42
- | `gameMenu.controller.accept` | Наследует `@vnejs/module.controller.accept`: `ACCEPT` / `INTERACT` → `ACCEPT` → `CLICK` по `currentArrowVerticalItem`; зеркалит `STATE_UPDATE`; PUSH/POP на SHOW/HIDE. |
43
- | `gameMenu.controller.arrows` | Наследует `@vnejs/module.controller.arrows.vertical`: `ARROW_UP` / `ARROW_BOTTOM` по видимым пунктам; PUSH/POP controls на SHOW/HIDE; эмитит `STATE_UPDATE` с `{ currentArrowVerticalItem }` и `UPDATE_FAST`. |
44
- | `gameMenu.hide.controls` | Наследует `@vnejs/module.controller.hide.on.controls`: `BACK` / `MENU` / `GAMEMENU` → `HIDE`; PUSH/POP на SHOW/HIDE. |
45
- | `gameMenu.hide.state` | Наследует `@vnejs/module.controller.hide.on.state`: `STATE.SET` / `STATE.CLEAR` → `HIDE` с `{ isForce: true }`. |
46
- | `gameMenu` | Модуль `gameMenu`. |
47
- | `gameMenu.view` | Подмодуль `view` плагина. |
41
+ | `gamemenu.controller` | Обрабатывает UPDATE, HIDE, SHOW, STATE_UPDATE, UPDATE_FAST, …. Пустой `controls` на `ZINDEX`, чтобы стопорить слои ниже. |
42
+ | `gamemenu.controller.accept` | Наследует `@vnejs/module.controller.accept`: `ACCEPT` / `INTERACT` → `ACCEPT` → `CLICK` по `currentArrowVerticalItem`; зеркалит `STATE_UPDATE`; PUSH/POP на SHOW/HIDE. |
43
+ | `gamemenu.controller.arrows` | Наследует `@vnejs/module.controller.arrows.vertical`: `ARROW_UP` / `ARROW_BOTTOM` по видимым пунктам; PUSH/POP controls на SHOW/HIDE; эмитит `STATE_UPDATE` с `{ currentArrowVerticalItem }` и `UPDATE_FAST`. |
44
+ | `gamemenu.hide.controls` | Наследует `@vnejs/module.controller.hide.on.controls`: `BACK` / `MENU` / `GAMEMENU` → `HIDE`; PUSH/POP на SHOW/HIDE. |
45
+ | `gamemenu.hide.state` | Наследует `@vnejs/module.controller.hide.on.state`: `STATE.SET` / `STATE.CLEAR` → `HIDE` с `{ isForce: true }`. |
46
+ | `gamemenu` | Модуль `gamemenu`. |
47
+ | `gamemenu.view` | Подмодуль `view` плагина. |
48
48
 
49
49
  ## Близкие плагины
50
50
 
package/plugins/views.screens/settings.defaults.md CHANGED
@@ -35,12 +35,12 @@ Breaking: раньше namespace был `SETTINGS_DEFAULTS`, события `vne
35
35
 
36
36
  ## Модули
37
37
 
38
- | Модуль | Зона ответственности |
39
- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
40
- | `settings.defaults.controller` | SHOW/HIDE; связка с `SETTINGS_VIEW`. |
41
- | `settings.defaults.controller.accept` | Наследует `@vnejs/module.controller.accept`: только `ACCEPT` (`IS_INTERACT_ENABLED = false`) → `CONFIRM` → `INITED`, `HIDE`, `emitNext`; PUSH/POP на SHOW/HIDE. |
42
- | `settings.defaults` | Сценарий: `LINE_EXEC` → `SHOW`, либо `emitNext` при `skip_if_possible` и `INITED`. |
43
- | `settings.defaults.view` | Chrome: title + кнопка Accept. |
38
+ | Модуль | Зона ответственности |
39
+ | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
40
+ | `settings.default.controller` | SHOW/HIDE; связка с `SETTINGS_VIEW`. |
41
+ | `settings.default.controller.accept` | Наследует `@vnejs/module.controller.accept`: только `ACCEPT` (`IS_INTERACT_ENABLED = false`) → `CONFIRM` → `INITED`, `HIDE`, `emitNext`; PUSH/POP на SHOW/HIDE. |
42
+ | `settings.default` | Сценарий: `LINE_EXEC` как `$ settings.defaults` (`execName`) → `SHOW`, либо `emitNext` при `skip_if_possible` и `INITED`. |
43
+ | `settings.default.view` | Chrome: title + кнопка Accept. |
44
44
 
45
45
  ## Близкие плагины
46
46
 
package/plugins/views.screens/settings.md CHANGED
@@ -36,13 +36,13 @@
36
36
 
37
37
  ## Модули
38
38
 
39
- | Модуль | Зона ответственности |
40
- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
41
- | `settings.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека; `VOLUME_SETTING = MUSIC.VOLUME`; SHOW передаёт в `AUDIO.PLAY` уже посчитанный `volume`; при `VOLUME_CHANGED` / смене `VOLUME_SETTING` — повторный `AUDIO.VOLUME`. |
42
- | `settings.controller` | SHOW/HIDE/TAB_SET; связка с `SETTINGS_VIEW`. Пустой `controls` на `ZINDEX`, чтобы стопорить слои ниже. |
43
- | `settings.hide.controls` | Наследует `@vnejs/module.controller.hide.on.controls`: `BACK` / `MENU` / `GAMEMENU` → `HIDE`; PUSH/POP на SHOW/HIDE. |
44
- | `settings.controller.tabs` | Наследник `ModuleControllerTabs`: TAB_PREV/TAB_NEXT → `TAB_SET`; `getTabKeys` по `showInSettings`. |
45
- | `settings.view` | Chrome экрана (Screen, tabs, cross); поля и example text — в `SETTINGS_VIEW`. |
39
+ | Модуль | Зона ответственности |
40
+ | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
41
+ | `settings.screen.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека; `VOLUME_SETTING = MUSIC.VOLUME`; SHOW передаёт в `AUDIO.PLAY` уже посчитанный `volume`; при `VOLUME_CHANGED` / смене `VOLUME_SETTING` — повторный `AUDIO.VOLUME`. |
42
+ | `settings.screen.controller` | SHOW/HIDE/TAB_SET; связка с `SETTINGS_VIEW`. Пустой `controls` на `ZINDEX`, чтобы стопорить слои ниже. |
43
+ | `settings.screen.hide.controls` | Наследует `@vnejs/module.controller.hide.on.controls`: `BACK` / `MENU` / `GAMEMENU` → `HIDE`; PUSH/POP на SHOW/HIDE. |
44
+ | `settings.screen.controller.tabs` | Наследник `ModuleControllerTabs`: TAB_PREV/TAB_NEXT → `TAB_SET`; `getTabKeys` по `showInSettings`. |
45
+ | `settings.screen.view` | Chrome экрана (Screen, tabs, cross); поля и example text — в `SETTINGS_VIEW`. |
46
46
 
47
47
  ## Близкие плагины
48
48