@vnejs/docs 0.2.14 → 0.2.16

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.
package/architecture.md CHANGED
@@ -134,6 +134,8 @@ flowchart TD
134
134
  MA["@vnejs/module.audio"]
135
135
  MCA["@vnejs/module.controller.audio"]
136
136
  MCT["@vnejs/module.controller.tabs"]
137
+ MCP["@vnejs/module.controller.preload"]
138
+ MCB["@vnejs/module.controller.backgrounds"]
137
139
  MSC["@vnejs/module.scales.common"]
138
140
 
139
141
  M --> MC
@@ -144,6 +146,8 @@ flowchart TD
144
146
  MC --> MA
145
147
  MC --> MCA
146
148
  MC --> MCT
149
+ MC --> MCP
150
+ MC --> MCB
147
151
  MC --> MSC
148
152
  MCO --> ML
149
153
  ```
@@ -160,6 +164,8 @@ flowchart TD
160
164
  | **`@vnejs/module.audio`** | База для audio-плагинов scenario-слоёв (`music` / `sound` / …) |
161
165
  | **`@vnejs/module.controller.audio`** | Overlay-BGM для view-экранов: pause global / play `view` / resume на SHOW/HIDE/PRELOAD |
162
166
  | **`@vnejs/module.controller.tabs`** | Навигация по вкладкам view-экранов: TAB_PREV/TAB_NEXT → `TAB_SET`, PUSH/POP controls на SHOW/HIDE |
167
+ | **`@vnejs/module.controller.preload`** | Предзагрузка меток и событий экрана по SHOW / PRELOAD / MEMORY.CLEARED; SHOW/HIDE/PRELOAD задаёт плагин |
168
+ | **`@vnejs/module.controller.backgrounds`** | Ротация списка фонов по SHOW / таймеру / MEMORY.CLEARED; стоп на HIDE и STATE.SET/CLEAR; события и список задаёт плагин |
163
169
  | **`@vnejs/module.scales.common`** | База для scales / RPG-модулей |
164
170
 
165
171
  ### Принципы
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vnejs/docs",
3
- "version": "0.2.14",
3
+ "version": "0.2.16",
4
4
  "description": "VNEJS documentation for engine consumers and coding agents",
5
5
  "files": [
6
6
  "*.md",
@@ -4,12 +4,14 @@
4
4
 
5
5
  Загружает словари локализации и подменяет строки текста по выбранному языку.
6
6
 
7
+ Файлы: `media/locs/{lang}/{group}/{label}.json`, например `media/locs/ru/views/mainMenu.json` и `media/locs/ru/labels/prologue.json`. `LOC_LABEL` и имена сценарных меток в путь не включают группу.
8
+
7
9
  ## События
8
10
 
9
11
  | Ключ | Строка | Смысл |
10
12
  |------|--------|-------|
11
- | `LOAD` | `vne:locs:load` | Запросить данные у обработчиков и продолжить цепочку. |
12
- | `GET` | `vne:locs:get` | Получить значение или ресурс. |
13
+ | `LOAD` | `vne:locs:load` | Запросить данные у обработчиков и продолжить цепочку. Payload: `{ label, group, lang? }`. Без `group` файл не грузится. |
14
+ | `GET` | `vne:locs:get` | Получить словарь. Payload: `{ label, group, lang? }`. Без `group` — пустой объект. |
13
15
  | `CHANGED` | `vne:locs:changed` | Зафиксировать изменение состояния. |
14
16
 
15
17
  ## Константы
@@ -21,6 +23,9 @@
21
23
  | Ключ | Тип | Смысл |
22
24
  |------|-----|-------|
23
25
  | `DEFAULT_LANG` | `string` | Значение по умолчанию: "ru". |
26
+ | `GROUPS` | `object` | `VIEWS: "views"`, `LABELS: "labels"` — папки после `{lang}/`. |
27
+
28
+ `LOCS.GET` / `LOCS.LOAD` требуют `group`. `TEXT.REPLACE` без `group` в locs-handler подставляет `GROUPS.LABELS`. View-inject (`locLabel`) берёт `GROUPS.VIEWS`.
24
29
 
25
30
  ## Настройки
26
31
 
@@ -40,7 +40,7 @@
40
40
 
41
41
  ## Локализация
42
42
 
43
- Файл `media/locs/{lang}/disclaimer.json`. Ключи:
43
+ Файл `media/locs/{lang}/views/disclaimer.json`. Ключи:
44
44
 
45
45
  | Ключ | Смысл |
46
46
  |------|-------|
@@ -4,6 +4,8 @@
4
4
 
5
5
  Главное меню с пунктами, сменой фона и предзагрузкой меток сценария.
6
6
 
7
+ Ротация `BACKGROUNDS`: модуль `mainmenu.backgrounds` по `SHOW` сразу грузит следующий фон и по `BACKGROUNDS_INTERVAL` эмитит `STATE_UPDATE` с `{ bgSrc }` и затем `UPDATE_FAST`.
8
+
7
9
  ## События
8
10
 
9
11
  | Ключ | Строка | Смысл |
@@ -11,9 +13,13 @@
11
13
  | `HIDE` | `vne:mainmenu:hide` | Скрыть UI или слой. |
12
14
  | `SHOW` | `vne:mainmenu:show` | Показать UI или слой. |
13
15
  | `ITEMS` | `vne:mainmenu:items` | Событие `ITEMS` namespace плагина. |
16
+ | `PRELOAD` | `vne:mainmenu:preload` | Предзагрузить метки `PRELOAD_LABELS` и события `PRELOAD_EVENTS`. |
14
17
  | `CLICK` | `vne:mainmenu:click` | Событие `CLICK` namespace плагина. |
15
18
  | `ACCEPT` | `vne:mainmenu:accept` | Событие `ACCEPT` namespace плагина. |
16
19
  | `UPDATE` | `vne:mainmenu:update` | Обновить состояние или отображение. |
20
+ | `STATE_UPDATE` | `vne:mainmenu:state_update` | Слить partial в стейт контроллера без UPDATE view. |
21
+ | `UPDATE_FORCE` | `vne:mainmenu:update_force` | Перерисовать view с `isForce`, стейт не меняет. |
22
+ | `UPDATE_FAST` | `vne:mainmenu:update_fast` | Перерисовать view с `isFast`, стейт не меняет. |
17
23
 
18
24
  ## Константы
19
25
 
@@ -42,8 +48,11 @@
42
48
 
43
49
  | Модуль | Зона ответственности |
44
50
  |--------|----------------------|
45
- | `mainmenu.controller` | Обрабатывает ACCEPT, UPDATE, SHOW, HIDE, …. |
46
- | `mainmenu` | Обрабатывает SHOW, HIDE, ITEMS, CLEARED. |
51
+ | `mainmenu.controller` | Обрабатывает ACCEPT, UPDATE, SHOW, HIDE, STATE_UPDATE, UPDATE_FAST, UPDATE_FORCE, …. |
52
+ | `mainmenu.backgrounds` | Наследует `@vnejs/module.controller.backgrounds`: ротация `BACKGROUNDS`, preload и таймер; эмитит `STATE_UPDATE` и `UPDATE_FAST`. |
53
+ | `mainmenu.preload` | Наследует `@vnejs/module.controller.preload`: по SHOW / PRELOAD / MEMORY.CLEARED грузит `PRELOAD_LABELS` и `PRELOAD_EVENTS`. |
54
+ | `mainmenu.scenario` | LINE_EXEC → SHOW, LINE_LOAD → PRELOAD. |
55
+ | `mainmenu` | Обрабатывает ITEMS и CLICK. |
47
56
  | `mainmenu.view` | Подмодуль `view` плагина. |
48
57
 
49
58
  ## Близкие плагины