@vnejs/docs 0.2.2 → 0.2.4

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 (6) hide show
  1. package/package.json +1 -1
  2. package/plugins/core/scenario.md +10 -3
  3. package/plugins/platform/electron.md +2 -1
  4. package/plugins/views/settings.md +54 -0
  5. package/plugins/views.screens/settings.defaults.md +15 -10
  6. package/plugins/views.screens/settings.md +19 -13
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vnejs/docs",
3
- "version": "0.2.2",
3
+ "version": "0.2.4",
4
4
  "description": "VNEJS documentation for engine consumers and coding agents",
5
5
  "files": [
6
6
  "*.md",
package/plugins/core/scenario.md CHANGED
@@ -35,13 +35,20 @@
35
35
 
36
36
  Нет.
37
37
 
38
+ ## Shared
39
+
40
+ | Поле | Тип | Смысл |
41
+ |------|-----|--------|
42
+ | `shouldAutostartScenario` | `boolean` | На `SYSTEM.STARTED` модуль `scenario.autostart` эмитит `LABEL_GET` (init) и `NEXT`, только если не `false`. В `init` ставится `true` через `??=`; другие плагины могут выставить `false`. `STATE.CLEAR` по-прежнему грузит init label в `scenario.label` без этого гейта. |
43
+
38
44
  ## Модули
39
45
 
40
46
  | Модуль | Зона ответственности |
41
47
  |--------|----------------------|
42
- | `scenario` | Главный цикл `NEXT`, exec строк, sync state, старт на `SYSTEM.STARTED`. |
48
+ | `scenario` | Главный цикл `NEXT`, exec строк, sync state. |
49
+ | `scenario.autostart` | Дефолт `shared.shouldAutostartScenario`; на `SYSTEM.STARTED` — init label + `emitNext` при включённом флаге. |
43
50
  | `scenario.exec` | Dispatch `$module` / `%block`, registry handlers, `EXEC_DELAY`. |
44
- | `scenario.label` | `LABEL_GET`, preload меток, init label на старте/clear. |
51
+ | `scenario.label` | `LABEL_GET`, preload меток; init label на `STATE.CLEAR`. |
45
52
  | `scenario.line` | `LINE_LOAD` / `LINE_GET`, registry preload handlers. |
46
53
  | `scenario.lines` | Fetch `label.*.json` с `HOST`. |
47
54
 
@@ -60,4 +67,4 @@
60
67
 
61
68
  ### Остальные
62
69
 
63
- — нет
70
+ - [electron.md](../platform/electron.md) — `ELECTRON`: при reload выставляет `shared.shouldAutostartScenario = false`
package/plugins/platform/electron.md CHANGED
@@ -24,13 +24,14 @@
24
24
 
25
25
  | Модуль | Зона ответственности |
26
26
  |--------|----------------------|
27
- | `electron` | Обрабатывает CHANGED, STARTED, CLOSE_BEFORE. |
27
+ | `electron` | Синхронизирует remote storage; при изменении и cooldown ≥ 10 с (метка в `sessionStorage`) ставит `shouldReload` + `shared.shouldAutostartScenario = false`; на `STARTED` эмитит `RELOAD`; обрабатывает CHANGED / CLOSE_BEFORE. |
28
28
 
29
29
  ## Близкие плагины
30
30
 
31
31
  ### plugins/core/
32
32
 
33
33
  - [platforms.md](../core/platforms.md) — `PLATFORMS`: CONST.ELECTRON, PARAMS.CURRENT_PLATFORM
34
+ - [scenario.md](../core/scenario.md) — `SCENARIO`: `shared.shouldAutostartScenario` (отключает автостарт перед reload)
34
35
  - [storage.md](../core/storage.md) — `STORAGE`: EVENTS.CHANGED, EVENTS.SET_ALL, EVENTS.GET_ALL
35
36
  - [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED, EVENTS.CLOSE_BEFORE, EVENTS.RELOAD, CONST.HOST
36
37
  - [vendors.md](../core/vendors.md) — `VENDORS`: EVENTS.DEBOUNCE
package/plugins/views/settings.md ADDED
@@ -0,0 +1,54 @@
1
+ # plugins/views/settings/
2
+
3
+ Пакет: `@vnejs/plugins.views.settings` · namespace: `SETTINGS_VIEW`
4
+
5
+ Слой списка полей настроек: рендер `<Settings />` и клавиатурная навигация по полям. Экраны (`SETTINGS_SCREEN_VIEW`, `SETTINGS_DEFAULT_VIEW`) передают активную вкладку через `SHOW` / `TAB_SET` и скрывают через `HIDE`.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `SHOW` | `vne:settings_view:show` | Показать слой; payload `{ tab, tabKey?, tabs?, locs?, isForce? }`. Поля из `tab`; при `tabs` все вкладки монтируются сразу для crossfade. |
12
+ | `TAB_SET` | `vne:settings_view:tab_set` | Сменить активную вкладку; payload `{ tab, tabKey?, locs?, isForce? }`. Старая и новая одновременно: `PositionBox opacity` 1↔0. |
13
+ | `HIDE` | `vne:settings_view:hide` | Скрыть слой полей. |
14
+ | `UPDATE` | `vne:settings_view:update` | Обновить состояние или отображение. |
15
+
16
+ ## Константы
17
+
18
+ Нет.
19
+
20
+ ## Параметры
21
+
22
+ | Ключ | Тип | Смысл |
23
+ |------|-----|-------|
24
+ | `TABS` | `Record<string, SettingsTab>` | Схема вкладок/полей (заполняет игра). |
25
+ | `VALUE_MAPS` | `Record<string, SettingsValueMap>` | Мапперы значений range. |
26
+ | `ACTIONS` | `Record<string, SettingsAction>` | Именованные actions опций. |
27
+ | `VIEW_PROPS` | object | `view` (для `<View />`), `fieldProps`, `fieldsGap`, `exampleText`. |
28
+ | `TRANSITION` | `number` | Длительность анимации (в т.ч. fade при `TAB_SET`). |
29
+ | `ZINDEX` | `number` | Index в controls-стеке для стрелок/`INTERACT` (ниже chrome экранов). |
30
+ | `LOC_LABEL` | `string` | Label локалей для inject. |
31
+
32
+ ## Настройки
33
+
34
+ Нет.
35
+
36
+ ## Модули
37
+
38
+ | Модуль | Зона ответственности |
39
+ |--------|----------------------|
40
+ | `settings.fields.controller` | `SHOW`/`HIDE`/`TAB_SET`; `ARROW_*` / `INTERACT`→применить option/toggle; `SETTINGS.SET`. `ACCEPT` не обрабатывает — оставляют экраны. |
41
+ | `settings.fields.view` | Обёртка `<View {...propsView} />` (fade show/hide); внутри вкладки `<SettingsTabContent />` с `PositionBox opacity` для crossfade по `tabKey`. |
42
+
43
+ ## Близкие плагины
44
+
45
+ ### plugins/core/
46
+
47
+ - [components.md](../core/components.md) — `COMPONENTS`: EVENTS.EXTERNAL_UPDATE, EVENTS.RENDER
48
+ - [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.SET, EVENTS.CHANGED
49
+
50
+ ### Остальные
51
+
52
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.INTERACT, ARROW_*
53
+ - [settings.md](../views.screens/settings.md) — `SETTINGS_SCREEN_VIEW`
54
+ - [settings.defaults.md](../views.screens/settings.defaults.md) — `SETTINGS_DEFAULT_VIEW`
package/plugins/views.screens/settings.defaults.md CHANGED
@@ -1,17 +1,21 @@
1
1
  # plugins/views.screens/settings.defaults/
2
2
 
3
- Пакет: `@vnejs/plugins.views.screens.settings.defaults` · namespace: `SETTINGS_DEFAULTS`
3
+ Пакет: `@vnejs/plugins.views.screens.settings.defaults` · namespace: `SETTINGS_DEFAULT_VIEW`
4
4
 
5
- Экран выбора настроек по умолчанию при первом запуске сценария.
5
+ Экран выбора настроек по умолчанию при первом запуске сценария (chrome: title + Accept). Список полей и стрелки — в [`plugins/views/settings`](../views/settings.md) (`SETTINGS_VIEW`).
6
+
7
+ Breaking: раньше namespace был `SETTINGS_DEFAULTS`, события `vne:settings_defaults:*`, ключ `vne:settings_defaults:inited`.
6
8
 
7
9
  ## События
8
10
 
9
11
  | Ключ | Строка | Смысл |
10
12
  |------|--------|-------|
11
- | `UPDATE` | `vne:settings_defaults:update` | Обновить состояние или отображение. |
12
- | `SHOW` | `vne:settings_defaults:show` | Показать UI или слой. |
13
- | `HIDE` | `vne:settings_defaults:hide` | Скрыть UI или слой. |
14
- | `CONFIRM` | `vne:settings_defaults:confirm` | Продвинуть сценарий к следующей строке. |
13
+ | `UPDATE` | `vne:settings_default_view:update` | Обновить состояние или отображение. |
14
+ | `SHOW` | `vne:settings_default_view:show` | Показать UI или слой. |
15
+ | `HIDE` | `vne:settings_default_view:hide` | Скрыть UI или слой. |
16
+ | `CONFIRM` | `vne:settings_default_view:confirm` | Продвинуть сценарий к следующей строке. |
17
+
18
+ На `SHOW` эмитит `SETTINGS_VIEW.SHOW` с `{ tab: PARAMS.SETTINGS_VIEW.TABS.DEFAULT, tabKey: "DEFAULT", locs }`; на `HIDE` — `SETTINGS_VIEW.HIDE`.
15
19
 
16
20
  ## Константы
17
21
 
@@ -27,15 +31,15 @@
27
31
 
28
32
  | Ключ | Тип | Смысл |
29
33
  |------|-----|-------|
30
- | `INITED` (`vne:settings_defaults:inited`) | `string` | Настройка `vne:settings_defaults:inited` в `shared.settings`. |
34
+ | `INITED` (`vne:settings_default_view:inited`) | `string` | Настройка в `shared.settings`. |
31
35
 
32
36
  ## Модули
33
37
 
34
38
  | Модуль | Зона ответственности |
35
39
  |--------|----------------------|
36
- | `settings.defaults.controller` | Обрабатывает UPDATE, SHOW, HIDE, EXTERNAL_UPDATE, …. |
40
+ | `settings.defaults.controller` | SHOW/HIDE; `ACCEPT` → `CONFIRM` (выше controls index слоя полей); связка с `SETTINGS_VIEW`. |
37
41
  | `settings.defaults` | Связь со сценарием: шаг next после завершения действия. |
38
- | `settings.defaults.view` | Подмодуль `defaults.view` плагина. |
42
+ | `settings.defaults.view` | Chrome: title + кнопка Accept. |
39
43
 
40
44
  ## Близкие плагины
41
45
 
@@ -48,4 +52,5 @@
48
52
 
49
53
  ### Остальные
50
54
 
51
- - [settings.md](./settings.md) — `SETTINGS_VIEW`: PARAMS.TABS
55
+ - [settings.md](../views/settings.md) — `SETTINGS_VIEW`: PARAMS.TABS.DEFAULT, стрелки
56
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.ACCEPT
package/plugins/views.screens/settings.md CHANGED
@@ -1,18 +1,20 @@
1
1
  # plugins/views.screens/settings/
2
2
 
3
- Пакет: `@vnejs/plugins.views.screens.settings` · namespace: `SETTINGS_VIEW`
3
+ Пакет: `@vnejs/plugins.views.screens.settings` · namespace: `SETTINGS_SCREEN_VIEW`
4
4
 
5
- Экран настроек с вкладками и полями toggle, range и списками значений.
5
+ Экран настроек с вкладками (chrome: Screen, tabs, cross, example text). Список полей и стрелки — в [`plugins/views/settings`](../views/settings.md) (`SETTINGS_VIEW`).
6
6
 
7
7
  ## События
8
8
 
9
9
  | Ключ | Строка | Смысл |
10
10
  |------|--------|-------|
11
- | `SHOW` | `vne:settings_view:show` | Показать UI или слой. |
12
- | `HIDE` | `vne:settings_view:hide` | Скрыть UI или слой. |
13
- | `UPDATE` | `vne:settings_view:update` | Обновить состояние или отображение. |
14
- | `PRELOAD` | `vne:settings_view:preload` | Событие `PRELOAD` namespace плагина. |
15
- | `TAB_SET` | `vne:settings_view:tab_set` | Выбрать вкладку по ключу из `PARAMS.TABS` (`{ tab: string }`). |
11
+ | `SHOW` | `vne:settings_screen_view:show` | Показать UI или слой. |
12
+ | `HIDE` | `vne:settings_screen_view:hide` | Скрыть UI или слой. |
13
+ | `UPDATE` | `vne:settings_screen_view:update` | Обновить состояние или отображение. |
14
+ | `PRELOAD` | `vne:settings_screen_view:preload` | Событие `PRELOAD` namespace плагина. |
15
+ | `TAB_SET` | `vne:settings_screen_view:tab_set` | Выбрать вкладку по ключу из `PARAMS.SETTINGS_VIEW.TABS` (`{ tab: string }`). |
16
+
17
+ На открытии эмитит `SETTINGS_VIEW.SHOW` с `{ tab, tabs, tabKey, locs }`; на `TAB_SET` экрана — `SETTINGS_VIEW.TAB_SET` с `{ tab, tabKey, locs }` (crossfade контента); на `HIDE` — `SETTINGS_VIEW.HIDE`.
16
18
 
17
19
  ## Константы
18
20
 
@@ -22,8 +24,11 @@
22
24
 
23
25
  | Ключ | Тип | Смысл |
24
26
  |------|-----|-------|
25
- | `TRANSITION` | `string` | Значение по умолчанию: "TRANSITION". |
27
+ | `TRANSITION` | `number` | Длительность анимации. |
26
28
  | `AUDIO_NAME` | `string` | Имя трека на слое `view` при открытии экрана; пустая строка — без overlay-музыки. |
29
+ | `VIEW_PROPS` | object | Chrome: `screen`, `cross`, `controls`. |
30
+
31
+ Схема полей (`TABS` / `VALUE_MAPS` / `ACTIONS` / `fieldProps`) — в `PARAMS.SETTINGS_VIEW`.
27
32
 
28
33
  ## Настройки
29
34
 
@@ -33,10 +38,10 @@
33
38
 
34
39
  | Модуль | Зона ответственности |
35
40
  |--------|----------------------|
36
- | `settings.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека; `VOLUME_SETTING = MUSIC.VOLUME`; при `VOLUME_CHANGED` / смене `VOLUME_SETTING` — повторный `AUDIO.VOLUME`. |
37
- | `settings.controller` | Обрабатывает HIDE, SET, TAB_SET, UPDATE, …; `currentTab` — ключ вкладки. |
41
+ | `settings.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека. |
42
+ | `settings.controller` | SHOW/HIDE/TAB_SET; `BACK`/`MENU`/`GAMEMENU` → hide; связка с `SETTINGS_VIEW`. |
38
43
  | `settings.controller.tabs` | Наследник `ModuleControllerTabs`: TAB_PREV/TAB_NEXT → `TAB_SET`; `getTabKeys` по `showInSettings`. |
39
- | `settings.view` | Подмодуль `view` плагина. |
44
+ | `settings.view` | Chrome экрана (Screen, tabs, cross); поля и example text — в `SETTINGS_VIEW`. |
40
45
 
41
46
  ## Близкие плагины
42
47
 
@@ -49,6 +54,7 @@
49
54
 
50
55
  ### Остальные
51
56
 
52
- - [audio.md](../audio/audio.md) — `AUDIO`: EVENTS.GLOBAL_PAUSE, EVENTS.PLAY, EVENTS.STOP, EVENTS.GLOBAL_RESUME, EVENTS.MEDIA_LOAD, EVENTS.VOLUME, EVENTS.VOLUME_CHANGED
57
+ - [settings.md](../views/settings.md) — `SETTINGS_VIEW`: поля и стрелки
58
+ - [audio.md](../audio/audio.md) — `AUDIO`
53
59
  - [music.md](../audio/music.md) — `MUSIC`: SETTINGS.VOLUME
54
- - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.BACK, CONST.BUTTONS.MENU, CONST.BUTTONS.GAMEMENU, CONST.BUTTONS.INTERACT, CONST.BUTTONS.ACCEPT, CONST.BUTTONS.TAB_PREV, CONST.BUTTONS.TAB_NEXT
60
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.BACK, MENU, GAMEMENU, TAB_PREV, TAB_NEXT