@vnejs/docs 0.2.65 → 0.2.66
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
|
@@ -1,53 +1,53 @@
|
|
|
1
|
-
# plugins/views
|
|
1
|
+
# plugins/views/scenario/choose/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.views.scenario.choose` · namespace: `CHOOSE_VIEW`
|
|
4
4
|
|
|
5
|
-
React
|
|
5
|
+
React UI for choosing text options. Depends on the scenario plugin [choose.md](../scenario/choose.md) (`CHOOSE`): listens to `SHOW` / `HIDE`, emits `OPTION` when the player picks one.
|
|
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.views.scenario.choose`.
|
|
10
10
|
|
|
11
|
-
|
|
|
11
|
+
| Key | String | Meaning |
|
|
12
12
|
| -------------- | ------------------------------ | ---------------------------------------------------------------------- |
|
|
13
|
-
| `SHOW` | `vne:choose_view:show` |
|
|
14
|
-
| `HIDE` | `vne:choose_view:hide` |
|
|
15
|
-
| `UPDATE` | `vne:choose_view:update` |
|
|
16
|
-
| `UPDATE_STATE` | `vne:choose_view:update_state` |
|
|
17
|
-
| `UPDATE_FAST` | `vne:choose_view:update_fast` |
|
|
18
|
-
| `UPDATE_FORCE` | `vne:choose_view:update_force` |
|
|
19
|
-
| `ACCEPT` | `vne:choose_view:accept` | `ACCEPT` / `INTERACT` → `CHOOSE.OPTION`
|
|
13
|
+
| `SHOW` | `vne:choose_view:show` | Show the choice UI. |
|
|
14
|
+
| `HIDE` | `vne:choose_view:hide` | Hide the choice UI. |
|
|
15
|
+
| `UPDATE` | `vne:choose_view:update` | Update the React store / display. |
|
|
16
|
+
| `UPDATE_STATE` | `vne:choose_view:update_state` | Merge a partial into the controller state without an UPDATE view. |
|
|
17
|
+
| `UPDATE_FAST` | `vne:choose_view:update_fast` | Redraw the view with `isFast`; state does not change. |
|
|
18
|
+
| `UPDATE_FORCE` | `vne:choose_view:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
19
|
+
| `ACCEPT` | `vne:choose_view:accept` | `ACCEPT` / `INTERACT` → `CHOOSE.OPTION` by `currentArrowVerticalItem`. |
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
Scenario events (`EMIT`, `OPTION`, `SHOW`, `HIDE`, `SKIP`, `EXEC_*`, `STATE_UPDATE`) — contract `@vnejs/contracts.scenario.choose`, namespace `CHOOSE`.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Constants
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
None.
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Parameters
|
|
28
28
|
|
|
29
|
-
|
|
|
30
|
-
| --------------------- | -------- |
|
|
31
|
-
| `TRANSITION` | `number` |
|
|
32
|
-
| `ZINDEX` | `number` |
|
|
33
|
-
| `VIEW_PROPS` | `object` |
|
|
34
|
-
| `CONTROLS_EXTENSIONS` | `object` |
|
|
29
|
+
| Key | Type | Meaning |
|
|
30
|
+
| --------------------- | -------- | --------------------------------------------------------------------- |
|
|
31
|
+
| `TRANSITION` | `number` | Show/hide animation duration (ms). |
|
|
32
|
+
| `ZINDEX` | `number` | Layer z-index and controls block index. |
|
|
33
|
+
| `VIEW_PROPS` | `object` | Screen, PositionBox, Flex-wrap, title Text, TextControls, Text props. |
|
|
34
|
+
| `CONTROLS_EXTENSIONS` | `object` | Extra controls handlers. |
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Settings
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
None.
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Modules
|
|
41
41
|
|
|
42
|
-
|
|
|
43
|
-
| ------------------------------- |
|
|
44
|
-
| `choose_view.bridge` | Bridge `CHOOSE.SHOW/HIDE` → `CHOOSE_VIEW.SHOW/HIDE`.
|
|
45
|
-
| `choose_view.controller` | `CONTROLS_EXTENSIONS`
|
|
46
|
-
| `choose_view.controller.accept` |
|
|
47
|
-
| `choose_view.controller.arrows` |
|
|
48
|
-
| `choose_view.view` | React-render
|
|
42
|
+
| Module | Role |
|
|
43
|
+
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
44
|
+
| `choose_view.bridge` | Bridge `CHOOSE.SHOW/HIDE` → `CHOOSE_VIEW.SHOW/HIDE`. |
|
|
45
|
+
| `choose_view.controller` | `CONTROLS_EXTENSIONS` merges into `CONTROLS` in `ModuleController.init`; on `SHOW` + `LIFECYCLE_PRIORITY.SHOW.BEFORE` copies `globalState.choose`; state reset on `HIDE.CLEANUP` is done by `ModuleController` (`SHOULD_CLEAR_STATE_ON_CLEANUP`). Mirrors `UPDATE_STATE` / `UPDATE_FAST`. |
|
|
46
|
+
| `choose_view.controller.accept` | Extends `@vnejs/module.controller.accept`: `ACCEPT` / `INTERACT` → `ACCEPT` → `CHOOSE.OPTION` by `currentArrowVerticalItem`; mirrors `UPDATE_STATE`; PUSH/POP on SHOW/HIDE. |
|
|
47
|
+
| `choose_view.controller.arrows` | Extends `@vnejs/module.controller.arrows.vertical`: `ARROW_UP` / `ARROW_BOTTOM` over full `options[]`; skips `hided` via `isArrowItemAvailable` (index stays original); PUSH/POP on SHOW/HIDE; emits `UPDATE_STATE` with `{ currentArrowVerticalItem }` and `UPDATE_FAST`. On `HIDE.CLEANUP` `currentArrowVerticalItem` in state becomes `undefined`. |
|
|
48
|
+
| `choose_view.view` | React-render options; optional title from `args.title`. |
|
|
49
49
|
|
|
50
|
-
##
|
|
50
|
+
## Link to CHOOSE
|
|
51
51
|
|
|
52
52
|
```mermaid
|
|
53
53
|
sequenceDiagram
|
|
@@ -60,7 +60,7 @@ sequenceDiagram
|
|
|
60
60
|
OBS->>BR: bridge
|
|
61
61
|
BR->>OBS: vne:choose_view:show
|
|
62
62
|
OBS->>VC: onShow
|
|
63
|
-
Note over VC: SHOW BEFORE
|
|
63
|
+
Note over VC: SHOW BEFORE reads globalState.choose
|
|
64
64
|
VC->>OBS: vne:choose:option
|
|
65
65
|
OBS->>SC: onChooseOption
|
|
66
66
|
SC->>OBS: vne:choose:hide
|
|
@@ -68,7 +68,7 @@ sequenceDiagram
|
|
|
68
68
|
BR->>OBS: vne:choose_view:hide
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
##
|
|
71
|
+
## Related plugins
|
|
72
72
|
|
|
73
73
|
### plugins/scenario/
|
|
74
74
|
|
|
@@ -76,10 +76,10 @@ sequenceDiagram
|
|
|
76
76
|
|
|
77
77
|
### plugins/core/
|
|
78
78
|
|
|
79
|
-
- [state.md](../core/state.md) — restore
|
|
79
|
+
- [state.md](../core/state.md) — restore via `CHOOSE` + bridge
|
|
80
80
|
|
|
81
|
-
###
|
|
81
|
+
### Other
|
|
82
82
|
|
|
83
|
-
- [controls.md](../controls/controls.md) — `CONTROLS`:
|
|
84
|
-
- [interface.md](interface.md) — compatibility
|
|
85
|
-
- [qte.md](./qte.md) — `QTE_VIEW`:
|
|
83
|
+
- [controls.md](../controls/controls.md) — `CONTROLS`: arrows, ACCEPT, INTERACT
|
|
84
|
+
- [interface.md](interface.md) — compatibility hides interface on `CHOOSE_VIEW.SHOW` (`LIFECYCLE_PRIORITY.SHOW.BEFORE`)
|
|
85
|
+
- [qte.md](./qte.md) — `QTE_VIEW`: option with `qte:` opens above choose (z-index 1300 > 1200)
|
|
@@ -1,54 +1,54 @@
|
|
|
1
1
|
# plugins/views.scenario/interface.controls/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.views.scenario.interface.controls` · namespace: `INTERFACE_CONTROLS_VIEW`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Interface control buttons: hide, continue, and visibility toggle.
|
|
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.views.scenario.interface.controls`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | ------------------------------------- |
|
|
13
|
-
| `SHOW` | `vne:interface_controls:show` |
|
|
14
|
-
| `HIDE` | `vne:interface_controls:hide` |
|
|
15
|
-
| `UPDATE` | `vne:interface_controls:update` |
|
|
16
|
-
| `UPDATE_FAST` | `vne:interface_controls:update_fast` |
|
|
17
|
-
| `UPDATE_FORCE` | `vne:interface_controls:update_force` |
|
|
18
|
-
| `UPDATE_STATE` | `vne:interface_controls:update_state` |
|
|
19
|
-
| `CLICK` | `vne:interface_controls:click` |
|
|
20
|
-
| `ICONS` | `vne:interface_controls:icons` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | ------------------------------------- | ------------------------------------------------------ |
|
|
13
|
+
| `SHOW` | `vne:interface_controls:show` | Show the UI or layer. |
|
|
14
|
+
| `HIDE` | `vne:interface_controls:hide` | Hide the UI or layer. |
|
|
15
|
+
| `UPDATE` | `vne:interface_controls:update` | Update state or display. |
|
|
16
|
+
| `UPDATE_FAST` | `vne:interface_controls:update_fast` | Fast display update. |
|
|
17
|
+
| `UPDATE_FORCE` | `vne:interface_controls:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
18
|
+
| `UPDATE_STATE` | `vne:interface_controls:update_state` | Merge a partial into the controller state. |
|
|
19
|
+
| `CLICK` | `vne:interface_controls:click` | Plugin `CLICK` namespace event. |
|
|
20
|
+
| `ICONS` | `vne:interface_controls:icons` | Plugin `ICONS` namespace event. |
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Constants
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
None.
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Parameters
|
|
27
27
|
|
|
28
|
-
|
|
|
29
|
-
| --------------------- | -------- |
|
|
30
|
-
| `VIEW_PROPS` | `string` |
|
|
31
|
-
| `ITEMS` | `string` |
|
|
32
|
-
| `CONTROLS_EXTENSIONS` | `string` |
|
|
28
|
+
| Key | Type | Meaning |
|
|
29
|
+
| --------------------- | -------- | ------------------------------- |
|
|
30
|
+
| `VIEW_PROPS` | `string` | Default: "VIEW_PROPS". |
|
|
31
|
+
| `ITEMS` | `string` | Default: "ITEMS". |
|
|
32
|
+
| `CONTROLS_EXTENSIONS` | `string` | Default: "CONTROLS_EXTENSIONS". |
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Settings
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
None.
|
|
37
37
|
|
|
38
|
-
##
|
|
38
|
+
## Modules
|
|
39
39
|
|
|
40
|
-
|
|
|
41
|
-
| ------------------------------- |
|
|
42
|
-
| `interface.controls.controller` |
|
|
43
|
-
| `interface.controls.view` |
|
|
40
|
+
| Module | Role |
|
|
41
|
+
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
42
|
+
| `interface.controls.controller` | Handles UPDATE, VISIBLE, INTERACT, SHOW, …. `CONTROLS_EXTENSIONS` merges into `CONTROLS` in `ModuleController.init`. `SHOULD_CLEAR_STATE_ON_CLEANUP` — `false`: hide does not reset `isVisible` and `view`, so the next `$ interface show` shows the buttons again. |
|
|
43
|
+
| `interface.controls.view` | Plugin `controls.view` submodule. |
|
|
44
44
|
|
|
45
|
-
##
|
|
45
|
+
## Related plugins
|
|
46
46
|
|
|
47
47
|
### plugins/core/
|
|
48
48
|
|
|
49
49
|
- [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
|
|
50
50
|
|
|
51
|
-
###
|
|
51
|
+
### Other
|
|
52
52
|
|
|
53
53
|
- [controls.md](../controls/controls.md) — `CONTROLS`: EVENTS.POP, EVENTS.PUSH, CONST.BUTTONS.INTERFACE_HIDE, CONST.BUTTONS.ARROW_RIGHT, CONST.BUTTONS.ARROW_BOTTOM, CONST.BUTTONS.ANY
|
|
54
54
|
- [interface.md](./interface.md) — `INTERFACE`: EVENTS.VISIBLE, EVENTS.INTERACT, EVENTS.SHOW_CHANGED, EVENTS.VIEW_CHANGED, EVENTS.STATE_CHANGED, EVENTS.VISIBLE_CHANGED
|
|
@@ -1,53 +1,53 @@
|
|
|
1
1
|
# plugins/views.scenario/interface.fastforward/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.views.scenario.interface.fastforward` · namespace: `INTERFACE_FASTFORWARD_VIEW`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Fast-forward mode button and indicator in the scenario interface.
|
|
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.views.scenario.interface.fastforward`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------------------- | --------------------------------------------- |
|
|
13
|
-
| `SHOW` | `vne:interface_fastforward:show` |
|
|
14
|
-
| `HIDE` | `vne:interface_fastforward:hide` |
|
|
15
|
-
| `CLICK` | `vne:interface_fastforward:click` |
|
|
16
|
-
| `UPDATE` | `vne:interface_fastforward:update` |
|
|
17
|
-
| `UPDATE_FAST` | `vne:interface_fastforward:update_fast` |
|
|
18
|
-
| `UPDATE_FORCE` | `vne:interface_fastforward:update_force` |
|
|
19
|
-
| `UPDATE_STATE` | `vne:interface_fastforward:update_state` |
|
|
20
|
-
| `DISABLE_ANIMATION` | `vne:interface_fastforward:disable_animation` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------------------- | --------------------------------------------- | ------------------------------------------------------ |
|
|
13
|
+
| `SHOW` | `vne:interface_fastforward:show` | Show the UI or layer. |
|
|
14
|
+
| `HIDE` | `vne:interface_fastforward:hide` | Hide the UI or layer. |
|
|
15
|
+
| `CLICK` | `vne:interface_fastforward:click` | Plugin `CLICK` namespace event. |
|
|
16
|
+
| `UPDATE` | `vne:interface_fastforward:update` | Update state or display. |
|
|
17
|
+
| `UPDATE_FAST` | `vne:interface_fastforward:update_fast` | Fast display update. |
|
|
18
|
+
| `UPDATE_FORCE` | `vne:interface_fastforward:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
19
|
+
| `UPDATE_STATE` | `vne:interface_fastforward:update_state` | Merge a partial into the controller state. |
|
|
20
|
+
| `DISABLE_ANIMATION` | `vne:interface_fastforward:disable_animation` | Plugin `DISABLE_ANIMATION` namespace event. |
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Constants
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
None.
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Parameters
|
|
27
27
|
|
|
28
|
-
|
|
|
29
|
-
| ------------ | -------- |
|
|
30
|
-
| `VIEW_PROPS` | `string` |
|
|
28
|
+
| Key | Type | Meaning |
|
|
29
|
+
| ------------ | -------- | ---------------------- |
|
|
30
|
+
| `VIEW_PROPS` | `string` | Default: "VIEW_PROPS". |
|
|
31
31
|
|
|
32
|
-
##
|
|
32
|
+
## Settings
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
None.
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Modules
|
|
37
37
|
|
|
38
|
-
|
|
|
39
|
-
| ---------------------------------- |
|
|
40
|
-
| `interface.fastforward.controller` |
|
|
41
|
-
| `interface.fastforward.view` |
|
|
38
|
+
| Module | Role |
|
|
39
|
+
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
40
|
+
| `interface.fastforward.controller` | Handles UPDATE, TOGGLE, START, STOP, …. `SHOULD_CLEAR_STATE_ON_CLEANUP` — `false`: hide does not reset `isVisible` and `view`, so the next `$ interface show` shows the button again. |
|
|
41
|
+
| `interface.fastforward.view` | Plugin `fastforward.view` submodule. |
|
|
42
42
|
|
|
43
|
-
##
|
|
43
|
+
## Related plugins
|
|
44
44
|
|
|
45
45
|
### plugins/core/
|
|
46
46
|
|
|
47
47
|
- [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
|
|
48
48
|
- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
|
|
49
49
|
|
|
50
|
-
###
|
|
50
|
+
### Other
|
|
51
51
|
|
|
52
52
|
- [controls.md](../controls/controls.md) — `CONTROLS`: EVENTS.POP, EVENTS.PUSH, CONST.BUTTONS.FASTFORWARD_TOGGLE, CONST.BUTTONS.FASTFORWARD_START, CONST.BUTTONS.FASTFORWARD_FINISH
|
|
53
53
|
- [fastforward.md](../scenario/fastforward.md) — `FASTFORWARD`: EVENTS.TOGGLE, EVENTS.START, EVENTS.STOP, EVENTS.CHANGED
|
|
@@ -1,84 +1,84 @@
|
|
|
1
|
-
# plugins/views
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
##
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
|
12
|
-
| ----------------- | ------------------------------- |
|
|
13
|
-
| `SHOW` | `vne:interface:show` |
|
|
14
|
-
| `HIDE` | `vne:interface:hide` |
|
|
15
|
-
| `SHOW_CHANGED` | `vne:interface:show_changed` |
|
|
16
|
-
| `VIEW_SHOW` | `vne:interface:view_show` |
|
|
17
|
-
| `VIEW_HIDE` | `vne:interface:view_hide` |
|
|
18
|
-
| `VIEW_UPDATE` | `vne:interface:view_update` |
|
|
19
|
-
| `UPDATE_FAST` | `vne:interface:update_fast` |
|
|
20
|
-
| `UPDATE_FORCE` | `vne:interface:update_force` |
|
|
21
|
-
| `UPDATE_STATE` | `vne:interface:update_state` |
|
|
22
|
-
| `TEXT_HIDE` | `vne:interface:text_hide` |
|
|
23
|
-
| `TEXT_CHANGED` | `vne:interface:text_changed` |
|
|
24
|
-
| `WALL_CHANGED` | `vne:interface:wall_changed` |
|
|
25
|
-
| `SPEAKER_CHANGED` | `vne:interface:speaker_changed` |
|
|
26
|
-
| `VISIBLE` | `vne:interface:visible` |
|
|
27
|
-
| `VISIBLE_CHANGED` | `vne:interface:visible_changed` |
|
|
28
|
-
| `VIEW` | `vne:interface:view` |
|
|
29
|
-
| `VIEW_CHANGED` | `vne:interface:view_changed` |
|
|
30
|
-
| `INTERACT` | `vne:interface:interact` |
|
|
31
|
-
| `STATE_CHANGED` | `vne:interface:state_changed` |
|
|
32
|
-
|
|
33
|
-
##
|
|
34
|
-
|
|
35
|
-
|
|
|
36
|
-
| ------------------- |
|
|
37
|
-
| `EXEC_ACTIONS.SHOW` | `show`
|
|
38
|
-
| `EXEC_ACTIONS.HIDE` | `hide`
|
|
39
|
-
| `EXEC_ACTIONS.VIEW` | `view`
|
|
40
|
-
|
|
41
|
-
##
|
|
42
|
-
|
|
43
|
-
|
|
|
44
|
-
| -------------- | -------- |
|
|
45
|
-
| `DEFAULT_VIEW` | `string` |
|
|
46
|
-
| `LOC_LABEL` | `string` |
|
|
47
|
-
| `TRANSITION` | `string` |
|
|
48
|
-
| `ZINDEX` | `string` |
|
|
49
|
-
| `VIEW_PROPS` | `string` |
|
|
50
|
-
|
|
51
|
-
##
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
##
|
|
56
|
-
|
|
57
|
-
|
|
|
58
|
-
| ----------------------------- |
|
|
59
|
-
| `interface.controller` |
|
|
60
|
-
| `interface.controller.accept` |
|
|
61
|
-
| `interface` | STATE.SET / STATE.CLEAR → STATE_CHANGED.
|
|
62
|
-
| `interface.scenario` | `$ interface`: `LINE_EXEC_REG` → SHOW / HIDE / VIEW
|
|
63
|
-
| `interface.actions` | VISIBLE / TEXT_HIDE / VIEW
|
|
64
|
-
| `interface.actions.show` |
|
|
65
|
-
| `interface.view` | `isForce`
|
|
1
|
+
# plugins/views/scenario/interface/
|
|
2
|
+
|
|
3
|
+
Package: `@vnejs/plugins.views.scenario.interface` · namespace: `INTERFACE`
|
|
4
|
+
|
|
5
|
+
Controls the dialogue interface: show, hide, visibility, and text display.
|
|
6
|
+
|
|
7
|
+
## Events
|
|
8
|
+
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.views.scenario.interface`.
|
|
10
|
+
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ----------------- | ------------------------------- | ------------------------------------------------------ |
|
|
13
|
+
| `SHOW` | `vne:interface:show` | Show the UI or layer. |
|
|
14
|
+
| `HIDE` | `vne:interface:hide` | Hide the UI or layer. |
|
|
15
|
+
| `SHOW_CHANGED` | `vne:interface:show_changed` | Show the UI or layer. |
|
|
16
|
+
| `VIEW_SHOW` | `vne:interface:view_show` | Show the UI or layer. |
|
|
17
|
+
| `VIEW_HIDE` | `vne:interface:view_hide` | Hide the UI or layer. |
|
|
18
|
+
| `VIEW_UPDATE` | `vne:interface:view_update` | Update state or display. |
|
|
19
|
+
| `UPDATE_FAST` | `vne:interface:update_fast` | Fast display update. |
|
|
20
|
+
| `UPDATE_FORCE` | `vne:interface:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
21
|
+
| `UPDATE_STATE` | `vne:interface:update_state` | Merge a partial into the controller state. |
|
|
22
|
+
| `TEXT_HIDE` | `vne:interface:text_hide` | Hide the UI or layer. |
|
|
23
|
+
| `TEXT_CHANGED` | `vne:interface:text_changed` | Record a state change. |
|
|
24
|
+
| `WALL_CHANGED` | `vne:interface:wall_changed` | Record a state change. |
|
|
25
|
+
| `SPEAKER_CHANGED` | `vne:interface:speaker_changed` | Record the current speaker change. |
|
|
26
|
+
| `VISIBLE` | `vne:interface:visible` | Plugin `VISIBLE` namespace event. |
|
|
27
|
+
| `VISIBLE_CHANGED` | `vne:interface:visible_changed` | Record a state change. |
|
|
28
|
+
| `VIEW` | `vne:interface:view` | Plugin `VIEW` namespace event. |
|
|
29
|
+
| `VIEW_CHANGED` | `vne:interface:view_changed` | Record a state change. |
|
|
30
|
+
| `INTERACT` | `vne:interface:interact` | Plugin `INTERACT` namespace event. |
|
|
31
|
+
| `STATE_CHANGED` | `vne:interface:state_changed` | Signal that accumulated state changed. |
|
|
32
|
+
|
|
33
|
+
## Constants
|
|
34
|
+
|
|
35
|
+
| Key | Value | Meaning |
|
|
36
|
+
| ------------------- | ------ | ------------------------------------- |
|
|
37
|
+
| `EXEC_ACTIONS.SHOW` | `show` | Scenario action `$ interface show`. |
|
|
38
|
+
| `EXEC_ACTIONS.HIDE` | `hide` | Scenario action `$ interface hide`. |
|
|
39
|
+
| `EXEC_ACTIONS.VIEW` | `view` | Scenario action `$ interface view …`. |
|
|
40
|
+
|
|
41
|
+
## Parameters
|
|
42
|
+
|
|
43
|
+
| Key | Type | Meaning |
|
|
44
|
+
| -------------- | -------- | -------------------------- |
|
|
45
|
+
| `DEFAULT_VIEW` | `string` | Default: "DEFAULT_VIEW". |
|
|
46
|
+
| `LOC_LABEL` | `string` | Label name or entry point. |
|
|
47
|
+
| `TRANSITION` | `string` | Default: "TRANSITION". |
|
|
48
|
+
| `ZINDEX` | `string` | Default: "ZINDEX". |
|
|
49
|
+
| `VIEW_PROPS` | `string` | Default: "VIEW_PROPS". |
|
|
50
|
+
|
|
51
|
+
## Settings
|
|
52
|
+
|
|
53
|
+
None.
|
|
54
|
+
|
|
55
|
+
## Modules
|
|
56
|
+
|
|
57
|
+
| Module | Role |
|
|
58
|
+
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
59
|
+
| `interface.controller` | Handles VIEW_UPDATE, VIEW_SHOW, VIEW_HIDE, …. Empty `controls` on `ZINDEX`; `CONTROLS_UNVISIBLE` when the layer hides. `SHOULD_CLEAR_STATE_ON_CLEANUP` — `false`, so text and backdrop survive hide. |
|
|
60
|
+
| `interface.controller.accept` | Extends `@vnejs/module.controller.accept`: `ACCEPT` / `INTERACT` → `INTERFACE.INTERACT`; visible layer → `INTERACT.EMIT`, hidden → `INTERFACE.VISIBLE`; PUSH/POP on VIEW_SHOW/HIDE. |
|
|
61
|
+
| `interface` | STATE.SET / STATE.CLEAR → STATE_CHANGED. |
|
|
62
|
+
| `interface.scenario` | `$ interface`: `LINE_EXEC_REG` → SHOW / HIDE / VIEW per `CONST.INTERFACE.EXEC_ACTIONS`. |
|
|
63
|
+
| `interface.actions` | VISIBLE / TEXT_HIDE / VIEW through `globalState.interface`. |
|
|
64
|
+
| `interface.actions.show` | Subscribes to `SHOW` and `HIDE`. On `GATE` (`breakFollowing`): if the interface is already in the target state or a show/hide cycle is running, other subscribers on these events are not called. Showing a hidden layer sends `VISIBLE`. |
|
|
65
|
+
| `interface.view` | `isForce` reaches `SmoothText` in `InterfaceViewDialog`, `InterfaceViewLine`, and `InterfaceViewWall`. |
|
|
66
66
|
|
|
67
67
|
## Compatibility
|
|
68
68
|
|
|
69
69
|
### `compatibility/views.scenario.interface/text/`
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Package: `@vnejs/compatibility.views.scenario.interface-with-text`
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
On `TEXT.CHANGED` emits `INTERFACE.TEXT_CHANGED` (`tokensVisible` = token length when `shared.interfaceTextShowAllTokensOnChange`). On `TEXT.SPEAKER_CHANGED` — `INTERFACE.SPEAKER_CHANGED`. In `postinject` sets the flag to `true`; in `init` registers `TEXT.EMIT_BEFORE` → `INTERFACE.SHOW`. Wired in `bundles/vn.skeleton`.
|
|
74
74
|
|
|
75
75
|
### `compatibility/views.scenario.interface/text.smooth/`
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
Package: `@vnejs/compatibility.views.scenario.interface-with-text.smooth`
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
On `TEXT_SMOOTH.CHANGED` emits `INTERFACE.TEXT_CHANGED` with `tokens` from `globalState.text`, `tokensVisible`, and `uid`. In `start` sets `shared.interfaceTextShowAllTokensOnChange` to `false`.
|
|
80
80
|
|
|
81
|
-
##
|
|
81
|
+
## Related plugins
|
|
82
82
|
|
|
83
83
|
### plugins/core/
|
|
84
84
|
|
|
@@ -86,9 +86,9 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
86
86
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.NEXT, EVENTS.LINE_EXEC_REG
|
|
87
87
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
88
88
|
|
|
89
|
-
###
|
|
89
|
+
### Other
|
|
90
90
|
|
|
91
91
|
- [controls.md](../controls/controls.md) — `CONTROLS`: EVENTS.POP, EVENTS.PUSH
|
|
92
|
-
- [text.md](../text/text.md) — `TEXT`:
|
|
93
|
-
- [choose.md](./choose.md) — compatibility
|
|
94
|
-
- [qte.md](./qte.md) — compatibility
|
|
92
|
+
- [text.md](../text/text.md) — `TEXT`: link via compatibility above (`CHANGED`, `SPEAKER_CHANGED`, `EMIT_BEFORE`)
|
|
93
|
+
- [choose.md](./choose.md) — compatibility hides interface on `CHOOSE_VIEW.SHOW` (`LIFECYCLE_PRIORITY.SHOW.BEFORE`)
|
|
94
|
+
- [qte.md](./qte.md) — compatibility hides interface on `QTE_VIEW.SHOW` (`LIFECYCLE_PRIORITY.SHOW.BEFORE`)
|