@vnejs/docs 0.2.65 → 0.2.67
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/README.md +35 -35
- package/architecture/backends.md +18 -0
- package/architecture/build.md +37 -0
- package/architecture/bundles.md +20 -0
- package/architecture/cli.md +25 -0
- package/architecture/compatibility.md +22 -0
- package/architecture/configs.md +19 -0
- package/architecture/contracts.md +30 -0
- package/architecture/dependencies.md +55 -0
- package/architecture/editor.md +7 -0
- package/architecture/games.md +38 -0
- package/architecture/helpers.md +14 -0
- package/architecture/model.md +43 -0
- package/architecture/modules.md +87 -0
- package/architecture/packages.md +43 -0
- package/architecture/plugins.md +36 -0
- package/architecture/uis.md +23 -0
- package/changelog/0.2.18.md +7 -0
- package/changelog/0.2.19.md +14 -0
- package/changelog/0.2.20.md +10 -0
- package/changelog/0.2.21.md +5 -0
- package/changelog/0.2.22.md +11 -0
- package/changelog/0.2.23.md +4 -0
- package/changelog/0.2.25.md +6 -0
- package/changelog/0.2.26.md +12 -0
- package/changelog/0.2.29.md +10 -0
- package/changelog/0.2.31.md +5 -0
- package/changelog/0.2.32.md +3 -0
- package/changelog/0.2.33.md +5 -0
- package/changelog/0.2.34.md +8 -0
- package/changelog/0.2.35.md +33 -0
- package/changelog/0.2.36.md +10 -0
- package/changelog/0.2.38.md +19 -0
- package/changelog/0.2.39.md +16 -0
- package/changelog/0.2.40.md +9 -0
- package/changelog/0.2.42.md +3 -0
- package/changelog/0.2.43.md +10 -0
- package/changelog/0.2.46.md +3 -0
- package/changelog/0.2.47.md +25 -0
- package/changelog/0.2.49.md +3 -0
- package/changelog/0.2.50.md +6 -0
- package/changelog/0.2.51.md +6 -0
- package/changelog/0.2.52.md +5 -0
- package/changelog/0.2.53.md +12 -0
- package/changelog/0.2.55.md +19 -0
- package/changelog/0.2.56.md +11 -0
- package/changelog/0.2.57.md +7 -0
- package/changelog/0.2.58.md +8 -0
- package/changelog/0.2.59.md +6 -0
- package/changelog/0.2.60.md +5 -0
- package/changelog/0.2.61.md +11 -0
- package/changelog/0.2.62.md +8 -0
- package/changelog/0.2.63.md +4 -0
- package/changelog/0.2.64.md +4 -0
- package/changelog/0.2.65.md +3 -0
- package/changelog/0.2.66.md +5 -0
- package/changelog/README.md +43 -0
- package/manifest.json +66 -5
- package/package.json +6 -4
- package/plugins/ai/ai.md +29 -29
- package/plugins/ai/checkers.md +26 -26
- package/plugins/audio/ambient.md +20 -20
- package/plugins/audio/audio.md +40 -40
- package/plugins/audio/music.md +20 -20
- package/plugins/audio/sound.md +20 -20
- package/plugins/audio/voice.md +23 -23
- package/plugins/canvas/bg.md +44 -44
- package/plugins/canvas/bg.speak.md +34 -34
- package/plugins/canvas/fill.md +33 -33
- package/plugins/canvas/layer.md +35 -35
- package/plugins/canvas/sprite.md +46 -46
- package/plugins/canvas/sprite.speak.md +33 -33
- package/plugins/canvas/text.md +37 -37
- package/plugins/canvas/video.md +37 -37
- package/plugins/canvas.layers/bl.md +33 -33
- package/plugins/canvas.layers/fl.md +33 -33
- package/plugins/canvas.layers/ml.md +33 -33
- package/plugins/canvas.layers/ul.md +32 -32
- package/plugins/canvas.props/animation.md +25 -25
- package/plugins/canvas.props/clip.md +22 -22
- package/plugins/canvas.props/filters.md +20 -20
- package/plugins/canvas.props/mask.md +23 -23
- package/plugins/canvas.props/scale.md +20 -20
- package/plugins/common/grid.md +23 -23
- package/plugins/common/turn.md +18 -18
- package/plugins/controls/controls.md +31 -31
- package/plugins/controls/cursor.md +54 -54
- package/plugins/controls/gamepad.md +56 -56
- package/plugins/controls/keyboard.md +17 -17
- package/plugins/core/components.md +28 -28
- package/plugins/core/interact.md +26 -26
- package/plugins/core/logs.md +28 -28
- package/plugins/core/media.md +38 -38
- package/plugins/core/memory.md +28 -28
- package/plugins/core/platforms.md +19 -19
- package/plugins/core/scenario.md +48 -48
- package/plugins/core/settings.md +24 -24
- package/plugins/core/stack.md +39 -39
- package/plugins/core/state.md +30 -30
- package/plugins/core/storage.md +56 -56
- package/plugins/core/system.md +37 -37
- package/plugins/core/vendors.md +19 -19
- package/plugins/entities/entities.md +16 -16
- package/plugins/entities/wallet.md +27 -27
- package/plugins/font/montserrat.md +16 -16
- package/plugins/game/checkers.md +38 -38
- package/plugins/platform/android.md +17 -17
- package/plugins/platform/electron.md +21 -21
- package/plugins/platform/metric.md +23 -23
- package/plugins/rpg/damage.md +22 -22
- package/plugins/rpg/hit.md +24 -24
- package/plugins/rpg/skills.md +26 -26
- package/plugins/save/auto.md +26 -26
- package/plugins/save/continue.md +23 -23
- package/plugins/save/quick.md +24 -24
- package/plugins/save/save.md +37 -37
- package/plugins/scales/health.md +17 -17
- package/plugins/scales/mana.md +17 -17
- package/plugins/scales/scales.md +31 -31
- package/plugins/scenario/autoread.md +36 -36
- package/plugins/scenario/choose.md +74 -65
- package/plugins/scenario/fastforward.md +46 -46
- package/plugins/scenario/history.md +41 -41
- package/plugins/scenario/pause.md +27 -27
- package/plugins/scenario/point_and_click.md +51 -51
- package/plugins/scenario/qte.md +54 -54
- package/plugins/scenario/random.md +17 -17
- package/plugins/settings/filter.md +19 -19
- package/plugins/settings/potato.md +22 -22
- package/plugins/settings/ratio.md +19 -19
- package/plugins/settings/textsize.md +19 -19
- package/plugins/settings/volume.md +21 -21
- package/plugins/text/inject.md +22 -22
- package/plugins/text/locs.md +36 -36
- package/plugins/text/meet.md +19 -19
- package/plugins/text/smooth.md +33 -33
- package/plugins/text/text.md +76 -69
- package/plugins/text/wall.md +20 -20
- package/plugins/time/date.md +22 -22
- package/plugins/time/time.md +23 -23
- package/plugins/vars/counters.md +28 -28
- package/plugins/vars/flags.md +24 -24
- package/plugins/vars/vars.md +29 -29
- package/plugins/views/achievement.md +44 -44
- package/plugins/views/comment.md +31 -31
- package/plugins/views/controls.hints.md +34 -34
- package/plugins/views/cursor.md +19 -19
- package/plugins/views/fps.md +33 -33
- package/plugins/views/gamepad.debug.md +32 -32
- package/plugins/views/settings.md +39 -39
- package/plugins/views/video.md +37 -37
- package/plugins/views.scenario/choose.md +41 -41
- package/plugins/views.scenario/interface.controls.md +31 -31
- package/plugins/views.scenario/interface.fastforward.md +29 -29
- package/plugins/views.scenario/interface.md +74 -74
- package/plugins/views.scenario/point_and_click.md +39 -39
- package/plugins/views.scenario/qte.md +51 -51
- package/plugins/views.screens/checkers.md +35 -35
- package/plugins/views.screens/confirm.md +35 -35
- package/plugins/views.screens/credits.md +31 -31
- package/plugins/views.screens/disclaimer.md +42 -42
- package/plugins/views.screens/eula.md +37 -37
- package/plugins/views.screens/gallery.full.md +41 -41
- package/plugins/views.screens/gallery.md +75 -75
- package/plugins/views.screens/gamemenu.md +41 -41
- package/plugins/views.screens/history.md +39 -39
- package/plugins/views.screens/intro.md +32 -32
- package/plugins/views.screens/loading.md +30 -30
- package/plugins/views.screens/mainmenu.md +49 -49
- package/plugins/views.screens/mainmenu.socials.md +25 -25
- package/plugins/views.screens/save.md +66 -66
- package/plugins/views.screens/settings.defaults.md +37 -37
- package/plugins/views.screens/settings.md +40 -40
- package/scenario.catalog/README.md +13 -13
- package/scenario.catalog/index.md +35 -35
- package/scenario.catalog/stubs/achievement.md +4 -4
- package/scenario.catalog/stubs/audio.ambient.md +4 -4
- package/scenario.catalog/stubs/audio.music.md +4 -4
- package/scenario.catalog/stubs/audio.sound.md +4 -4
- package/scenario.catalog/stubs/audio.voice.md +4 -4
- package/scenario.catalog/stubs/bl.animation.md +5 -5
- package/scenario.catalog/stubs/bl.bg.md +5 -5
- package/scenario.catalog/stubs/bl.clip.md +5 -5
- package/scenario.catalog/stubs/bl.fill.md +5 -5
- package/scenario.catalog/stubs/bl.filter.md +5 -5
- package/scenario.catalog/stubs/bl.mask.md +5 -5
- package/scenario.catalog/stubs/bl.scale.md +5 -5
- package/scenario.catalog/stubs/bl.sprite.md +5 -5
- package/scenario.catalog/stubs/bl.text.md +5 -5
- package/scenario.catalog/stubs/bl.video.md +5 -5
- package/scenario.catalog/stubs/choose.block.md +7 -7
- package/scenario.catalog/stubs/choose.md +4 -4
- package/scenario.catalog/stubs/choose.option.md +7 -7
- package/scenario.catalog/stubs/comment.md +5 -5
- package/scenario.catalog/stubs/counter.md +5 -5
- package/scenario.catalog/stubs/credits.md +4 -4
- package/scenario.catalog/stubs/date.md +4 -4
- package/scenario.catalog/stubs/disclaimer.md +5 -5
- package/scenario.catalog/stubs/fl.animation.md +5 -5
- package/scenario.catalog/stubs/fl.bg.md +5 -5
- package/scenario.catalog/stubs/fl.clip.md +5 -5
- package/scenario.catalog/stubs/fl.fill.md +5 -5
- package/scenario.catalog/stubs/fl.filter.md +5 -5
- package/scenario.catalog/stubs/fl.mask.md +5 -5
- package/scenario.catalog/stubs/fl.scale.md +5 -5
- package/scenario.catalog/stubs/fl.sprite.md +5 -5
- package/scenario.catalog/stubs/fl.text.md +5 -5
- package/scenario.catalog/stubs/fl.video.md +5 -5
- package/scenario.catalog/stubs/flag.md +13 -13
- package/scenario.catalog/stubs/interface.md +4 -4
- package/scenario.catalog/stubs/intro.md +4 -4
- package/scenario.catalog/stubs/mainmenu.md +4 -4
- package/scenario.catalog/stubs/ml.animation.md +5 -5
- package/scenario.catalog/stubs/ml.bg.md +5 -5
- package/scenario.catalog/stubs/ml.clip.md +5 -5
- package/scenario.catalog/stubs/ml.fill.md +5 -5
- package/scenario.catalog/stubs/ml.filter.md +5 -5
- package/scenario.catalog/stubs/ml.mask.md +5 -5
- package/scenario.catalog/stubs/ml.scale.md +5 -5
- package/scenario.catalog/stubs/ml.sprite.md +5 -5
- package/scenario.catalog/stubs/ml.text.md +5 -5
- package/scenario.catalog/stubs/ml.video.md +5 -5
- package/scenario.catalog/stubs/other.md +6 -6
- package/scenario.catalog/stubs/pause.md +5 -5
- package/scenario.catalog/stubs/point-and-click.block.md +4 -4
- package/scenario.catalog/stubs/point-and-click.md +4 -4
- package/scenario.catalog/stubs/point-and-click.option.md +4 -4
- package/scenario.catalog/stubs/qte.md +4 -4
- package/scenario.catalog/stubs/random.md +4 -4
- package/scenario.catalog/stubs/random.option.md +4 -4
- package/scenario.catalog/stubs/save.auto.md +4 -4
- package/scenario.catalog/stubs/save.md +5 -5
- package/scenario.catalog/stubs/scenario.md +4 -4
- package/scenario.catalog/stubs/settings.defaults.md +4 -4
- package/scenario.catalog/stubs/stack.md +4 -4
- package/scenario.catalog/stubs/text.meet.md +4 -4
- package/scenario.catalog/stubs/text.wall.md +4 -4
- package/scenario.catalog/stubs/time.md +4 -4
- package/scenario.catalog/stubs/ul.animation.md +5 -5
- package/scenario.catalog/stubs/ul.bg.md +5 -5
- package/scenario.catalog/stubs/ul.clip.md +5 -5
- package/scenario.catalog/stubs/ul.fill.md +5 -5
- package/scenario.catalog/stubs/ul.filter.md +5 -5
- package/scenario.catalog/stubs/ul.mask.md +5 -5
- package/scenario.catalog/stubs/ul.scale.md +5 -5
- package/scenario.catalog/stubs/ul.sprite.md +5 -5
- package/scenario.catalog/stubs/ul.text.md +5 -5
- package/scenario.catalog/stubs/video.md +4 -4
- package/scenario.catalog/stubs/wallet.md +4 -4
- package/scenario.guide/README.md +38 -38
- package/scenario.guide/audio.md +11 -11
- package/scenario.guide/canvas.md +23 -23
- package/scenario.guide/choose.md +28 -28
- package/scenario.guide/dialogue.md +23 -23
- package/scenario.guide/flow.md +21 -21
- package/scenario.guide/point-and-click.md +12 -12
- package/scenario.guide/qte-random.md +20 -20
- package/scenario.guide/vars.md +19 -19
- package/scenario.guide/views.md +20 -20
- package/CHANGELOG.md +0 -387
- package/architecture.md +0 -566
package/plugins/scenario/qte.md
CHANGED
|
@@ -1,104 +1,104 @@
|
|
|
1
1
|
# plugins/scenario/qte/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.scenario.qte` · namespace: `QTE`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Quick Time Event logic: scenario command `% qte <id>`, shift `curLine` on success/fail, and embedded mode (`skipScenario`) for calls from other plugins. Does not render UI — see [views.scenario/qte.md](../views.scenario/qte.md).
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
QTE definitions come from the game via `PARAMS.QTE.ITEMS` (contract `@vnejs/contracts.scenario.qte`).
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Events
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.scenario.qte`.
|
|
12
12
|
|
|
13
|
-
|
|
|
14
|
-
| -------- | ---------------- |
|
|
15
|
-
| `EMIT` | `vne:qte:emit` |
|
|
16
|
-
| `RESULT` | `vne:qte:result` |
|
|
17
|
-
| `OPENED` | `vne:qte:opened` | QTE
|
|
18
|
-
| `CLOSED` | `vne:qte:closed` | QTE
|
|
13
|
+
| Key | String | Meaning |
|
|
14
|
+
| -------- | ---------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `EMIT` | `vne:qte:emit` | Start QTE: accept `id` / `item` / `skipScenario`, emit `OPENED`. |
|
|
16
|
+
| `RESULT` | `vne:qte:result` | Round result (`success`). Emits `CLOSED`; without `skipScenario` — shift scenario and `emit SCENARIO.NEXT`. |
|
|
17
|
+
| `OPENED` | `vne:qte:opened` | QTE active. View plugin listens. |
|
|
18
|
+
| `CLOSED` | `vne:qte:closed` | QTE closed. View plugin listens. |
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Constants
|
|
21
21
|
|
|
22
|
-
|
|
|
23
|
-
| ---------------------------- |
|
|
24
|
-
| `LINE_KEYWORDS.QTE_FALLBACK` | `"qte-fallback"`: keyword
|
|
25
|
-
| `LOGS_ACTIONS` |
|
|
22
|
+
| Key | Meaning |
|
|
23
|
+
| ---------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
24
|
+
| `LINE_KEYWORDS.QTE_FALLBACK` | `"qte-fallback"`: keyword on `% choose.option` for QTE fail branch (via choose↔qte compatibility). |
|
|
25
|
+
| `LOGS_ACTIONS` | Log labels: `EMIT` (`emit`), `RESULT` (`result`), `MISSING` (`missing`). |
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Parameters
|
|
28
28
|
|
|
29
|
-
|
|
|
30
|
-
| ------- | ------------------------- |
|
|
31
|
-
| `ITEMS` | `Record<string, QteItem>` |
|
|
29
|
+
| Key | Type | Meaning |
|
|
30
|
+
| ------- | ------------------------- | ---------------------------------------- |
|
|
31
|
+
| `ITEMS` | `Record<string, QteItem>` | QTE catalog by id. Default empty object. |
|
|
32
32
|
|
|
33
33
|
`QteItem`:
|
|
34
34
|
|
|
35
|
-
|
|
|
36
|
-
| ---------- | -------- |
|
|
37
|
-
| `start` | `number` |
|
|
38
|
-
| `size` | `number` |
|
|
39
|
-
| `duration` | `number` |
|
|
35
|
+
| Field | Type | Meaning |
|
|
36
|
+
| ---------- | -------- | ------------------------------------------ |
|
|
37
|
+
| `start` | `number` | Success zone start, % of duration (0–100). |
|
|
38
|
+
| `size` | `number` | Success zone width, %. |
|
|
39
|
+
| `duration` | `number` | `active` phase duration, ms. |
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
The view maps percents to geometry (degrees, pixels, etc.).
|
|
42
42
|
|
|
43
|
-
##
|
|
43
|
+
## Settings
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
None.
|
|
46
46
|
|
|
47
|
-
##
|
|
47
|
+
## Modules
|
|
48
48
|
|
|
49
|
-
|
|
|
50
|
-
| -------------- |
|
|
51
|
-
| `qte` | EMIT → `OPENED`;
|
|
52
|
-
| `qte.result` | RESULT → `CLOSED`;
|
|
53
|
-
| `qte.logs` |
|
|
54
|
-
| `qte.scenario` |
|
|
49
|
+
| Module | Role |
|
|
50
|
+
| -------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
|
51
|
+
| `qte` | EMIT → `OPENED`; in `postinject` and on `EMIT` writes `shared.qteScenarioSkip`. |
|
|
52
|
+
| `qte.result` | RESULT → `CLOSED`; without skip — `applyResult` (success → `curLine + 1`, fail → `getBlockSkipShift`) and `emit SCENARIO.NEXT`. |
|
|
53
|
+
| `qte.logs` | Log `EMIT` / `RESULT` via `EVENTS.LOGS.EMIT`; `skipScenario` from `shared.qteScenarioSkip`. |
|
|
54
|
+
| `qte.scenario` | Register `% qte` in SCENARIO; lookup `ITEMS`; missing id/item — log `MISSING` and `RESULT { success: false }`. |
|
|
55
55
|
|
|
56
|
-
##
|
|
56
|
+
## Scenario
|
|
57
57
|
|
|
58
58
|
```vne
|
|
59
59
|
% qte door_lock
|
|
60
|
-
"
|
|
61
|
-
"
|
|
60
|
+
"Success — enter indented block"
|
|
61
|
+
"Fail or after block — next line"
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
1. `% qte <id>` → `EMIT`
|
|
65
|
-
2. **Success** → `curLine`
|
|
66
|
-
3. **Fail** (
|
|
67
|
-
4.
|
|
64
|
+
1. `% qte <id>` → `EMIT` with `item` from `ITEMS[id]`.
|
|
65
|
+
2. **Success** → `curLine` on first line inside the block.
|
|
66
|
+
3. **Fail** (or unknown id) → skip indented block, continue scenario.
|
|
67
|
+
4. After `RESULT` (without `skipScenario`) — `emit SCENARIO.NEXT`.
|
|
68
68
|
|
|
69
69
|
## Embedded (`skipScenario`)
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
On `EMIT` with `skipScenario: true` sets `shared.qteScenarioSkip`; on `RESULT` module `qte.result` does **not** change `curLine` and does **not** call `emit SCENARIO.NEXT` — only `CLOSED`. Used by choose↔qte compatibility so branching stays with choose. In `qte` module `postinject` the flag is `false`.
|
|
72
72
|
|
|
73
73
|
## Compatibility
|
|
74
74
|
|
|
75
75
|
### `compatibility/scenario.choose/scenario.qte/`
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
Package: `@vnejs/compatibility.scenario.choose-with-scenario.qte`
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
On `CHOOSE.OPTION_REPLACE`: when the option has `qte: <id>`, runs QTE with `skipScenario: true`. Success — same option index; fail — index of the option whose `keywords` include `LINE_KEYWORDS.QTE_FALLBACK` (`qte-fallback`; if none — original index + `EVENTS.LOGS.EMIT`).
|
|
80
80
|
|
|
81
|
-
|
|
81
|
+
Extends `ChooseOption` with field `qte?: string`. Keyword `| qte-fallback` lands in `ChooseOption.keywords` via choose.
|
|
82
82
|
|
|
83
83
|
```vne
|
|
84
84
|
% choose
|
|
85
|
-
% choose.option "
|
|
85
|
+
% choose.option "With QTE"
|
|
86
86
|
qte: easy
|
|
87
|
-
"
|
|
87
|
+
"Success — this option’s branch"
|
|
88
88
|
% choose.option "Fallback" | qte-fallback
|
|
89
|
-
"
|
|
89
|
+
"Direct pick or QTE fail"
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
|
|
92
|
+
Wired in `bundles/vn.base`.
|
|
93
93
|
|
|
94
|
-
##
|
|
94
|
+
## Related plugins
|
|
95
95
|
|
|
96
96
|
### plugins/core/
|
|
97
97
|
|
|
98
98
|
- [logs.md](../core/logs.md) — `LOGS`: `EVENTS.LOGS.EMIT` (`action`, …)
|
|
99
99
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.NEXT, EVENTS.LINE_EXEC_REG, EVENTS.LINES_GET
|
|
100
100
|
|
|
101
|
-
###
|
|
101
|
+
### Other
|
|
102
102
|
|
|
103
|
-
- [views.scenario/qte.md](../views.scenario/qte.md) — `QTE_VIEW`: UI
|
|
104
|
-
- [choose.md](./choose.md) — `CHOOSE`: OPTION_REPLACE;
|
|
103
|
+
- [views.scenario/qte.md](../views.scenario/qte.md) — `QTE_VIEW`: round UI (listens OPENED / CLOSED)
|
|
104
|
+
- [choose.md](./choose.md) — `CHOOSE`: OPTION_REPLACE; link via compatibility above
|
|
@@ -1,38 +1,38 @@
|
|
|
1
1
|
# plugins/scenario/random/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.scenario.random` · namespace: `RANDOM`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Randomly pick one nested `% random.option` under a `% random` block and jump to it.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
None.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Constants
|
|
12
12
|
|
|
13
|
-
- **`LOGS_ACTIONS.OPTION`** — `"option"`:
|
|
13
|
+
- **`LOGS_ACTIONS.OPTION`** — `"option"`: log label when a branch is chosen.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Settings
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
None.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Modules
|
|
24
24
|
|
|
25
|
-
|
|
|
26
|
-
| -------- |
|
|
27
|
-
| `random` |
|
|
25
|
+
| Module | Role |
|
|
26
|
+
| -------- | ------------------------------------------------------------------------------------------------------------ |
|
|
27
|
+
| `random` | Collect `% random.option` via `getBlockOptions`, pick a random branch; skip others via `getOptionExecShift`. |
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## Related plugins
|
|
30
30
|
|
|
31
31
|
### plugins/core/
|
|
32
32
|
|
|
33
33
|
- [logs.md](../core/logs.md) — `LOGS`: `EVENTS.LOGS.EMIT` (`action`, …)
|
|
34
34
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.NEXT, EVENTS.LINE_EXEC_REG, EVENTS.LINES_GET
|
|
35
35
|
|
|
36
|
-
###
|
|
36
|
+
### Other
|
|
37
37
|
|
|
38
|
-
—
|
|
38
|
+
— None
|
|
@@ -1,39 +1,39 @@
|
|
|
1
1
|
# plugins/settings/filter/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.settings.filter` · namespace: `FILTER`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Applies CSS filters to the screen from presets chosen in settings.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
None.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Constants
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
None.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Settings
|
|
20
20
|
|
|
21
|
-
|
|
|
22
|
-
| ---------------------------- | -------- |
|
|
23
|
-
| `VALUE` (`vne:filter:value`) | `string` |
|
|
21
|
+
| Key | Type | Meaning |
|
|
22
|
+
| ---------------------------- | -------- | ------------------------------------------------ |
|
|
23
|
+
| `VALUE` (`vne:filter:value`) | `string` | Setting `vne:filter:value` in `shared.settings`. |
|
|
24
24
|
|
|
25
|
-
##
|
|
25
|
+
## Modules
|
|
26
26
|
|
|
27
|
-
|
|
|
28
|
-
| -------- |
|
|
29
|
-
| `filter` |
|
|
27
|
+
| Module | Role |
|
|
28
|
+
| -------- | ---------------- |
|
|
29
|
+
| `filter` | `filter` module. |
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Related plugins
|
|
32
32
|
|
|
33
33
|
### plugins/core/
|
|
34
34
|
|
|
35
35
|
- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT
|
|
36
36
|
|
|
37
|
-
###
|
|
37
|
+
### Other
|
|
38
38
|
|
|
39
|
-
—
|
|
39
|
+
— None
|
|
@@ -1,43 +1,43 @@
|
|
|
1
1
|
# plugins/settings/potato/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.settings.potato` · namespace: `POTATO`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Low-load mode: disables animations, transitions, and media timeouts.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.settings.potato`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------ | ----------------- |
|
|
13
|
-
| `EMIT` | `vne:potato:emit` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------ | ----------------- | ------------------------- |
|
|
13
|
+
| `EMIT` | `vne:potato:emit` | Start an action or cycle. |
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Constants
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Parameters
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
None.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Settings
|
|
24
24
|
|
|
25
|
-
|
|
|
26
|
-
| -------------------------------- | --------- |
|
|
27
|
-
| `ENABLED` (`vne:potato:enabled`) | `boolean` |
|
|
25
|
+
| Key | Type | Meaning |
|
|
26
|
+
| -------------------------------- | --------- | ------------------ |
|
|
27
|
+
| `ENABLED` (`vne:potato:enabled`) | `boolean` | Enable or disable. |
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## Modules
|
|
30
30
|
|
|
31
|
-
|
|
|
32
|
-
| -------- |
|
|
33
|
-
| `potato` |
|
|
31
|
+
| Module | Role |
|
|
32
|
+
| -------- | ---------------------- |
|
|
33
|
+
| `potato` | Handles EMIT, CHANGED. |
|
|
34
34
|
|
|
35
|
-
##
|
|
35
|
+
## Related plugins
|
|
36
36
|
|
|
37
37
|
### plugins/core/
|
|
38
38
|
|
|
39
39
|
- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT
|
|
40
40
|
|
|
41
|
-
###
|
|
41
|
+
### Other
|
|
42
42
|
|
|
43
|
-
—
|
|
43
|
+
— None
|
|
@@ -1,34 +1,34 @@
|
|
|
1
1
|
# plugins/settings/ratio/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.settings.ratio` · namespace: `RATIO`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Constrains app size to a 16:9 aspect ratio.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
None.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Constants
|
|
12
12
|
|
|
13
|
-
- **`LOGS_ACTIONS.SET`** — `"set"`:
|
|
13
|
+
- **`LOGS_ACTIONS.SET`** — `"set"`: log label when ratio changes.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Settings
|
|
20
20
|
|
|
21
|
-
|
|
|
22
|
-
| --------------------------- | --------- |
|
|
23
|
-
| `VALUE` (`vne:ratio:value`) | `boolean` |
|
|
21
|
+
| Key | Type | Meaning |
|
|
22
|
+
| --------------------------- | --------- | ----------------------------------------------- |
|
|
23
|
+
| `VALUE` (`vne:ratio:value`) | `boolean` | Setting `vne:ratio:value` in `shared.settings`. |
|
|
24
24
|
|
|
25
|
-
##
|
|
25
|
+
## Modules
|
|
26
26
|
|
|
27
|
-
|
|
|
28
|
-
| ------- |
|
|
29
|
-
| `ratio` |
|
|
27
|
+
| Module | Role |
|
|
28
|
+
| ------- | ------------------------- |
|
|
29
|
+
| `ratio` | Handles CHANGED, STARTED. |
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Related plugins
|
|
32
32
|
|
|
33
33
|
### plugins/core/
|
|
34
34
|
|
|
@@ -36,6 +36,6 @@
|
|
|
36
36
|
- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT
|
|
37
37
|
- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED, CONST.DOM_IDS.APP
|
|
38
38
|
|
|
39
|
-
###
|
|
39
|
+
### Other
|
|
40
40
|
|
|
41
|
-
—
|
|
41
|
+
— None
|
|
@@ -1,39 +1,39 @@
|
|
|
1
1
|
# plugins/settings/textsize/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.settings.textsize` · namespace: `TEXTSIZE`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Changes text scale via CSS variable --vne-text-size-multiplicator.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
None.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Constants
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
None.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Settings
|
|
20
20
|
|
|
21
|
-
|
|
|
22
|
-
| ------------------------------ | -------- |
|
|
23
|
-
| `VALUE` (`vne:textsize:value`) | `number` |
|
|
21
|
+
| Key | Type | Meaning |
|
|
22
|
+
| ------------------------------ | -------- | -------------------------------------------------- |
|
|
23
|
+
| `VALUE` (`vne:textsize:value`) | `number` | Setting `vne:textsize:value` in `shared.settings`. |
|
|
24
24
|
|
|
25
|
-
##
|
|
25
|
+
## Modules
|
|
26
26
|
|
|
27
|
-
|
|
|
28
|
-
| ---------- |
|
|
29
|
-
| `textsize` |
|
|
27
|
+
| Module | Role |
|
|
28
|
+
| ---------- | ------------------ |
|
|
29
|
+
| `textsize` | `textsize` module. |
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Related plugins
|
|
32
32
|
|
|
33
33
|
### plugins/core/
|
|
34
34
|
|
|
35
35
|
- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT
|
|
36
36
|
|
|
37
|
-
###
|
|
37
|
+
### Other
|
|
38
38
|
|
|
39
|
-
—
|
|
39
|
+
— None
|
|
@@ -1,41 +1,41 @@
|
|
|
1
1
|
# plugins/settings/volume/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.settings.volume` · namespace: `VOLUME`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Initializes master, audio, and video volume settings.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
None.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Constants
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
None.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Settings
|
|
20
20
|
|
|
21
|
-
|
|
|
22
|
-
| ------------------------------ | -------- |
|
|
23
|
-
| `COMMON` (`vne:volume:common`) | `string` |
|
|
24
|
-
| `AUDIO` (`vne:volume:audio`) | `string` |
|
|
25
|
-
| `VIDEO` (`vne:volume:video`) | `number` |
|
|
21
|
+
| Key | Type | Meaning |
|
|
22
|
+
| ------------------------------ | -------- | ------------------------------------------------- |
|
|
23
|
+
| `COMMON` (`vne:volume:common`) | `string` | Setting `vne:volume:common` in `shared.settings`. |
|
|
24
|
+
| `AUDIO` (`vne:volume:audio`) | `string` | Setting `vne:volume:audio` in `shared.settings`. |
|
|
25
|
+
| `VIDEO` (`vne:volume:video`) | `number` | Setting `vne:volume:video` in `shared.settings`. |
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Modules
|
|
28
28
|
|
|
29
|
-
|
|
|
30
|
-
| -------- |
|
|
31
|
-
| `volume` |
|
|
29
|
+
| Module | Role |
|
|
30
|
+
| -------- | ---------------- |
|
|
31
|
+
| `volume` | `volume` module. |
|
|
32
32
|
|
|
33
|
-
##
|
|
33
|
+
## Related plugins
|
|
34
34
|
|
|
35
35
|
### plugins/core/
|
|
36
36
|
|
|
37
37
|
- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.INIT
|
|
38
38
|
|
|
39
|
-
###
|
|
39
|
+
### Other
|
|
40
40
|
|
|
41
|
-
—
|
|
41
|
+
— None
|
package/plugins/text/inject.md
CHANGED
|
@@ -1,43 +1,43 @@
|
|
|
1
1
|
# plugins/text/inject/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.text.inject` · namespace: `TEXT_INJECT`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Substitutes dynamic values into text through registered inject handlers.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.text.inject`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------ | ---------------------- |
|
|
13
|
-
| `REG` | `vne:text_inject:reg` |
|
|
14
|
-
| `EMIT` | `vne:text_inject:emit` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------ | ---------------------- | ------------------------------------- |
|
|
13
|
+
| `REG` | `vne:text_inject:reg` | Register a handler by module name. |
|
|
14
|
+
| `EMIT` | `vne:text_inject:emit` | Run one `%key%` substitution in text. |
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Constants
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
None.
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Parameters
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
None.
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Settings
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
None.
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Modules
|
|
29
29
|
|
|
30
|
-
|
|
|
31
|
-
| --------------------- |
|
|
32
|
-
| `text.inject` |
|
|
33
|
-
| `text.inject.replace` |
|
|
30
|
+
| Module | Role |
|
|
31
|
+
| --------------------- | ---------------------------------------------------------------------------- |
|
|
32
|
+
| `text.inject` | Register in `TEXT.REPLACE_REG`; loop over `args.inject`, delegate to `EMIT`. |
|
|
33
|
+
| `text.inject.replace` | `REG` handler registry; handles `EMIT`. |
|
|
34
34
|
|
|
35
|
-
##
|
|
35
|
+
## Related plugins
|
|
36
36
|
|
|
37
37
|
### plugins/core/
|
|
38
38
|
|
|
39
|
-
—
|
|
39
|
+
— None
|
|
40
40
|
|
|
41
|
-
###
|
|
41
|
+
### Other
|
|
42
42
|
|
|
43
43
|
- [text.md](./text.md) — `TEXT`: EVENTS.REPLACE, EVENTS.REPLACE_REG
|