@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
package/plugins/audio/sound.md
CHANGED
|
@@ -1,39 +1,39 @@
|
|
|
1
1
|
# plugins/audio/sound/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.audio.sound` · namespace: `SOUND`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Play sound effects from scenario with a separate volume.
|
|
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
|
-
| `VOLUME` (`vne:sound:volume`) | `number` |
|
|
21
|
+
| Key | Type | Meaning |
|
|
22
|
+
| ----------------------------- | -------- | ------------- |
|
|
23
|
+
| `VOLUME` (`vne:sound:volume`) | `number` | Volume level. |
|
|
24
24
|
|
|
25
|
-
##
|
|
25
|
+
## Modules
|
|
26
26
|
|
|
27
|
-
|
|
|
28
|
-
| ------- |
|
|
29
|
-
| `sound` |
|
|
27
|
+
| Module | Role |
|
|
28
|
+
| ------- | --------------- |
|
|
29
|
+
| `sound` | `sound` module. |
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Related plugins
|
|
32
32
|
|
|
33
33
|
### plugins/core/
|
|
34
34
|
|
|
35
|
-
—
|
|
35
|
+
— None
|
|
36
36
|
|
|
37
|
-
###
|
|
37
|
+
### Other
|
|
38
38
|
|
|
39
|
-
—
|
|
39
|
+
— None
|
package/plugins/audio/voice.md
CHANGED
|
@@ -1,43 +1,43 @@
|
|
|
1
1
|
# plugins/audio/voice/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.audio.voice` · namespace: `VOICE`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Line voice-over without loop, reset on interact, and voice language setting.
|
|
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
|
-
|
|
|
18
|
-
| -------------- | -------- |
|
|
19
|
-
| `DEFAULT_LANG` | `string` |
|
|
17
|
+
| Key | Type | Meaning |
|
|
18
|
+
| -------------- | -------- | ---------------- |
|
|
19
|
+
| `DEFAULT_LANG` | `string` | Default: `"ru"`. |
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Settings
|
|
22
22
|
|
|
23
|
-
|
|
|
24
|
-
| ----------------------------- | -------- |
|
|
25
|
-
| `VOLUME` (`vne:voice:volume`) | `number` |
|
|
26
|
-
| `LANG` (`vne:voice:lang`) | `string` |
|
|
23
|
+
| Key | Type | Meaning |
|
|
24
|
+
| ----------------------------- | -------- | ---------------------------------------------- |
|
|
25
|
+
| `VOLUME` (`vne:voice:volume`) | `number` | Volume level. |
|
|
26
|
+
| `LANG` (`vne:voice:lang`) | `string` | Setting `vne:voice:lang` in `shared.settings`. |
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Modules
|
|
29
29
|
|
|
30
|
-
|
|
|
31
|
-
| ------------ |
|
|
32
|
-
| `voice` |
|
|
33
|
-
| `voice.lang` |
|
|
30
|
+
| Module | Role |
|
|
31
|
+
| ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
32
|
+
| `voice` | `voice` module. |
|
|
33
|
+
| `voice.lang` | In `postinject` — `shared.voiceDisableSources`; `SETTINGS.INIT` LANG in `setup`; `voiceLang` in `init`. |
|
|
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
|
package/plugins/canvas/bg.md
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
# plugins/canvas/bg/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.child.bg` · namespace: `LAYER_BG`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Show, hide, change, and preload images on canvas layers.
|
|
6
6
|
|
|
7
7
|
## SHOW vs CHANGE
|
|
8
8
|
|
|
9
|
-
- **`SHOW`** —
|
|
10
|
-
- **`CHANGE`** —
|
|
11
|
-
- Bg
|
|
9
|
+
- **`SHOW`** — new child (often fade via `opacity`); remove old ones when needed.
|
|
10
|
+
- **`CHANGE`** — change `src` on an existing child. When `duration > 0`: `transition` → `waitRerender` → change `src` (like `sprite.move`), without the opacity crossfade of `SHOW`.
|
|
11
|
+
- Bg `Image` always has `isSwitchDisabled` — the overlay `src` array does not rotate like slideshow frames.
|
|
12
12
|
|
|
13
13
|
## Overlays
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
In scenario or event args, `overlays?: Record<string, string>` defines layers on top of base `{name}/index`: each key `key → value` resolves to media `{name}/{key}/{value}`.
|
|
16
16
|
|
|
17
17
|
```vne
|
|
18
18
|
$ bl.bg show {castle/surgery_room} opacity 500
|
|
@@ -21,55 +21,55 @@ $ bl.bg show {castle/surgery_room} opacity 500
|
|
|
21
21
|
man: 1
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
- `PRELOAD` / `SRC_GET` / show / change
|
|
25
|
-
- `ARGS_INJECT` (
|
|
26
|
-
-
|
|
24
|
+
- `PRELOAD` / `SRC_GET` / show / change read `overlays` from payload or `args`.
|
|
25
|
+
- `ARGS_INJECT` (for example [bg.speak.md](./bg.speak.md)) can append `overlays` to args before src resolve.
|
|
26
|
+
- On the layer, the child draws via `src` (URL array: index + overlays), not via the React `overlays` prop.
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Events
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.bg`.
|
|
31
31
|
|
|
32
|
-
|
|
|
33
|
-
| --------------- | ---------------------------- |
|
|
34
|
-
| `SHOW` | `vne:layer_bg:show` |
|
|
35
|
-
| `HIDE` | `vne:layer_bg:hide` |
|
|
36
|
-
| `CHANGE` | `vne:layer_bg:change` |
|
|
37
|
-
| `PRELOAD` | `vne:layer_bg:preload` |
|
|
38
|
-
| `SRC_GET` | `vne:layer_bg:src_get` |
|
|
39
|
-
| `ARGS_INJECT` | `vne:layer_bg:args_inject` |
|
|
40
|
-
| `STATE_RM` | `vne:layer_bg:state_rm` |
|
|
41
|
-
| `STATE_GET` | `vne:layer_bg:state_get` |
|
|
42
|
-
| `STATE_GET_ALL` | `vne:layer_bg:state_get_all` |
|
|
43
|
-
| `STATE_ADD` | `vne:layer_bg:state_add` |
|
|
44
|
-
| `STATE_UPDATE` | `vne:layer_bg:state_update` |
|
|
32
|
+
| Key | String | Meaning |
|
|
33
|
+
| --------------- | ---------------------------- | --------------------------------------------- |
|
|
34
|
+
| `SHOW` | `vne:layer_bg:show` | Ask handlers for data and continue the chain. |
|
|
35
|
+
| `HIDE` | `vne:layer_bg:hide` | Ask handlers for data and continue the chain. |
|
|
36
|
+
| `CHANGE` | `vne:layer_bg:change` | Ask handlers for data and continue the chain. |
|
|
37
|
+
| `PRELOAD` | `vne:layer_bg:preload` | Plugin namespace `PRELOAD` event. |
|
|
38
|
+
| `SRC_GET` | `vne:layer_bg:src_get` | Get a value or resource. |
|
|
39
|
+
| `ARGS_INJECT` | `vne:layer_bg:args_inject` | Plugin namespace `ARGS_INJECT` event. |
|
|
40
|
+
| `STATE_RM` | `vne:layer_bg:state_rm` | Plugin namespace `STATE_RM` event. |
|
|
41
|
+
| `STATE_GET` | `vne:layer_bg:state_get` | Get a value or resource. |
|
|
42
|
+
| `STATE_GET_ALL` | `vne:layer_bg:state_get_all` | Plugin namespace `STATE_GET_ALL` event. |
|
|
43
|
+
| `STATE_ADD` | `vne:layer_bg:state_add` | Plugin namespace `STATE_ADD` event. |
|
|
44
|
+
| `STATE_UPDATE` | `vne:layer_bg:state_update` | Update accumulated module state. |
|
|
45
45
|
|
|
46
|
-
##
|
|
46
|
+
## Constants
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
None.
|
|
49
49
|
|
|
50
|
-
##
|
|
50
|
+
## Parameters
|
|
51
51
|
|
|
52
|
-
|
|
|
53
|
-
| ------------------ | -------- |
|
|
54
|
-
| `TRANSITIONS_SHOW` | `string` |
|
|
55
|
-
| `TRANSITIONS_HIDE` | `string` |
|
|
52
|
+
| Key | Type | Meaning |
|
|
53
|
+
| ------------------ | -------- | ---------------------------- |
|
|
54
|
+
| `TRANSITIONS_SHOW` | `string` | Default: "TRANSITIONS_SHOW". |
|
|
55
|
+
| `TRANSITIONS_HIDE` | `string` | Default: "TRANSITIONS_HIDE". |
|
|
56
56
|
|
|
57
|
-
##
|
|
57
|
+
## Settings
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
None.
|
|
60
60
|
|
|
61
|
-
##
|
|
61
|
+
## Modules
|
|
62
62
|
|
|
63
|
-
|
|
|
64
|
-
| ------------------ |
|
|
65
|
-
| `layer.bg.show` |
|
|
66
|
-
| `layer.bg.hide` |
|
|
67
|
-
| `layer.bg.staff` |
|
|
68
|
-
| `layer.bg.state` |
|
|
69
|
-
| `layer.bg.change` |
|
|
70
|
-
| `layer.bg.preload` |
|
|
63
|
+
| Module | Role |
|
|
64
|
+
| ------------------ | ------------------------------------------------------------- |
|
|
65
|
+
| `layer.bg.show` | Plugin `image.show` submodule. |
|
|
66
|
+
| `layer.bg.hide` | Plugin `image.hide` submodule. |
|
|
67
|
+
| `layer.bg.staff` | Plugin `image.staff` submodule. |
|
|
68
|
+
| `layer.bg.state` | Handles STATE_UPDATE, STATE_GET, STATE_GET_ALL, STATE_ADD, …. |
|
|
69
|
+
| `layer.bg.change` | Plugin `image.change` submodule. |
|
|
70
|
+
| `layer.bg.preload` | Plugin `image.preload` submodule. |
|
|
71
71
|
|
|
72
|
-
##
|
|
72
|
+
## Related plugins
|
|
73
73
|
|
|
74
74
|
### plugins/core/
|
|
75
75
|
|
|
@@ -78,6 +78,6 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
78
78
|
- [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
|
|
79
79
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.PRELOAD
|
|
80
80
|
|
|
81
|
-
###
|
|
81
|
+
### Other
|
|
82
82
|
|
|
83
83
|
- [layer.md](./layer.md) — `LAYER`: EVENTS.UPDATE_FORCE, EVENTS.CHILD_CHANGE, EVENTS.CHILDS_RM, SETTINGS.QUALITY, EVENTS.CHILD_ADD
|
|
@@ -1,56 +1,56 @@
|
|
|
1
1
|
# plugins/canvas/bg.speak/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.bg.speak` · namespace: `LAYER_BG_SPEAK`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Switch image variants by the current line speaker.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
On `LAYER_BG.ARGS_INJECT` it returns `{ overlays: args.speak[speaker] }` — merged into [bg.md](./bg.md) args. On `PRELOAD` with `overlays` and `speak`, also preloads variants with speaker overrides.
|
|
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.canvas.child.bg.speak`.
|
|
12
12
|
|
|
13
|
-
|
|
|
14
|
-
| ---------------- | ----------------------------------- |
|
|
15
|
-
| `PUSH` | `vne:layer_bg_speak:push` |
|
|
16
|
-
| `POP` | `vne:layer_bg_speak:pop` |
|
|
17
|
-
| `SPEAKER` | `vne:layer_bg_speak:speaker` |
|
|
18
|
-
| `START` | `vne:layer_bg_speak:start` |
|
|
19
|
-
| `END` | `vne:layer_bg_speak:end` |
|
|
20
|
-
| `BGS_GET` | `vne:layer_bg_speak:bgs_get` |
|
|
21
|
-
| `BGS_GET_ACTIVE` | `vne:layer_bg_speak:bgs_get_active` |
|
|
22
|
-
| `OPTION_SET` | `vne:layer_bg_speak:option_set` |
|
|
13
|
+
| Key | String | Meaning |
|
|
14
|
+
| ---------------- | ----------------------------------- | --------------------------------------------- |
|
|
15
|
+
| `PUSH` | `vne:layer_bg_speak:push` | Add an item to a queue or stack. |
|
|
16
|
+
| `POP` | `vne:layer_bg_speak:pop` | Remove an item from a queue or stack. |
|
|
17
|
+
| `SPEAKER` | `vne:layer_bg_speak:speaker` | Ask handlers for data and continue the chain. |
|
|
18
|
+
| `START` | `vne:layer_bg_speak:start` | Start a process. |
|
|
19
|
+
| `END` | `vne:layer_bg_speak:end` | Ask handlers for data and continue the chain. |
|
|
20
|
+
| `BGS_GET` | `vne:layer_bg_speak:bgs_get` | Get a value or resource. |
|
|
21
|
+
| `BGS_GET_ACTIVE` | `vne:layer_bg_speak:bgs_get_active` | Plugin namespace `BGS_GET_ACTIVE` event. |
|
|
22
|
+
| `OPTION_SET` | `vne:layer_bg_speak:option_set` | Write or update a value. |
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Constants
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
None.
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Parameters
|
|
29
29
|
|
|
30
|
-
|
|
|
31
|
-
| -------------- | -------- |
|
|
32
|
-
| `MIN_DURATION` | `number` |
|
|
30
|
+
| Key | Type | Meaning |
|
|
31
|
+
| -------------- | -------- | -------------- |
|
|
32
|
+
| `MIN_DURATION` | `number` | Default: 2000. |
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Settings
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
None.
|
|
37
37
|
|
|
38
|
-
##
|
|
38
|
+
## Modules
|
|
39
39
|
|
|
40
|
-
|
|
|
41
|
-
| ------------------------- |
|
|
42
|
-
| `layer.bg.speak.sources` |
|
|
43
|
-
| `layer.bg.speak.duration` |
|
|
44
|
-
| `layer.bg.speak.preload` |
|
|
45
|
-
| `layer.bg.speak.staff` |
|
|
46
|
-
| `layer.bg.speak` |
|
|
40
|
+
| Module | Role |
|
|
41
|
+
| ------------------------- | ---------------------------------------------------------- |
|
|
42
|
+
| `layer.bg.speak.sources` | In `postinject` — `shared.layerBgSpeakSources`; PUSH, POP. |
|
|
43
|
+
| `layer.bg.speak.duration` | Plugin `image.speak.duration` submodule. |
|
|
44
|
+
| `layer.bg.speak.preload` | Plugin `image.speak.preload` submodule. |
|
|
45
|
+
| `layer.bg.speak.staff` | Handles ARGS_INJECT, BGS_GET, BGS_GET_ACTIVE, OPTION_SET. |
|
|
46
|
+
| `layer.bg.speak` | Handles END, START, SPEAKER. |
|
|
47
47
|
|
|
48
|
-
##
|
|
48
|
+
## Related plugins
|
|
49
49
|
|
|
50
50
|
### plugins/core/
|
|
51
51
|
|
|
52
|
-
—
|
|
52
|
+
— None
|
|
53
53
|
|
|
54
|
-
###
|
|
54
|
+
### Other
|
|
55
55
|
|
|
56
56
|
- [image.md](./image.md) — `LAYER_BG`: EVENTS.PRELOAD, EVENTS.ARGS_INJECT, EVENTS.CHANGE, EVENTS.STATE_GET_ALL
|
package/plugins/canvas/fill.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# plugins/canvas/fill/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.child.fill` · namespace: `LAYER_FILL`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Show, change, and hide a full-layer color fill on a canvas layer.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Scenario syntax
|
|
8
8
|
|
|
9
9
|
```
|
|
10
10
|
$ bl.fill show fillId1 {rgba(255, 255, 255, 0.5)} 300
|
|
@@ -12,57 +12,57 @@ $ bl.fill change fillId1 {rgba(0, 0, 0, 0.5)} 300
|
|
|
12
12
|
$ bl.fill hide fillId1 300
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Show/hide transition is always `opacity`. On layers `bl` / `ml` / `fl` / `ul`: `$ {layer}.fill …`.
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## Events
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.fill`.
|
|
20
20
|
|
|
21
|
-
|
|
|
22
|
-
| -------------- | ----------------------------- |
|
|
23
|
-
| `SHOW` | `vne:layer_fill:show` |
|
|
24
|
-
| `CHANGE` | `vne:layer_fill:change` |
|
|
25
|
-
| `HIDE` | `vne:layer_fill:hide` |
|
|
26
|
-
| `STATE_UPDATE` | `vne:layer_fill:state_update` |
|
|
27
|
-
| `STATE_GET` | `vne:layer_fill:state_get` |
|
|
28
|
-
| `STATE_ADD` | `vne:layer_fill:state_add` |
|
|
29
|
-
| `STATE_RM` | `vne:layer_fill:state_rm` |
|
|
21
|
+
| Key | String | Meaning |
|
|
22
|
+
| -------------- | ----------------------------- | --------------------------------- |
|
|
23
|
+
| `SHOW` | `vne:layer_fill:show` | Show fill by `id` and color. |
|
|
24
|
+
| `CHANGE` | `vne:layer_fill:change` | Change color of an existing fill. |
|
|
25
|
+
| `HIDE` | `vne:layer_fill:hide` | Hide fill by `id`. |
|
|
26
|
+
| `STATE_UPDATE` | `vne:layer_fill:state_update` | Update accumulated module state. |
|
|
27
|
+
| `STATE_GET` | `vne:layer_fill:state_get` | Get fill record by `id`. |
|
|
28
|
+
| `STATE_ADD` | `vne:layer_fill:state_add` | Add a record to state. |
|
|
29
|
+
| `STATE_RM` | `vne:layer_fill:state_rm` | Remove a record from state. |
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Constants
|
|
32
32
|
|
|
33
|
-
|
|
|
33
|
+
| Key | Meaning |
|
|
34
34
|
| ------------------ | -------------------------- |
|
|
35
35
|
| `ACTIONS` | `show` / `change` / `hide` |
|
|
36
36
|
| `LAYER_CHILD_TYPE` | `"fill"` |
|
|
37
37
|
|
|
38
|
-
##
|
|
38
|
+
## Parameters
|
|
39
39
|
|
|
40
|
-
|
|
|
40
|
+
| Key | Meaning |
|
|
41
41
|
| -------------------- | -------------------------- |
|
|
42
|
-
| `TRANSITIONS_SHOW` | Opacity fade-in
|
|
43
|
-
| `TRANSITIONS_HIDE` | Opacity fade-out
|
|
44
|
-
| `TRANSITIONS_CHANGE` | Transition
|
|
42
|
+
| `TRANSITIONS_SHOW` | Opacity fade-in for show. |
|
|
43
|
+
| `TRANSITIONS_HIDE` | Opacity fade-out for hide. |
|
|
44
|
+
| `TRANSITIONS_CHANGE` | Transition for change. |
|
|
45
45
|
|
|
46
|
-
##
|
|
46
|
+
## Settings
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
None.
|
|
49
49
|
|
|
50
|
-
##
|
|
50
|
+
## Modules
|
|
51
51
|
|
|
52
|
-
|
|
|
53
|
-
| ------------------- |
|
|
54
|
-
| `layer.fill.show` |
|
|
55
|
-
| `layer.fill.change` |
|
|
56
|
-
| `layer.fill.hide` |
|
|
57
|
-
| `layer.fill.state` | STATE_
|
|
52
|
+
| Module | Role |
|
|
53
|
+
| ------------------- | ------------------------------------------------- |
|
|
54
|
+
| `layer.fill.show` | Show fill on the layer. |
|
|
55
|
+
| `layer.fill.change` | Change fill color. |
|
|
56
|
+
| `layer.fill.hide` | Hide fill. |
|
|
57
|
+
| `layer.fill.state` | STATE_*; restore via `STATE.SET` / `STATE.CLEAR`. |
|
|
58
58
|
|
|
59
|
-
##
|
|
59
|
+
## Related plugins
|
|
60
60
|
|
|
61
61
|
### plugins/core/
|
|
62
62
|
|
|
63
63
|
- [interact.md](../core/interact.md) — `INTERACT`: EVENTS.PUSH_POP, EVENTS.PUSH, EVENTS.POP
|
|
64
64
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
65
65
|
|
|
66
|
-
###
|
|
66
|
+
### Other
|
|
67
67
|
|
|
68
68
|
- [layer.md](./layer.md) — `LAYER`: EVENTS.CHILD_ADD, EVENTS.CHILD_CHANGE, EVENTS.CHILD_RM, EVENTS.UPDATE_FORCE
|
package/plugins/canvas/layer.md
CHANGED
|
@@ -1,51 +1,51 @@
|
|
|
1
1
|
# plugins/canvas/layer/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.layer` · namespace: `LAYER`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Canvas quality and size via CSS variables. Viewport meta and `overflow: hidden` on `html`/`body` come from the game `entry/index.html`, not this plugin. `html` and `body` need `height: 100%`; `body` needs flex centering. Otherwise the 16:9 `#app` box from `ratio` sticks to the top of the window.
|
|
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.canvas.layer`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| --------------- | ------------------------- |
|
|
13
|
-
| `UPDATE_FORCE` | `vne:layer:update_force` |
|
|
14
|
-
| `UPDATE_FAST` | `vne:layer:update_fast` |
|
|
15
|
-
| `CHILD_RM` | `vne:layer:child_rm` |
|
|
16
|
-
| `CHILDS_RM` | `vne:layer:childs_rm` |
|
|
17
|
-
| `CHILD_ADD` | `vne:layer:child_add` |
|
|
18
|
-
| `CHILD_CHANGE` | `vne:layer:child_change` |
|
|
19
|
-
| `CHILDS_CHANGE` | `vne:layer:childs_change` |
|
|
20
|
-
| `CHILD_GET` | `vne:layer:child_get` |
|
|
21
|
-
| `PROPS_UPDATE` | `vne:layer:props_update` |
|
|
22
|
-
| `STATE_GET` | `vne:layer:state_get` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| --------------- | ------------------------- | --------------------------------------- |
|
|
13
|
+
| `UPDATE_FORCE` | `vne:layer:update_force` | Update state or display. |
|
|
14
|
+
| `UPDATE_FAST` | `vne:layer:update_fast` | Update state or display. |
|
|
15
|
+
| `CHILD_RM` | `vne:layer:child_rm` | Plugin namespace `CHILD_RM` event. |
|
|
16
|
+
| `CHILDS_RM` | `vne:layer:childs_rm` | Plugin namespace `CHILDS_RM` event. |
|
|
17
|
+
| `CHILD_ADD` | `vne:layer:child_add` | Plugin namespace `CHILD_ADD` event. |
|
|
18
|
+
| `CHILD_CHANGE` | `vne:layer:child_change` | Plugin namespace `CHILD_CHANGE` event. |
|
|
19
|
+
| `CHILDS_CHANGE` | `vne:layer:childs_change` | Plugin namespace `CHILDS_CHANGE` event. |
|
|
20
|
+
| `CHILD_GET` | `vne:layer:child_get` | Get a value or resource. |
|
|
21
|
+
| `PROPS_UPDATE` | `vne:layer:props_update` | Update state or display. |
|
|
22
|
+
| `STATE_GET` | `vne:layer:state_get` | Get a value or resource. |
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Constants
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
None.
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Parameters
|
|
29
29
|
|
|
30
|
-
|
|
|
31
|
-
| ----------------- | -------- |
|
|
32
|
-
| `DEFAULT_QUALITY` | `string` |
|
|
30
|
+
| Key | Type | Meaning |
|
|
31
|
+
| ----------------- | -------- | --------------------------- |
|
|
32
|
+
| `DEFAULT_QUALITY` | `string` | Default: "DEFAULT_QUALITY". |
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Settings
|
|
35
35
|
|
|
36
|
-
|
|
|
37
|
-
| -------------------------------- | -------- |
|
|
38
|
-
| `WIDTH` (`vne:canvas:width`) | `number` |
|
|
39
|
-
| `HEIGHT` (`vne:canvas:height`) | `number` |
|
|
40
|
-
| `QUALITY` (`vne:canvas:quality`) | `number` |
|
|
36
|
+
| Key | Type | Meaning |
|
|
37
|
+
| -------------------------------- | -------- | -------------------------------------------------- |
|
|
38
|
+
| `WIDTH` (`vne:canvas:width`) | `number` | `vne:canvas:width` setting in `shared.settings`. |
|
|
39
|
+
| `HEIGHT` (`vne:canvas:height`) | `number` | `vne:canvas:height` setting in `shared.settings`. |
|
|
40
|
+
| `QUALITY` (`vne:canvas:quality`) | `number` | `vne:canvas:quality` setting in `shared.settings`. |
|
|
41
41
|
|
|
42
|
-
##
|
|
42
|
+
## Modules
|
|
43
43
|
|
|
44
|
-
|
|
|
45
|
-
| --------------- |
|
|
46
|
-
| `layer.quality` |
|
|
44
|
+
| Module | Role |
|
|
45
|
+
| --------------- | ------------------------------------------------------------------------------- |
|
|
46
|
+
| `layer.quality` | Quality → CSS sizes and `SETTINGS.LAYER.WIDTH` / `HEIGHT`, then `MEMORY.CLEAR`. |
|
|
47
47
|
|
|
48
|
-
##
|
|
48
|
+
## Related plugins
|
|
49
49
|
|
|
50
50
|
### plugins/core/
|
|
51
51
|
|
|
@@ -53,6 +53,6 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
53
53
|
- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT, EVENTS.SET
|
|
54
54
|
- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED
|
|
55
55
|
|
|
56
|
-
###
|
|
56
|
+
### Other
|
|
57
57
|
|
|
58
|
-
—
|
|
58
|
+
— None
|