@vnejs/docs 0.2.21 → 0.2.23
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/CHANGELOG.md +17 -1
- package/README.md +7 -7
- package/architecture.md +75 -75
- package/manifest.json +1 -7
- package/package.json +1 -1
- package/plugins/audio/ambient.md +5 -5
- package/plugins/audio/audio.md +26 -26
- package/plugins/audio/music.md +5 -5
- package/plugins/audio/sound.md +5 -5
- package/plugins/audio/voice.md +9 -9
- package/plugins/canvas/bg.md +23 -23
- package/plugins/canvas/bg.speak.md +19 -19
- package/plugins/canvas/fill.md +23 -23
- package/plugins/canvas/layer.md +20 -20
- package/plugins/canvas/sprite.md +29 -29
- package/plugins/canvas/sprite.speak.md +16 -16
- package/plugins/canvas/text.md +24 -24
- package/plugins/canvas/video.md +22 -22
- package/plugins/canvas.layers/bl.md +12 -12
- package/plugins/canvas.layers/fl.md +12 -12
- package/plugins/canvas.layers/ml.md +12 -12
- package/plugins/canvas.layers/ul.md +11 -11
- package/plugins/canvas.props/animation.md +10 -10
- package/plugins/canvas.props/clip.md +7 -7
- package/plugins/canvas.props/filters.md +2 -2
- package/plugins/canvas.props/mask.md +8 -8
- package/plugins/canvas.props/scale.md +5 -5
- package/plugins/controls/controls.md +15 -15
- package/plugins/controls/cursor.md +34 -34
- package/plugins/controls/gamepad.md +27 -27
- package/plugins/controls/keyboard.md +2 -2
- package/plugins/core/components.md +10 -10
- package/plugins/core/interact.md +12 -12
- package/plugins/core/logs.md +10 -10
- package/plugins/core/media.md +21 -21
- package/plugins/core/memory.md +10 -10
- package/plugins/core/platforms.md +11 -11
- package/plugins/core/scenario.md +22 -22
- package/plugins/core/settings.md +9 -9
- package/plugins/core/stack.md +18 -18
- package/plugins/core/state.md +13 -13
- package/plugins/core/storage.md +32 -32
- package/plugins/core/system.md +24 -24
- package/plugins/core/vendors.md +7 -11
- package/plugins/entities/wallet.md +11 -11
- package/plugins/platform/android.md +2 -2
- package/plugins/platform/electron.md +2 -2
- package/plugins/platform/metric.md +7 -7
- package/plugins/rpg/damage.md +7 -7
- package/plugins/rpg/hit.md +8 -8
- package/plugins/rpg/skills.md +11 -11
- package/plugins/save/auto.md +11 -11
- package/plugins/save/continue.md +8 -8
- package/plugins/save/save.md +23 -23
- package/plugins/scales/health.md +2 -2
- package/plugins/scales/mana.md +2 -2
- package/plugins/scales/scales.md +15 -15
- package/plugins/scenario/autoread.md +14 -14
- package/plugins/scenario/choose.md +36 -36
- package/plugins/scenario/fastforward.md +38 -27
- package/plugins/scenario/pause.md +6 -6
- package/plugins/scenario/point_and_click.md +30 -30
- package/plugins/scenario/qte.md +16 -16
- package/plugins/scenario/random.md +3 -3
- package/plugins/settings/filter.md +5 -5
- package/plugins/settings/potato.md +6 -6
- package/plugins/settings/ratio.md +4 -4
- package/plugins/settings/textsize.md +5 -5
- package/plugins/settings/volume.md +7 -7
- package/plugins/text/inject.md +7 -7
- package/plugins/text/locs.md +13 -13
- package/plugins/text/meet.md +4 -4
- package/plugins/text/smooth.md +18 -18
- package/plugins/text/text.md +41 -41
- package/plugins/text/wall.md +4 -4
- package/plugins/time/date.md +6 -6
- package/plugins/time/time.md +7 -7
- package/plugins/vars/counters.md +12 -12
- package/plugins/vars/flags.md +10 -10
- package/plugins/vars/vars.md +16 -16
- package/plugins/views/achievement.md +26 -26
- package/plugins/views/comment.md +13 -13
- package/plugins/views/controls.hints.md +12 -12
- package/plugins/views/cursor.md +3 -3
- package/plugins/views/fps.md +13 -13
- package/plugins/views/gamepad.debug.md +16 -16
- package/plugins/views/settings.md +22 -22
- package/plugins/views/video.md +18 -18
- package/plugins/views.scenario/choose.md +21 -21
- package/plugins/views.scenario/interface.controls.md +13 -13
- package/plugins/views.scenario/interface.fastforward.md +11 -11
- package/plugins/views.scenario/interface.md +29 -29
- package/plugins/views.scenario/point_and_click.md +15 -15
- package/plugins/views.scenario/qte.md +25 -25
- package/plugins/views.screens/confirm.md +20 -20
- package/plugins/views.screens/credits.md +14 -14
- package/plugins/views.screens/disclaimer.md +20 -20
- package/plugins/views.screens/eula.md +21 -21
- package/plugins/views.screens/gallery.full.md +10 -10
- package/plugins/views.screens/gallery.md +30 -30
- package/plugins/views.screens/gamemenu.md +21 -21
- package/plugins/views.screens/history.md +26 -26
- package/plugins/views.screens/intro.md +14 -14
- package/plugins/views.screens/loading.md +13 -13
- package/plugins/views.screens/mainmenu.md +33 -33
- package/plugins/views.screens/mainmenu.socials.md +7 -7
- package/plugins/views.screens/save.md +21 -21
- package/plugins/views.screens/settings.defaults.md +14 -14
- package/plugins/views.screens/settings.md +16 -16
- package/scenario.catalog/index.md +69 -69
- package/scenario.catalog/stubs/achievement.md +6 -6
- package/scenario.catalog/stubs/audio.ambient.md +6 -6
- package/scenario.catalog/stubs/audio.music.md +6 -6
- package/scenario.catalog/stubs/audio.sound.md +6 -6
- package/scenario.catalog/stubs/audio.voice.md +6 -6
- package/scenario.catalog/stubs/bl.animation.md +6 -6
- package/scenario.catalog/stubs/bl.bg.md +6 -6
- package/scenario.catalog/stubs/bl.clip.md +6 -6
- package/scenario.catalog/stubs/bl.fill.md +6 -6
- package/scenario.catalog/stubs/bl.filter.md +6 -6
- package/scenario.catalog/stubs/bl.mask.md +6 -6
- package/scenario.catalog/stubs/bl.scale.md +6 -6
- package/scenario.catalog/stubs/bl.sprite.md +6 -6
- package/scenario.catalog/stubs/bl.text.md +6 -6
- package/scenario.catalog/stubs/bl.video.md +6 -6
- package/scenario.catalog/stubs/choose.block.md +4 -4
- package/scenario.catalog/stubs/choose.md +5 -5
- package/scenario.catalog/stubs/choose.option.md +4 -4
- package/scenario.catalog/stubs/comment.md +6 -6
- package/scenario.catalog/stubs/counter.md +5 -5
- package/scenario.catalog/stubs/credits.md +6 -6
- package/scenario.catalog/stubs/date.md +6 -6
- package/scenario.catalog/stubs/disclaimer.md +6 -6
- package/scenario.catalog/stubs/fl.animation.md +6 -6
- package/scenario.catalog/stubs/fl.bg.md +6 -6
- package/scenario.catalog/stubs/fl.clip.md +6 -6
- package/scenario.catalog/stubs/fl.fill.md +6 -6
- package/scenario.catalog/stubs/fl.filter.md +6 -6
- package/scenario.catalog/stubs/fl.mask.md +6 -6
- package/scenario.catalog/stubs/fl.scale.md +6 -6
- package/scenario.catalog/stubs/fl.sprite.md +6 -6
- package/scenario.catalog/stubs/fl.text.md +6 -6
- package/scenario.catalog/stubs/fl.video.md +6 -6
- package/scenario.catalog/stubs/flag.md +7 -7
- package/scenario.catalog/stubs/interface.md +6 -6
- package/scenario.catalog/stubs/intro.md +6 -6
- package/scenario.catalog/stubs/mainmenu.md +6 -6
- package/scenario.catalog/stubs/ml.animation.md +6 -6
- package/scenario.catalog/stubs/ml.bg.md +6 -6
- package/scenario.catalog/stubs/ml.clip.md +6 -6
- package/scenario.catalog/stubs/ml.fill.md +6 -6
- package/scenario.catalog/stubs/ml.filter.md +6 -6
- package/scenario.catalog/stubs/ml.mask.md +6 -6
- package/scenario.catalog/stubs/ml.scale.md +6 -6
- package/scenario.catalog/stubs/ml.sprite.md +6 -6
- package/scenario.catalog/stubs/ml.text.md +6 -6
- package/scenario.catalog/stubs/ml.video.md +6 -6
- package/scenario.catalog/stubs/other.md +6 -6
- package/scenario.catalog/stubs/pause.md +6 -6
- package/scenario.catalog/stubs/point-and-click.block.md +4 -4
- package/scenario.catalog/stubs/point-and-click.md +5 -5
- package/scenario.catalog/stubs/point-and-click.option.md +4 -4
- package/scenario.catalog/stubs/qte.md +6 -6
- package/scenario.catalog/stubs/random.md +6 -6
- package/scenario.catalog/stubs/random.option.md +6 -6
- package/scenario.catalog/stubs/save.auto.md +6 -6
- package/scenario.catalog/stubs/save.md +6 -6
- package/scenario.catalog/stubs/scenario.md +6 -6
- package/scenario.catalog/stubs/settings.defaults.md +6 -6
- package/scenario.catalog/stubs/stack.md +6 -6
- package/scenario.catalog/stubs/text.meet.md +6 -6
- package/scenario.catalog/stubs/text.wall.md +6 -6
- package/scenario.catalog/stubs/time.md +6 -6
- package/scenario.catalog/stubs/ul.animation.md +6 -6
- package/scenario.catalog/stubs/ul.bg.md +6 -6
- package/scenario.catalog/stubs/ul.clip.md +6 -6
- package/scenario.catalog/stubs/ul.fill.md +6 -6
- package/scenario.catalog/stubs/ul.filter.md +6 -6
- package/scenario.catalog/stubs/ul.mask.md +6 -6
- package/scenario.catalog/stubs/ul.scale.md +6 -6
- package/scenario.catalog/stubs/ul.sprite.md +6 -6
- package/scenario.catalog/stubs/ul.text.md +6 -6
- package/scenario.catalog/stubs/video.md +6 -6
- package/scenario.catalog/stubs/wallet.md +6 -6
- package/scenario.guide/README.md +21 -21
- package/scenario.guide/audio.md +6 -6
- package/scenario.guide/canvas.md +13 -13
- package/scenario.guide/choose.md +5 -5
- package/scenario.guide/flow.md +10 -10
- package/scenario.guide/point-and-click.md +5 -5
- package/scenario.guide/qte-random.md +4 -4
- package/scenario.guide/vars.md +6 -6
- package/scenario.guide/views.md +12 -12
|
@@ -12,21 +12,21 @@
|
|
|
12
12
|
|
|
13
13
|
Идентификаторы платформ (строки):
|
|
14
14
|
|
|
15
|
-
| Ключ
|
|
16
|
-
|
|
17
|
-
| `WEB`
|
|
18
|
-
| `MOBILE`
|
|
19
|
-
| `IOS`
|
|
20
|
-
| `ANDROID`
|
|
15
|
+
| Ключ | Значение |
|
|
16
|
+
| ---------- | ------------ |
|
|
17
|
+
| `WEB` | `"web"` |
|
|
18
|
+
| `MOBILE` | `"mobile"` |
|
|
19
|
+
| `IOS` | `"ios"` |
|
|
20
|
+
| `ANDROID` | `"android"` |
|
|
21
21
|
| `ELECTRON` | `"electron"` |
|
|
22
|
-
| `MACOS`
|
|
23
|
-
| `LINUX`
|
|
24
|
-
| `WINDOWS`
|
|
22
|
+
| `MACOS` | `"macos"` |
|
|
23
|
+
| `LINUX` | `"linux"` |
|
|
24
|
+
| `WINDOWS` | `"windows"` |
|
|
25
25
|
|
|
26
26
|
## Параметры
|
|
27
27
|
|
|
28
|
-
| Ключ
|
|
29
|
-
|
|
28
|
+
| Ключ | Тип | Смысл |
|
|
29
|
+
| ------------------ | ----------------------------------------- | -------------------------------------- |
|
|
30
30
|
| `CURRENT_PLATFORM` | `Platform` (одно из значений `CONSTANTS`) | Текущая платформа; по умолчанию `WEB`. |
|
|
31
31
|
|
|
32
32
|
## Настройки
|
package/plugins/core/scenario.md
CHANGED
|
@@ -6,17 +6,17 @@
|
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `EXEC`
|
|
12
|
-
| `EXEC_DELAY`
|
|
13
|
-
| `NEXT`
|
|
14
|
-
| `LABEL_GET`
|
|
15
|
-
| `LINE_LOAD`
|
|
16
|
-
| `LINE_GET`
|
|
17
|
-
| `LINE_LOAD_REG` | `vne:scenario:line_load_reg` | Зарегистрировать обработчик предзагрузки строк для module/block.
|
|
18
|
-
| `LINE_EXEC_REG` | `vne:scenario:line_exec_reg` | Зарегистрировать обработчик выполнения строк для module/block.
|
|
19
|
-
| `LINES_GET`
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| --------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| `EXEC` | `vne:scenario:exec` | Выполнить строку сценария: dispatch по module/block с line, args и keywords. |
|
|
12
|
+
| `EXEC_DELAY` | `vne:scenario:exec_delay` | Отложить promise до завершения текущего exec (async-строки). |
|
|
13
|
+
| `NEXT` | `vne:scenario:next` | Шаг вперёд по сценарию: выполнить текущую строку или завершить текущую метку. |
|
|
14
|
+
| `LABEL_GET` | `vne:scenario:label_get` | Предзагрузка строк метки на глубину `deep` с приоритетом. Упавшая строка не блокирует метку. |
|
|
15
|
+
| `LINE_LOAD` | `vne:scenario:line_load` | Условная предзагрузка одной строки (с учётом depth в memory). |
|
|
16
|
+
| `LINE_GET` | `vne:scenario:line_get` | Получить и подготовить одну строку сценария по label и index. Ошибка предзагрузки не оставляет промис висящим. |
|
|
17
|
+
| `LINE_LOAD_REG` | `vne:scenario:line_load_reg` | Зарегистрировать обработчик предзагрузки строк для module/block. |
|
|
18
|
+
| `LINE_EXEC_REG` | `vne:scenario:line_exec_reg` | Зарегистрировать обработчик выполнения строк для module/block. |
|
|
19
|
+
| `LINES_GET` | `vne:scenario:lines_get` | Получить массив строк метки (JSON с хоста, кэш в memory). |
|
|
20
20
|
|
|
21
21
|
## Константы
|
|
22
22
|
|
|
@@ -27,8 +27,8 @@
|
|
|
27
27
|
|
|
28
28
|
## Параметры
|
|
29
29
|
|
|
30
|
-
| Ключ
|
|
31
|
-
|
|
30
|
+
| Ключ | Тип | Смысл |
|
|
31
|
+
| ----------------- | -------- | ------------------------------------------- |
|
|
32
32
|
| `INIT_LABEL_NAME` | `string` | Имя стартовой метки; по умолчанию `"init"`. |
|
|
33
33
|
|
|
34
34
|
## Настройки
|
|
@@ -37,20 +37,20 @@
|
|
|
37
37
|
|
|
38
38
|
## Shared
|
|
39
39
|
|
|
40
|
-
| Поле
|
|
41
|
-
|
|
40
|
+
| Поле | Тип | Смысл |
|
|
41
|
+
| ------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
42
42
|
| `shouldAutostartScenario` | `boolean` | На `SYSTEM.STARTED` модуль `scenario.autostart` эмитит `LABEL_GET` (init) и `NEXT`, только если не `false`. В `init` ставится `true` через `??=`; другие плагины могут выставить `false`. `STATE.CLEAR` по-прежнему грузит init label в `scenario.label` без этого гейта. |
|
|
43
43
|
|
|
44
44
|
## Модули
|
|
45
45
|
|
|
46
|
-
| Модуль
|
|
47
|
-
|
|
48
|
-
| `scenario`
|
|
46
|
+
| Модуль | Зона ответственности |
|
|
47
|
+
| -------------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
48
|
+
| `scenario` | Главный цикл `NEXT`, exec строк, sync state. |
|
|
49
49
|
| `scenario.autostart` | Дефолт `shared.shouldAutostartScenario`; на `SYSTEM.STARTED` — init label + `emitNext` при включённом флаге. |
|
|
50
|
-
| `scenario.exec`
|
|
51
|
-
| `scenario.label`
|
|
52
|
-
| `scenario.line`
|
|
53
|
-
| `scenario.lines`
|
|
50
|
+
| `scenario.exec` | Dispatch `$module` / `%block`, registry handlers, `EXEC_DELAY`. |
|
|
51
|
+
| `scenario.label` | `LABEL_GET`, preload меток; init label на `STATE.CLEAR`. Одна упавшая строка не валит всю метку. |
|
|
52
|
+
| `scenario.line` | `LINE_LOAD` / `LINE_GET`, registry preload handlers. Executor `LINE_GET` всегда resolve. |
|
|
53
|
+
| `scenario.lines` | Fetch `label/<path>.json` с `HOST` (например `label/prologue/1.json`). |
|
|
54
54
|
|
|
55
55
|
## Близкие плагины
|
|
56
56
|
|
package/plugins/core/settings.md
CHANGED
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `SET`
|
|
12
|
-
| `INIT`
|
|
13
|
-
| `CHANGED` | `vne:settings:change` | Значение настройки изменилось: `{ name: string, value: unknown }`.
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| --------- | --------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| `SET` | `vne:settings:set` | Установить значение настройки по `name`, сохранить в storage, emit `CHANGED`. Payload: `{ name?, value?, options? }`. |
|
|
12
|
+
| `INIT` | `vne:settings:init` | Установить default, если значения нет или оно не из `options`; делегирует в `SET`. |
|
|
13
|
+
| `CHANGED` | `vne:settings:change` | Значение настройки изменилось: `{ name: string, value: unknown }`. |
|
|
14
14
|
|
|
15
15
|
## Константы
|
|
16
16
|
|
|
@@ -26,10 +26,10 @@
|
|
|
26
26
|
|
|
27
27
|
## Модули
|
|
28
28
|
|
|
29
|
-
| Модуль
|
|
30
|
-
|
|
31
|
-
| `settings`
|
|
32
|
-
| `settings.logs` | Логирование set/init/changed.
|
|
29
|
+
| Модуль | Зона ответственности |
|
|
30
|
+
| --------------- | --------------------------------------------------------------------- |
|
|
31
|
+
| `settings` | Load из storage при init; `SET` / `INIT`; запись в `shared.settings`. |
|
|
32
|
+
| `settings.logs` | Логирование set/init/changed. |
|
|
33
33
|
|
|
34
34
|
## Близкие плагины
|
|
35
35
|
|
package/plugins/core/stack.md
CHANGED
|
@@ -6,14 +6,14 @@
|
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `EMIT`
|
|
12
|
-
| `POP`
|
|
13
|
-
| `CLEAR`
|
|
14
|
-
| `JUMP`
|
|
15
|
-
| `CALL`
|
|
16
|
-
| `EXEC_ARG` | `vne:stack:exec_arg` | По токену строки вернуть значение аргумента из верхнего frame. Payload: `{ line? }`.
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| ---------- | -------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| `EMIT` | `vne:stack:emit` | Перейти на метку: сброс `curLine`, clone args, preload label, clear memory. Payload: `{ label?, args? }`. |
|
|
12
|
+
| `POP` | `vne:stack:pop` | Вернуться к предыдущей позиции в стеке или сбросить игру, если стек пуст. |
|
|
13
|
+
| `CLEAR` | `vne:stack:clear` | Сбросить глобальный state и продолжить сценарий. |
|
|
14
|
+
| `JUMP` | `vne:stack:jump` | Переход на метку без push в стек (делегирует в `EMIT`). |
|
|
15
|
+
| `CALL` | `vne:stack:call` | Push текущей позиции, затем `EMIT` новой метки. |
|
|
16
|
+
| `EXEC_ARG` | `vne:stack:exec_arg` | По токену строки вернуть значение аргумента из верхнего frame. Payload: `{ line? }`. |
|
|
17
17
|
|
|
18
18
|
## Константы
|
|
19
19
|
|
|
@@ -30,16 +30,16 @@
|
|
|
30
30
|
|
|
31
31
|
## Модули
|
|
32
32
|
|
|
33
|
-
| Модуль
|
|
34
|
-
|
|
35
|
-
| `stack`
|
|
36
|
-
| `stack.call`
|
|
37
|
-
| `stack.jump`
|
|
38
|
-
| `stack.pop`
|
|
39
|
-
| `stack.clear` | Clear state + next.
|
|
40
|
-
| `stack.args`
|
|
41
|
-
| `stack.exec`
|
|
42
|
-
| `stack.logs`
|
|
33
|
+
| Модуль | Зона ответственности |
|
|
34
|
+
| ------------- | ------------------------------------------------------------------- |
|
|
35
|
+
| `stack` | State стека; обработка `EMIT`; sync на `STATE.SET` / `CLEAR`. |
|
|
36
|
+
| `stack.call` | Push frame + jump. |
|
|
37
|
+
| `stack.jump` | Jump без сохранения. |
|
|
38
|
+
| `stack.pop` | Pop frame. |
|
|
39
|
+
| `stack.clear` | Clear state + next. |
|
|
40
|
+
| `stack.args` | Резолв аргументов из строки сценария. |
|
|
41
|
+
| `stack.exec` | Регистрация `$stack` handlers в scenario (jump/call/pop + preload). |
|
|
42
|
+
| `stack.logs` | Логирование операций стека. |
|
|
43
43
|
|
|
44
44
|
## Близкие плагины
|
|
45
45
|
|
package/plugins/core/state.md
CHANGED
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `GET`
|
|
12
|
-
| `SET`
|
|
13
|
-
| `LOAD`
|
|
14
|
-
| `CLEAR`
|
|
15
|
-
| `PRELOAD`
|
|
16
|
-
| `MIGRATE`
|
|
17
|
-
| `MIGRATE_REG` | `vne:state:migrate_reg` | Зарегистрировать функцию миграции для пары versionMajor / versionMinor.
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| ------------- | ----------------------- | ---------------------------------------------------------------------------------------- |
|
|
11
|
+
| `GET` | `vne:state:get` | Снять snapshot `globalState` (clone, пустые slice модулей отфильтровываются). |
|
|
12
|
+
| `SET` | `vne:state:set` | Применить полный snapshot globalState — восстановление состояния всех модулей. |
|
|
13
|
+
| `LOAD` | `vne:state:load` | Загрузить сохранение: clone → предобработка → применение state → preload метки сценария. |
|
|
14
|
+
| `CLEAR` | `vne:state:clear` | Сбросить локальный state модулей к значениям по умолчанию. |
|
|
15
|
+
| `PRELOAD` | `vne:state:preload` | Предобработка state перед применением (нормализация, подготовка к миграции). |
|
|
16
|
+
| `MIGRATE` | `vne:state:migrate` | Привести сохранение к текущей версии: проверка version/hash строки, цепочка миграций. |
|
|
17
|
+
| `MIGRATE_REG` | `vne:state:migrate_reg` | Зарегистрировать функцию миграции для пары versionMajor / versionMinor. |
|
|
18
18
|
|
|
19
19
|
## Константы
|
|
20
20
|
|
|
@@ -31,11 +31,11 @@
|
|
|
31
31
|
|
|
32
32
|
## Модули
|
|
33
33
|
|
|
34
|
-
| Модуль
|
|
35
|
-
|
|
36
|
-
| `state`
|
|
34
|
+
| Модуль | Зона ответственности |
|
|
35
|
+
| --------------- | ------------------------------------------------------ |
|
|
36
|
+
| `state` | `GET` / `LOAD` — serialize/hydrate globalState. |
|
|
37
37
|
| `state.migrate` | Версионная миграция сохранений по hash строк сценария. |
|
|
38
|
-
| `state.logs`
|
|
38
|
+
| `state.logs` | Логирование get/load/clear. |
|
|
39
39
|
|
|
40
40
|
## Близкие плагины
|
|
41
41
|
|
package/plugins/core/storage.md
CHANGED
|
@@ -10,41 +10,41 @@
|
|
|
10
10
|
|
|
11
11
|
- Если `group` не передан — подставляется `_` (default group).
|
|
12
12
|
- `key` может содержать `:` (например settings `vne:volume:common`).
|
|
13
|
-
- `module` может содержать `.` (например `vars.global`, `fastforward.
|
|
13
|
+
- `module` может содержать `.` (например `vars.global`, `fastforward.storage`).
|
|
14
14
|
|
|
15
15
|
Примеры:
|
|
16
16
|
|
|
17
|
-
| Вызов
|
|
18
|
-
|
|
19
|
-
| `{ module: "settings", key: "vne:volume:common" }`
|
|
20
|
-
| `{ module: "save", group: "0", key: "3" }`
|
|
21
|
-
| `{ module: "fastforward.
|
|
17
|
+
| Вызов | Физический ключ |
|
|
18
|
+
| ---------------------------------------------------------------- | -------------------------------- |
|
|
19
|
+
| `{ module: "settings", key: "vne:volume:common" }` | `settings/_/vne:volume:common` |
|
|
20
|
+
| `{ module: "save", group: "0", key: "3" }` | `save/0/3` |
|
|
21
|
+
| `{ module: "fastforward.storage", group: "intro", key: "hash" }` | `fastforward.storage/intro/hash` |
|
|
22
22
|
|
|
23
23
|
## Диск (desktop / Steam)
|
|
24
24
|
|
|
25
|
-
| Group
|
|
26
|
-
|
|
27
|
-
| `_` или не задан | `{module}.json`
|
|
28
|
-
| любая другая
|
|
25
|
+
| Group | Файл |
|
|
26
|
+
| ---------------- | ----------------------- |
|
|
27
|
+
| `_` или не задан | `{module}.json` |
|
|
28
|
+
| любая другая | `{module}/{group}.json` |
|
|
29
29
|
|
|
30
|
-
Примеры: `settings.json`, `save/0.json`, `save/autosave.json`, `fastforward.
|
|
30
|
+
Примеры: `settings.json`, `save/0.json`, `save/autosave.json`, `fastforward.storage/intro.json`.
|
|
31
31
|
|
|
32
32
|
## События
|
|
33
33
|
|
|
34
|
-
| Ключ
|
|
35
|
-
|
|
36
|
-
| `SET`
|
|
34
|
+
| Ключ | Строка | Смысл |
|
|
35
|
+
| --------- | --------------------- | ------------------------------------------------------------------------------------ |
|
|
36
|
+
| `SET` | `vne:storage:set` | Записать ключ (`module`, опционально `group`, `key`); emit `CHANGED`. |
|
|
37
37
|
| `SET_ALL` | `vne:storage:set_all` | Merge/replace всех ключей (плоские физические ключи); возвращает, были ли изменения. |
|
|
38
|
-
| `GET`
|
|
39
|
-
| `GET_ALL` | `vne:storage:get_all` | Ключи модуля; с `group` — только группа.
|
|
40
|
-
| `RM`
|
|
41
|
-
| `RM_ALL`
|
|
42
|
-
| `KEYS`
|
|
43
|
-
| `INIT`
|
|
44
|
-
| `CHANGED` | `vne:storage:changed` | В хранилище произошла запись, обновление или удаление.
|
|
45
|
-
| `IMPORT`
|
|
46
|
-
| `EXPORT`
|
|
47
|
-
| `CLEAR`
|
|
38
|
+
| `GET` | `vne:storage:get` | Прочитать один ключ (`module`, опционально `group`, `key`). |
|
|
39
|
+
| `GET_ALL` | `vne:storage:get_all` | Ключи модуля; с `group` — только группа. |
|
|
40
|
+
| `RM` | `vne:storage:rm` | Удалить один ключ. |
|
|
41
|
+
| `RM_ALL` | `vne:storage:rm_all` | Удалить ключи модуля; с `group` — только группа. |
|
|
42
|
+
| `KEYS` | `vne:storage:keys` | Список всех физических ключей в store. |
|
|
43
|
+
| `INIT` | `vne:storage:init` | Инициализация IndexedDB driver, ожидание ready. |
|
|
44
|
+
| `CHANGED` | `vne:storage:changed` | В хранилище произошла запись, обновление или удаление. |
|
|
45
|
+
| `IMPORT` | `vne:storage:import` | Заменить всё содержимое store данными из JSON-файла и перезагрузить страницу. |
|
|
46
|
+
| `EXPORT` | `vne:storage:export` | Скачать всё хранилище как JSON. |
|
|
47
|
+
| `CLEAR` | `vne:storage:clear` | Полностью очистить store и перезагрузить страницу. |
|
|
48
48
|
|
|
49
49
|
### `GET_ALL` и имена ключей в ответе
|
|
50
50
|
|
|
@@ -59,8 +59,8 @@
|
|
|
59
59
|
|
|
60
60
|
## Параметры
|
|
61
61
|
|
|
62
|
-
| Ключ
|
|
63
|
-
|
|
62
|
+
| Ключ | Тип | Смысл |
|
|
63
|
+
| ---------- | -------- | ------------------------------------------------------------ |
|
|
64
64
|
| `GAMENAME` | `string` | Префикс имени IndexedDB store; по умолчанию `"vne-default"`. |
|
|
65
65
|
|
|
66
66
|
## Настройки
|
|
@@ -69,12 +69,12 @@
|
|
|
69
69
|
|
|
70
70
|
## Модули
|
|
71
71
|
|
|
72
|
-
| Модуль
|
|
73
|
-
|
|
74
|
-
| `storage`
|
|
75
|
-
| `storage.get`
|
|
76
|
-
| `storage.set`
|
|
77
|
-
| `storage.rm`
|
|
72
|
+
| Модуль | Зона ответственности |
|
|
73
|
+
| ----------------- | ----------------------------------------------- |
|
|
74
|
+
| `storage` | Init localforage, `KEYS`, `CHANGED`, `INIT`. |
|
|
75
|
+
| `storage.get` | `GET` / `GET_ALL`. |
|
|
76
|
+
| `storage.set` | `SET` / `SET_ALL`. |
|
|
77
|
+
| `storage.rm` | `RM` / `RM_ALL`. |
|
|
78
78
|
| `storage.actions` | Import / export / clear с file picker и reload. |
|
|
79
79
|
|
|
80
80
|
## Близкие плагины
|
package/plugins/core/system.md
CHANGED
|
@@ -6,27 +6,27 @@
|
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `STARTED`
|
|
12
|
-
| `RESIZE`
|
|
13
|
-
| `RELOAD`
|
|
14
|
-
| `FULLSCREEN`
|
|
15
|
-
| `CLOSE`
|
|
16
|
-
| `CLOSE_BEFORE` | `vne:system:close_before` | Фаза подготовки перед закрытием или перезагрузкой страницы.
|
|
17
|
-
| `FILE_LOAD`
|
|
18
|
-
| `FILE_READ`
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| -------------- | ------------------------- | -------------------------------------------------------------------- |
|
|
11
|
+
| `STARTED` | `vne:system:started` | Движок инициализирован: все модули ready, media-манифесты загружены. |
|
|
12
|
+
| `RESIZE` | `vne:system:resize` | Изменились размеры окна приложения. |
|
|
13
|
+
| `RELOAD` | `vne:system:reload` | Перезагрузка страницы после фазы `CLOSE_BEFORE`. |
|
|
14
|
+
| `FULLSCREEN` | `vne:system:fullscreen` | Переключение полноэкранного режима документа. |
|
|
15
|
+
| `CLOSE` | `vne:system:close` | Закрытие окна приложения после фазы `CLOSE_BEFORE`. |
|
|
16
|
+
| `CLOSE_BEFORE` | `vne:system:close_before` | Фаза подготовки перед закрытием или перезагрузкой страницы. |
|
|
17
|
+
| `FILE_LOAD` | `vne:file:load` | Скачать объект как JSON-файл. Payload: `{ obj?, name? }`. |
|
|
18
|
+
| `FILE_READ` | `vne:file:read` | File picker → parse JSON → вернуть содержимое. |
|
|
19
19
|
|
|
20
20
|
## Константы
|
|
21
21
|
|
|
22
|
-
| Ключ
|
|
23
|
-
|
|
24
|
-
| `HOST`
|
|
25
|
-
| `VERSION_MAJOR`
|
|
26
|
-
| `VERSION_MINOR`
|
|
27
|
-
| `DOM_IDS.APP`
|
|
28
|
-
| `DOM_IDS.MEDIA`
|
|
29
|
-
| `DOM_IDS.COMPONENTS` | `"components"` — контейнер UI
|
|
22
|
+
| Ключ | Смысл |
|
|
23
|
+
| -------------------- | --------------------------------------------- |
|
|
24
|
+
| `HOST` | Origin или `http://localhost:{port}` из query |
|
|
25
|
+
| `VERSION_MAJOR` | Major-версия формата state (число) |
|
|
26
|
+
| `VERSION_MINOR` | Minor-версия (число) |
|
|
27
|
+
| `DOM_IDS.APP` | `"app"` — корневой контейнер |
|
|
28
|
+
| `DOM_IDS.MEDIA` | `"media"` — скрытый контейнер медиа |
|
|
29
|
+
| `DOM_IDS.COMPONENTS` | `"components"` — контейнер UI |
|
|
30
30
|
|
|
31
31
|
## Параметры
|
|
32
32
|
|
|
@@ -38,12 +38,12 @@
|
|
|
38
38
|
|
|
39
39
|
## Модули
|
|
40
40
|
|
|
41
|
-
| Модуль
|
|
42
|
-
|
|
43
|
-
| `system`
|
|
44
|
-
| `system.resize`
|
|
45
|
-
| `system.file`
|
|
46
|
-
| `system.version` | Default state `{ major, minor }` для миграции сохранений.
|
|
41
|
+
| Модуль | Зона ответственности |
|
|
42
|
+
| ---------------- | ---------------------------------------------------------- |
|
|
43
|
+
| `system` | Reload, close, fullscreen, `CLOSE_BEFORE`. |
|
|
44
|
+
| `system.resize` | Реагирует на изменение размеров окна; инициирует `RESIZE`. |
|
|
45
|
+
| `system.file` | `FILE_LOAD` / `FILE_READ`. |
|
|
46
|
+
| `system.version` | Default state `{ major, minor }` для миграции сохранений. |
|
|
47
47
|
|
|
48
48
|
## Близкие плагины
|
|
49
49
|
|
package/plugins/core/vendors.md
CHANGED
|
@@ -2,18 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
Пакет: `@vnejs/plugins.core.vendors` · namespace: `VENDORS`
|
|
4
4
|
|
|
5
|
-
Обёртки над сторонними утилитами: clone,
|
|
5
|
+
Обёртки над сторонними утилитами: clone, скриншот.
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `
|
|
12
|
-
| `HASH` | `vne:vendors:hash` | MD5-хеш объекта (идентификация строки сценария, проверка сохранений). |
|
|
13
|
-
| `DATE` | `vne:vendors:date` | Форматирование timestamp через dayjs. Payload: `{ ts?, format? }`. |
|
|
14
|
-
| `CLONE` | `vne:vendors:clone` | Deep clone через lodash (state, stack, args). |
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| -------- | -------------------- | ---------------------------------------------------------------------------------------------- |
|
|
11
|
+
| `CLONE` | `vne:vendors:clone` | Deep clone через lodash (state, stack, args). |
|
|
15
12
|
| `SCREEN` | `vne:vendors:screen` | Скриншот DOM через html2canvas → webp data URL. Payload: `{ width?, height?, quality?, id? }`. |
|
|
16
|
-
| `DEBOUNCE` | `vne:vendors:debounce` | Вернуть lodash-debounced функцию. Payload: `{ func?, wait?, options? }`. |
|
|
17
13
|
|
|
18
14
|
## Константы
|
|
19
15
|
|
|
@@ -29,9 +25,9 @@
|
|
|
29
25
|
|
|
30
26
|
## Модули
|
|
31
27
|
|
|
32
|
-
| Модуль
|
|
33
|
-
|
|
34
|
-
| `vendors`
|
|
28
|
+
| Модуль | Зона ответственности |
|
|
29
|
+
| ---------------- | --------------------------------------------------------------- |
|
|
30
|
+
| `vendors` | clone. |
|
|
35
31
|
| `vendors.screen` | html2canvas screenshot; на init помечает media-элементы ignore. |
|
|
36
32
|
|
|
37
33
|
## Близкие плагины
|
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `ADD`
|
|
12
|
-
| `SET`
|
|
13
|
-
| `REG`
|
|
14
|
-
| `RESET`
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| --------- | -------------------- | ---------------------------------- |
|
|
11
|
+
| `ADD` | `vne:wallet:add` | Событие `ADD` namespace плагина. |
|
|
12
|
+
| `SET` | `vne:wallet:set` | Записать или обновить значение. |
|
|
13
|
+
| `REG` | `vne:wallet:reg` | Зарегистрировать обработчик. |
|
|
14
|
+
| `RESET` | `vne:wallet:reset` | Событие `RESET` namespace плагина. |
|
|
15
15
|
| `CHANGED` | `vne:wallet:changed` | Зафиксировать изменение состояния. |
|
|
16
16
|
|
|
17
17
|
## Константы
|
|
@@ -20,10 +20,10 @@
|
|
|
20
20
|
|
|
21
21
|
## Параметры
|
|
22
22
|
|
|
23
|
-
| Ключ
|
|
24
|
-
|
|
23
|
+
| Ключ | Тип | Смысл |
|
|
24
|
+
| ------------ | -------- | ------------------------------------ |
|
|
25
25
|
| `CURRENCIES` | `string` | Значение по умолчанию: "CURRENCIES". |
|
|
26
|
-
| `ITEMS`
|
|
26
|
+
| `ITEMS` | `object` | Параметр `ITEMS`. |
|
|
27
27
|
|
|
28
28
|
## Настройки
|
|
29
29
|
|
|
@@ -31,8 +31,8 @@
|
|
|
31
31
|
|
|
32
32
|
## Модули
|
|
33
33
|
|
|
34
|
-
| Модуль
|
|
35
|
-
|
|
34
|
+
| Модуль | Зона ответственности |
|
|
35
|
+
| -------- | ------------------------ |
|
|
36
36
|
| `wallet` | Реестр обработчиков REG. |
|
|
37
37
|
|
|
38
38
|
## Близкие плагины
|
|
@@ -22,8 +22,8 @@
|
|
|
22
22
|
|
|
23
23
|
## Модули
|
|
24
24
|
|
|
25
|
-
| Модуль
|
|
26
|
-
|
|
25
|
+
| Модуль | Зона ответственности |
|
|
26
|
+
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
27
27
|
| `electron` | Синхронизирует remote storage; при изменении и cooldown ≥ 10 с (метка в `sessionStorage`) ставит `shouldReload` + `shared.shouldAutostartScenario = false`; на `STARTED` эмитит `RELOAD`; обрабатывает CHANGED / CLOSE_BEFORE. |
|
|
28
28
|
|
|
29
29
|
## Близкие плагины
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `GOAL`
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| -------- | ------------------- | ----------------------------------- |
|
|
11
|
+
| `GOAL` | `vne.metric.goal` | Событие `GOAL` namespace плагина. |
|
|
12
12
|
| `PARAMS` | `vne.metric.params` | Событие `PARAMS` namespace плагина. |
|
|
13
13
|
|
|
14
14
|
## Константы
|
|
@@ -17,8 +17,8 @@
|
|
|
17
17
|
|
|
18
18
|
## Параметры
|
|
19
19
|
|
|
20
|
-
| Ключ
|
|
21
|
-
|
|
20
|
+
| Ключ | Тип | Смысл |
|
|
21
|
+
| --------------- | -------- | ------------------------- |
|
|
22
22
|
| `YA_COUNTER_ID` | `number` | Значение по умолчанию: 0. |
|
|
23
23
|
|
|
24
24
|
## Настройки
|
|
@@ -27,8 +27,8 @@
|
|
|
27
27
|
|
|
28
28
|
## Модули
|
|
29
29
|
|
|
30
|
-
| Модуль
|
|
31
|
-
|
|
30
|
+
| Модуль | Зона ответственности |
|
|
31
|
+
| ------------ | -------------------------------- |
|
|
32
32
|
| `ya-metrika` | Обрабатывает EMIT, GOAL, PARAMS. |
|
|
33
33
|
|
|
34
34
|
## Близкие плагины
|
package/plugins/rpg/damage.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `EMIT`
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| ------------- | ------------------------ | ---------------------------------------- |
|
|
11
|
+
| `EMIT` | `vne:damage:emit` | Инициировать действие или цикл. |
|
|
12
12
|
| `CALC_DAMAGE` | `vne:damage:calc_damage` | Событие `CALC_DAMAGE` namespace плагина. |
|
|
13
13
|
|
|
14
14
|
## Константы
|
|
@@ -30,10 +30,10 @@
|
|
|
30
30
|
|
|
31
31
|
## Модули
|
|
32
32
|
|
|
33
|
-
| Модуль
|
|
34
|
-
|
|
35
|
-
| `damage.calc` | Подмодуль `calc` плагина.
|
|
36
|
-
| `damage`
|
|
33
|
+
| Модуль | Зона ответственности |
|
|
34
|
+
| ------------- | ---------------------------------------------- |
|
|
35
|
+
| `damage.calc` | Подмодуль `calc` плагина. |
|
|
36
|
+
| `damage` | Точка входа emit: подготовка и запуск process. |
|
|
37
37
|
|
|
38
38
|
## Близкие плагины
|
|
39
39
|
|
package/plugins/rpg/hit.md
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
## События
|
|
8
8
|
|
|
9
|
-
| Ключ
|
|
10
|
-
|
|
11
|
-
| `EMIT`
|
|
9
|
+
| Ключ | Строка | Смысл |
|
|
10
|
+
| ----------------------- | ------------------------------- | -------------------------------------------------- |
|
|
11
|
+
| `EMIT` | `vne:hit:emit` | Инициировать действие или цикл. |
|
|
12
12
|
| `CALC_CRIT_MISS_CHANCE` | `vne:hit:calc_crit_miss_chance` | Событие `CALC_CRIT_MISS_CHANCE` namespace плагина. |
|
|
13
|
-
| `CALC_ACCURACY`
|
|
14
|
-
| `CALC_CRIT_CHANCE`
|
|
13
|
+
| `CALC_ACCURACY` | `vne:hit:calc_accuracy` | Событие `CALC_ACCURACY` namespace плагина. |
|
|
14
|
+
| `CALC_CRIT_CHANCE` | `vne:hit:calc_crit_chance` | Событие `CALC_CRIT_CHANCE` namespace плагина. |
|
|
15
15
|
|
|
16
16
|
## Константы
|
|
17
17
|
|
|
@@ -30,10 +30,10 @@
|
|
|
30
30
|
|
|
31
31
|
## Модули
|
|
32
32
|
|
|
33
|
-
| Модуль
|
|
34
|
-
|
|
33
|
+
| Модуль | Зона ответственности |
|
|
34
|
+
| ---------- | -------------------------------------------------------------------- |
|
|
35
35
|
| `hit.calc` | Обрабатывает CALC_CRIT_MISS_CHANCE, CALC_ACCURACY, CALC_CRIT_CHANCE. |
|
|
36
|
-
| `hit`
|
|
36
|
+
| `hit` | Точка входа emit: подготовка и запуск process. |
|
|
37
37
|
|
|
38
38
|
## Близкие плагины
|
|
39
39
|
|