@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/canvas/sprite.md
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# plugins/canvas/sprite/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.sprite` · namespace: `LAYER_SPRITE`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Show, hide, move, and change sprites on canvas layers.
|
|
6
6
|
|
|
7
7
|
## Overlays
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Two related meanings of one name:
|
|
10
10
|
|
|
11
|
-
1. **Args /
|
|
12
|
-
2. **Layer child / React** —
|
|
11
|
+
1. **Args / scenario** — `args.overlays?: Record<string, string>`: layer map `emotion` / `hair` / `wear` → value; paths `{variation}/{key}/{value}` (+ `{variation}/index`).
|
|
12
|
+
2. **Layer child / React** — after `SRC_GET`, on the child and in `<Sprite />`, field `overlays` is a `{ src }` array for drawing.
|
|
13
13
|
|
|
14
14
|
```vne
|
|
15
15
|
$ ul.sprite show co left {co/default} opacity 500
|
|
@@ -21,58 +21,58 @@ $ ul.sprite show co left {co/default} opacity 500
|
|
|
21
21
|
|
|
22
22
|
`PARAMS.LAYER_SPRITE.SPRITE_INFO[type]`:
|
|
23
23
|
|
|
24
|
-
|
|
|
25
|
-
| -------------- |
|
|
26
|
-
| `mapOverlays?` |
|
|
27
|
-
| `getSrc?` |
|
|
24
|
+
| Field | Meaning |
|
|
25
|
+
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
+
| `mapOverlays?` | Transform the overlay map before path resolve |
|
|
27
|
+
| `getSrc?` | Custom src list from `(variation, realOverlays, options, otherArgs)`. Empty string and other falsy entries keep the slot and draw as a transparent image (no `MEDIA.GET` / `MEDIA.LOAD`). |
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## Events
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.canvas.child.sprite`.
|
|
32
32
|
|
|
33
|
-
|
|
|
34
|
-
| -------------- | ------------------------------- |
|
|
35
|
-
| `SHOW` | `vne:layer_sprite:show` |
|
|
36
|
-
| `HIDE` | `vne:layer_sprite:hide` |
|
|
37
|
-
| `MOVE` | `vne:layer_sprite:move` |
|
|
38
|
-
| `CHANGE` | `vne:layer_sprite:change` |
|
|
39
|
-
| `PRELOAD` | `vne:layer_sprite:preload` |
|
|
40
|
-
| `SRC_GET` | `vne:layer_sprite:src_get` |
|
|
41
|
-
| `STATE_UPDATE` | `vne:layer_sprite:state_update` |
|
|
42
|
-
| `STATE_GET` | `vne:layer_sprite:state_get` |
|
|
43
|
-
| `STATE_ADD` | `vne:layer_sprite:state_add` |
|
|
44
|
-
| `STATE_RM` | `vne:layer_sprite:state_rm` |
|
|
33
|
+
| Key | String | Meaning |
|
|
34
|
+
| -------------- | ------------------------------- | --------------------------------------------- |
|
|
35
|
+
| `SHOW` | `vne:layer_sprite:show` | Ask handlers for data and continue the chain. |
|
|
36
|
+
| `HIDE` | `vne:layer_sprite:hide` | Hide the UI or layer. |
|
|
37
|
+
| `MOVE` | `vne:layer_sprite:move` | Plugin namespace `MOVE` event. |
|
|
38
|
+
| `CHANGE` | `vne:layer_sprite:change` | Ask handlers for data and continue the chain. |
|
|
39
|
+
| `PRELOAD` | `vne:layer_sprite:preload` | Plugin namespace `PRELOAD` event. |
|
|
40
|
+
| `SRC_GET` | `vne:layer_sprite:src_get` | Get a value or resource. |
|
|
41
|
+
| `STATE_UPDATE` | `vne:layer_sprite:state_update` | Update accumulated module state. |
|
|
42
|
+
| `STATE_GET` | `vne:layer_sprite:state_get` | Get a value or resource. |
|
|
43
|
+
| `STATE_ADD` | `vne:layer_sprite:state_add` | Plugin namespace `STATE_ADD` event. |
|
|
44
|
+
| `STATE_RM` | `vne:layer_sprite:state_rm` | Plugin namespace `STATE_RM` event. |
|
|
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` |
|
|
56
|
-
| `POSITIONS` | `string` |
|
|
57
|
-
| `SPRITE_INFO` | `string` |
|
|
52
|
+
| Key | Type | Meaning |
|
|
53
|
+
| ------------------ | -------- | ---------------------------- |
|
|
54
|
+
| `TRANSITIONS_SHOW` | `string` | Default: "TRANSITIONS_SHOW". |
|
|
55
|
+
| `TRANSITIONS_HIDE` | `string` | Default: "TRANSITIONS_HIDE". |
|
|
56
|
+
| `POSITIONS` | `string` | Default: "POSITIONS". |
|
|
57
|
+
| `SPRITE_INFO` | `string` | Default: "SPRITE_INFO". |
|
|
58
58
|
|
|
59
|
-
##
|
|
59
|
+
## Settings
|
|
60
60
|
|
|
61
|
-
|
|
61
|
+
None.
|
|
62
62
|
|
|
63
|
-
##
|
|
63
|
+
## Modules
|
|
64
64
|
|
|
65
|
-
|
|
|
66
|
-
| ---------------------- |
|
|
67
|
-
| `layer.sprite.src` |
|
|
68
|
-
| `layer.sprite.show` |
|
|
69
|
-
| `layer.sprite.hide` |
|
|
70
|
-
| `layer.sprite.move` |
|
|
71
|
-
| `layer.sprite.state` |
|
|
72
|
-
| `layer.sprite.change` |
|
|
73
|
-
| `layer.sprite.preload` |
|
|
65
|
+
| Module | Role |
|
|
66
|
+
| ---------------------- | -------------------------------------------------------- |
|
|
67
|
+
| `layer.sprite.src` | Plugin `sprite.src` submodule. |
|
|
68
|
+
| `layer.sprite.show` | Plugin `sprite.show` submodule. |
|
|
69
|
+
| `layer.sprite.hide` | Plugin `sprite.hide` submodule. |
|
|
70
|
+
| `layer.sprite.move` | Plugin `sprite.move` submodule. |
|
|
71
|
+
| `layer.sprite.state` | Handles STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
|
|
72
|
+
| `layer.sprite.change` | Plugin `sprite.change` submodule. |
|
|
73
|
+
| `layer.sprite.preload` | Plugin `sprite.preload` submodule. |
|
|
74
74
|
|
|
75
|
-
##
|
|
75
|
+
## Related plugins
|
|
76
76
|
|
|
77
77
|
### plugins/core/
|
|
78
78
|
|
|
@@ -81,6 +81,6 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
81
81
|
- [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
|
|
82
82
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.PRELOAD
|
|
83
83
|
|
|
84
|
-
###
|
|
84
|
+
### Other
|
|
85
85
|
|
|
86
86
|
- [layer.md](./layer.md) — `LAYER`: EVENTS.UPDATE_FORCE, EVENTS.CHILD_GET, EVENTS.CHILD_CHANGE, EVENTS.CHILD_RM, SETTINGS.QUALITY, EVENTS.CHILD_ADD
|
|
@@ -1,55 +1,55 @@
|
|
|
1
1
|
# plugins/canvas/sprite.speak/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.sprite.speak` · namespace: `LAYER_SPRITE_SPEAK`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Turn on sprite speak when the speaker talks.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Sprite args may include `overlays` (as in [sprite.md](./sprite.md)); speak updates `options.speak` and reruns change/preload with the same args.
|
|
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.sprite.speak`.
|
|
12
12
|
|
|
13
|
-
|
|
|
14
|
-
| ------------ | ----------------------------------- |
|
|
15
|
-
| `PUSH` | `vne:layer_sprite_speak:push` |
|
|
16
|
-
| `POP` | `vne:layer_sprite_speak:pop` |
|
|
17
|
-
| `SPEAKER` | `vne:layer_sprite_speak:speaker` |
|
|
18
|
-
| `START` | `vne:layer_sprite_speak:start` |
|
|
19
|
-
| `END` | `vne:layer_sprite_speak:end` |
|
|
20
|
-
| `SPRITE_GET` | `vne:layer_sprite_speak:sprite_get` |
|
|
21
|
-
| `OPTION_SET` | `vne:layer_sprite_speak:option_set` |
|
|
13
|
+
| Key | String | Meaning |
|
|
14
|
+
| ------------ | ----------------------------------- | --------------------------------------------- |
|
|
15
|
+
| `PUSH` | `vne:layer_sprite_speak:push` | Add an item to a queue or stack. |
|
|
16
|
+
| `POP` | `vne:layer_sprite_speak:pop` | Remove an item from a queue or stack. |
|
|
17
|
+
| `SPEAKER` | `vne:layer_sprite_speak:speaker` | Ask handlers for data and continue the chain. |
|
|
18
|
+
| `START` | `vne:layer_sprite_speak:start` | Start a process. |
|
|
19
|
+
| `END` | `vne:layer_sprite_speak:end` | Ask handlers for data and continue the chain. |
|
|
20
|
+
| `SPRITE_GET` | `vne:layer_sprite_speak:sprite_get` | Ask handlers for data and continue the chain. |
|
|
21
|
+
| `OPTION_SET` | `vne:layer_sprite_speak:option_set` | Write or update a value. |
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Constants
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
None.
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Parameters
|
|
28
28
|
|
|
29
|
-
|
|
|
30
|
-
| -------------- | -------- |
|
|
31
|
-
| `MIN_DURATION` | `number` |
|
|
29
|
+
| Key | Type | Meaning |
|
|
30
|
+
| -------------- | -------- | -------------- |
|
|
31
|
+
| `MIN_DURATION` | `number` | Default: 2000. |
|
|
32
32
|
|
|
33
|
-
##
|
|
33
|
+
## Settings
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
None.
|
|
36
36
|
|
|
37
|
-
##
|
|
37
|
+
## Modules
|
|
38
38
|
|
|
39
|
-
|
|
|
40
|
-
| ----------------------------- |
|
|
41
|
-
| `layer.sprite.speak.sources` |
|
|
42
|
-
| `layer.sprite.speak.duration` |
|
|
43
|
-
| `layer.sprite.speak.preload` |
|
|
44
|
-
| `layer.sprite.speak.staff` |
|
|
45
|
-
| `layer.sprite.speak` |
|
|
39
|
+
| Module | Role |
|
|
40
|
+
| ----------------------------- | -------------------------------------------------------------- |
|
|
41
|
+
| `layer.sprite.speak.sources` | In `postinject` — `shared.layerSpriteSpeakSources`; PUSH, POP. |
|
|
42
|
+
| `layer.sprite.speak.duration` | Plugin `sprite.speak.duration` submodule. |
|
|
43
|
+
| `layer.sprite.speak.preload` | Plugin `sprite.speak.preload` submodule. |
|
|
44
|
+
| `layer.sprite.speak.staff` | Handles SPRITE_GET, OPTION_SET. |
|
|
45
|
+
| `layer.sprite.speak` | Handles END, START, SPEAKER. |
|
|
46
46
|
|
|
47
|
-
##
|
|
47
|
+
## Related plugins
|
|
48
48
|
|
|
49
49
|
### plugins/core/
|
|
50
50
|
|
|
51
|
-
—
|
|
51
|
+
— None
|
|
52
52
|
|
|
53
|
-
###
|
|
53
|
+
### Other
|
|
54
54
|
|
|
55
55
|
- [sprite.md](./sprite.md) — `LAYER_SPRITE`: EVENTS.PRELOAD, EVENTS.STATE_GET, EVENTS.CHANGE
|
package/plugins/canvas/text.md
CHANGED
|
@@ -1,54 +1,54 @@
|
|
|
1
1
|
# plugins/canvas/text/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.text` · namespace: `LAYER_TEXT`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Show, hide, change, and move localized text on layers.
|
|
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.child.text`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | ----------------------------- |
|
|
13
|
-
| `SHOW` | `vne:layer_text:show` |
|
|
14
|
-
| `HIDE` | `vne:layer_text:hide` |
|
|
15
|
-
| `CHANGE` | `vne:layer_text:change` |
|
|
16
|
-
| `MOVE` | `vne:layer_text:move` |
|
|
17
|
-
| `STATE_UPDATE` | `vne:layer_text:state_update` |
|
|
18
|
-
| `STATE_GET` | `vne:layer_text:state_get` |
|
|
19
|
-
| `STATE_ADD` | `vne:layer_text:state_add` |
|
|
20
|
-
| `STATE_RM` | `vne:layer_text:state_rm` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | ----------------------------- | --------------------------------------------- |
|
|
13
|
+
| `SHOW` | `vne:layer_text:show` | Ask handlers for data and continue the chain. |
|
|
14
|
+
| `HIDE` | `vne:layer_text:hide` | Hide the UI or layer. |
|
|
15
|
+
| `CHANGE` | `vne:layer_text:change` | Ask handlers for data and continue the chain. |
|
|
16
|
+
| `MOVE` | `vne:layer_text:move` | Plugin namespace `MOVE` event. |
|
|
17
|
+
| `STATE_UPDATE` | `vne:layer_text:state_update` | Update accumulated module state. |
|
|
18
|
+
| `STATE_GET` | `vne:layer_text:state_get` | Get a value or resource. |
|
|
19
|
+
| `STATE_ADD` | `vne:layer_text:state_add` | Plugin namespace `STATE_ADD` event. |
|
|
20
|
+
| `STATE_RM` | `vne:layer_text:state_rm` | Plugin namespace `STATE_RM` event. |
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Constants
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
None.
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Parameters
|
|
27
27
|
|
|
28
|
-
|
|
|
29
|
-
| -------------------- | -------- |
|
|
30
|
-
| `TEXT_STYLE_KEYS` | `string` |
|
|
31
|
-
| `DEFAULT_TEXT_ARGS` | `string` |
|
|
32
|
-
| `TRANSITIONS_SHOW` | `string` |
|
|
33
|
-
| `TRANSITIONS_HIDE` | `string` |
|
|
34
|
-
| `TRANSITIONS_CHANGE` | `string` |
|
|
35
|
-
| `POSITIONS` | `string` |
|
|
28
|
+
| Key | Type | Meaning |
|
|
29
|
+
| -------------------- | -------- | ------------------------------ |
|
|
30
|
+
| `TEXT_STYLE_KEYS` | `string` | Default: "TEXT_STYLE_KEYS". |
|
|
31
|
+
| `DEFAULT_TEXT_ARGS` | `string` | Default: "DEFAULT_TEXT_ARGS". |
|
|
32
|
+
| `TRANSITIONS_SHOW` | `string` | Default: "TRANSITIONS_SHOW". |
|
|
33
|
+
| `TRANSITIONS_HIDE` | `string` | Default: "TRANSITIONS_HIDE". |
|
|
34
|
+
| `TRANSITIONS_CHANGE` | `string` | Default: "TRANSITIONS_CHANGE". |
|
|
35
|
+
| `POSITIONS` | `string` | Default: "POSITIONS". |
|
|
36
36
|
|
|
37
|
-
##
|
|
37
|
+
## Settings
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
None.
|
|
40
40
|
|
|
41
|
-
##
|
|
41
|
+
## Modules
|
|
42
42
|
|
|
43
|
-
|
|
|
44
|
-
| ------------------- |
|
|
45
|
-
| `layer.text.show` |
|
|
46
|
-
| `layer.text.hide` |
|
|
47
|
-
| `layer.text.change` |
|
|
48
|
-
| `layer.text.move` |
|
|
49
|
-
| `layer.text.state` |
|
|
43
|
+
| Module | Role |
|
|
44
|
+
| ------------------- | -------------------------------------------------------- |
|
|
45
|
+
| `layer.text.show` | Plugin `text.show` submodule. |
|
|
46
|
+
| `layer.text.hide` | Plugin `text.hide` submodule. |
|
|
47
|
+
| `layer.text.change` | Plugin `text.change` submodule. |
|
|
48
|
+
| `layer.text.move` | Plugin `text.move` submodule. |
|
|
49
|
+
| `layer.text.state` | Handles STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
|
|
50
50
|
|
|
51
|
-
##
|
|
51
|
+
## Related plugins
|
|
52
52
|
|
|
53
53
|
### plugins/core/
|
|
54
54
|
|
|
@@ -57,7 +57,7 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
57
57
|
- [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
|
|
58
58
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.PRELOAD
|
|
59
59
|
|
|
60
|
-
###
|
|
60
|
+
### Other
|
|
61
61
|
|
|
62
62
|
- [layer.md](./layer.md) — `LAYER`: EVENTS.CHILD_GET, EVENTS.CHILD_CHANGE, EVENTS.UPDATE_FORCE, EVENTS.CHILD_RM, EVENTS.CHILD_ADD
|
|
63
63
|
- [locs.md](../text/locs.md) — `LOCS`: EVENTS.LOAD
|
package/plugins/canvas/video.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# plugins/canvas/video/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.video` · namespace: `LAYER_VIDEO`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Show, hide, change, and preload video on canvas layers.
|
|
6
6
|
|
|
7
|
-
Then-bg
|
|
7
|
+
Then-bg after video takes the same args as [bg.md](./bg.md), including `overlays` (in the scenario — a `bg:` block under the video command).
|
|
8
8
|
|
|
9
9
|
```vne
|
|
10
10
|
$ bl.video show {logo} … then bg {castle/surgery_room} …
|
|
@@ -14,50 +14,50 @@ $ bl.video show {logo} … then bg {castle/surgery_room} …
|
|
|
14
14
|
man: 1
|
|
15
15
|
```
|
|
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.video`.
|
|
20
20
|
|
|
21
|
-
|
|
|
22
|
-
| -------------- | ------------------------------ |
|
|
23
|
-
| `SHOW` | `vne:layer_video:show` |
|
|
24
|
-
| `HIDE` | `vne:layer_video:hide` |
|
|
25
|
-
| `CHANGE` | `vne:layer_video:change` |
|
|
26
|
-
| `ENDED` | `vne:layer_video:ended` |
|
|
27
|
-
| `PRELOAD` | `vne:layer_video:preload` |
|
|
28
|
-
| `SRC_GET` | `vne:layer_video:src_get` |
|
|
29
|
-
| `STATE_RM` | `vne:layer_video:state_rm` |
|
|
30
|
-
| `STATE_GET` | `vne:layer_video:state_get` |
|
|
31
|
-
| `STATE_ADD` | `vne:layer_video:state_add` |
|
|
32
|
-
| `STATE_UPDATE` | `vne:layer_video:state_update` |
|
|
21
|
+
| Key | String | Meaning |
|
|
22
|
+
| -------------- | ------------------------------ | --------------------------------------------- |
|
|
23
|
+
| `SHOW` | `vne:layer_video:show` | Ask handlers for data and continue the chain. |
|
|
24
|
+
| `HIDE` | `vne:layer_video:hide` | Ask handlers for data and continue the chain. |
|
|
25
|
+
| `CHANGE` | `vne:layer_video:change` | Ask handlers for data and continue the chain. |
|
|
26
|
+
| `ENDED` | `vne:layer_video:ended` | Ask handlers for data and continue the chain. |
|
|
27
|
+
| `PRELOAD` | `vne:layer_video:preload` | Plugin namespace `PRELOAD` event. |
|
|
28
|
+
| `SRC_GET` | `vne:layer_video:src_get` | Ask handlers for data and continue the chain. |
|
|
29
|
+
| `STATE_RM` | `vne:layer_video:state_rm` | Plugin namespace `STATE_RM` event. |
|
|
30
|
+
| `STATE_GET` | `vne:layer_video:state_get` | Get a value or resource. |
|
|
31
|
+
| `STATE_ADD` | `vne:layer_video:state_add` | Plugin namespace `STATE_ADD` event. |
|
|
32
|
+
| `STATE_UPDATE` | `vne:layer_video:state_update` | Update accumulated module state. |
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Constants
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
None.
|
|
37
37
|
|
|
38
|
-
##
|
|
38
|
+
## Parameters
|
|
39
39
|
|
|
40
|
-
|
|
|
41
|
-
| ------------------ | -------- |
|
|
42
|
-
| `TRANSITIONS_SHOW` | `string` |
|
|
43
|
-
| `TRANSITIONS_HIDE` | `string` |
|
|
40
|
+
| Key | Type | Meaning |
|
|
41
|
+
| ------------------ | -------- | ---------------------------- |
|
|
42
|
+
| `TRANSITIONS_SHOW` | `string` | Default: "TRANSITIONS_SHOW". |
|
|
43
|
+
| `TRANSITIONS_HIDE` | `string` | Default: "TRANSITIONS_HIDE". |
|
|
44
44
|
|
|
45
|
-
##
|
|
45
|
+
## Settings
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
None.
|
|
48
48
|
|
|
49
|
-
##
|
|
49
|
+
## Modules
|
|
50
50
|
|
|
51
|
-
|
|
|
52
|
-
| --------------------- |
|
|
53
|
-
| `layer.video.show` |
|
|
54
|
-
| `layer.video.hide` |
|
|
55
|
-
| `layer.video.change` |
|
|
56
|
-
| `layer.video.state` |
|
|
57
|
-
| `layer.video.src.get` |
|
|
58
|
-
| `layer.video.preload` |
|
|
51
|
+
| Module | Role |
|
|
52
|
+
| --------------------- | -------------------------------------------------------- |
|
|
53
|
+
| `layer.video.show` | Handles SHOW, ENDED. |
|
|
54
|
+
| `layer.video.hide` | Plugin `video.hide` submodule. |
|
|
55
|
+
| `layer.video.change` | Plugin `video.change` submodule. |
|
|
56
|
+
| `layer.video.state` | Handles STATE_UPDATE, STATE_GET, STATE_ADD, STATE_RM, …. |
|
|
57
|
+
| `layer.video.src.get` | Plugin `video.src.get` submodule. |
|
|
58
|
+
| `layer.video.preload` | Plugin `video.preload` submodule. |
|
|
59
59
|
|
|
60
|
-
##
|
|
60
|
+
## Related plugins
|
|
61
61
|
|
|
62
62
|
### plugins/core/
|
|
63
63
|
|
|
@@ -66,7 +66,7 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
66
66
|
- [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
|
|
67
67
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.PRELOAD
|
|
68
68
|
|
|
69
|
-
###
|
|
69
|
+
### Other
|
|
70
70
|
|
|
71
71
|
- [layer.md](./layer.md) — `LAYER`: EVENTS.CHILD_CHANGE, EVENTS.UPDATE_FORCE, EVENTS.CHILDS_RM, SETTINGS.QUALITY, EVENTS.CHILD_ADD
|
|
72
72
|
- [image.md](./image.md) — `LAYER_BG`: EVENTS.PRELOAD, EVENTS.SHOW
|
|
@@ -1,54 +1,54 @@
|
|
|
1
1
|
# plugins/canvas.layers/bl/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.layers.bl` · namespace: `LAYER_BL`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Back canvas layer `bl`: controller, view, and bg/sprite/text/video commands.
|
|
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.layers.bl`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | --------------------------- |
|
|
13
|
-
| `SHOW` | `vne:layer_bl:show` |
|
|
14
|
-
| `HIDE` | `vne:layer_bl:hide` |
|
|
15
|
-
| `UPDATE` | `vne:layer_bl:update` |
|
|
16
|
-
| `UPDATE_FAST` | `vne:layer_bl:update_fast` |
|
|
17
|
-
| `UPDATE_FORCE` | `vne:layer_bl:update_force` |
|
|
18
|
-
| `UPDATE_STATE` | `vne:layer_bl:update_state` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | --------------------------- | ------------------------------------------------------ |
|
|
13
|
+
| `SHOW` | `vne:layer_bl:show` | Show the UI or layer. |
|
|
14
|
+
| `HIDE` | `vne:layer_bl:hide` | Hide the UI or layer. |
|
|
15
|
+
| `UPDATE` | `vne:layer_bl:update` | Update state or display. |
|
|
16
|
+
| `UPDATE_FAST` | `vne:layer_bl:update_fast` | Fast display update. |
|
|
17
|
+
| `UPDATE_FORCE` | `vne:layer_bl:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
18
|
+
| `UPDATE_STATE` | `vne:layer_bl:update_state` | Merge a partial into the controller state. |
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Constants
|
|
21
21
|
|
|
22
22
|
- **`LAYER`** — "bl"
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Parameters
|
|
25
25
|
|
|
26
|
-
|
|
|
27
|
-
| -------- | -------- |
|
|
28
|
-
| `ZINDEX` | `string` |
|
|
26
|
+
| Key | Type | Meaning |
|
|
27
|
+
| -------- | -------- | ------------------ |
|
|
28
|
+
| `ZINDEX` | `string` | Default: "ZINDEX". |
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Settings
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
None.
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Modules
|
|
35
35
|
|
|
36
|
-
|
|
|
37
|
-
| --------------------- |
|
|
38
|
-
| `layer.bl.controller` |
|
|
39
|
-
| `layer.bl.props` |
|
|
40
|
-
| `layer.bl.bg` |
|
|
41
|
-
| `layer.bl.sprite` |
|
|
42
|
-
| `layer.bl.text` |
|
|
43
|
-
| `layer.bl.video` |
|
|
44
|
-
| `layer.bl.view` |
|
|
36
|
+
| Module | Role |
|
|
37
|
+
| --------------------- | --------------------------------- |
|
|
38
|
+
| `layer.bl.controller` | Plugin `bl.controller` submodule. |
|
|
39
|
+
| `layer.bl.props` | Plugin `bl.props` submodule. |
|
|
40
|
+
| `layer.bl.bg` | Plugin `bl.bg` submodule. |
|
|
41
|
+
| `layer.bl.sprite` | Plugin `bl.sprite` submodule. |
|
|
42
|
+
| `layer.bl.text` | Plugin `bl.text` submodule. |
|
|
43
|
+
| `layer.bl.video` | Plugin `bl.video` submodule. |
|
|
44
|
+
| `layer.bl.view` | Plugin `bl.view` submodule. |
|
|
45
45
|
|
|
46
|
-
##
|
|
46
|
+
## Related plugins
|
|
47
47
|
|
|
48
48
|
### plugins/core/
|
|
49
49
|
|
|
50
|
-
—
|
|
50
|
+
— None
|
|
51
51
|
|
|
52
|
-
###
|
|
52
|
+
### Other
|
|
53
53
|
|
|
54
|
-
—
|
|
54
|
+
— None
|