@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,54 +1,54 @@
|
|
|
1
1
|
# plugins/canvas.layers/fl/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.layers.fl` · namespace: `LAYER_FL`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Front canvas layer `fl`: 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.fl`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | --------------------------- |
|
|
13
|
-
| `SHOW` | `vne:layer_fl:show` |
|
|
14
|
-
| `HIDE` | `vne:layer_fl:hide` |
|
|
15
|
-
| `UPDATE` | `vne:layer_fl:update` |
|
|
16
|
-
| `UPDATE_FAST` | `vne:layer_fl:update_fast` |
|
|
17
|
-
| `UPDATE_FORCE` | `vne:layer_fl:update_force` |
|
|
18
|
-
| `UPDATE_STATE` | `vne:layer_fl:update_state` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | --------------------------- | ------------------------------------------------------ |
|
|
13
|
+
| `SHOW` | `vne:layer_fl:show` | Show the UI or layer. |
|
|
14
|
+
| `HIDE` | `vne:layer_fl:hide` | Hide the UI or layer. |
|
|
15
|
+
| `UPDATE` | `vne:layer_fl:update` | Update state or display. |
|
|
16
|
+
| `UPDATE_FAST` | `vne:layer_fl:update_fast` | Fast display update. |
|
|
17
|
+
| `UPDATE_FORCE` | `vne:layer_fl:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
18
|
+
| `UPDATE_STATE` | `vne:layer_fl:update_state` | Merge a partial into the controller state. |
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Constants
|
|
21
21
|
|
|
22
22
|
- **`LAYER`** — "fl"
|
|
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.fl.controller` |
|
|
39
|
-
| `layer.fl.bg` |
|
|
40
|
-
| `layer.fl.props` |
|
|
41
|
-
| `layer.fl.sprite` |
|
|
42
|
-
| `layer.fl.text` |
|
|
43
|
-
| `layer.fl.video` |
|
|
44
|
-
| `layer.fl.view` |
|
|
36
|
+
| Module | Role |
|
|
37
|
+
| --------------------- | --------------------------------- |
|
|
38
|
+
| `layer.fl.controller` | Plugin `fl.controller` submodule. |
|
|
39
|
+
| `layer.fl.bg` | Plugin `fl.bg` submodule. |
|
|
40
|
+
| `layer.fl.props` | Plugin `fl.props` submodule. |
|
|
41
|
+
| `layer.fl.sprite` | Plugin `fl.sprite` submodule. |
|
|
42
|
+
| `layer.fl.text` | Plugin `fl.text` submodule. |
|
|
43
|
+
| `layer.fl.video` | Plugin `fl.video` submodule. |
|
|
44
|
+
| `layer.fl.view` | Plugin `fl.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
|
|
@@ -1,54 +1,54 @@
|
|
|
1
1
|
# plugins/canvas.layers/ml/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.layers.ml` · namespace: `LAYER_ML`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Middle canvas layer `ml`: 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.ml`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | --------------------------- |
|
|
13
|
-
| `SHOW` | `vne:layer_ml:show` |
|
|
14
|
-
| `HIDE` | `vne:layer_ml:hide` |
|
|
15
|
-
| `UPDATE` | `vne:layer_ml:update` |
|
|
16
|
-
| `UPDATE_FAST` | `vne:layer_ml:update_fast` |
|
|
17
|
-
| `UPDATE_FORCE` | `vne:layer_ml:update_force` |
|
|
18
|
-
| `UPDATE_STATE` | `vne:layer_ml:update_state` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | --------------------------- | ------------------------------------------------------ |
|
|
13
|
+
| `SHOW` | `vne:layer_ml:show` | Show the UI or layer. |
|
|
14
|
+
| `HIDE` | `vne:layer_ml:hide` | Hide the UI or layer. |
|
|
15
|
+
| `UPDATE` | `vne:layer_ml:update` | Update state or display. |
|
|
16
|
+
| `UPDATE_FAST` | `vne:layer_ml:update_fast` | Fast display update. |
|
|
17
|
+
| `UPDATE_FORCE` | `vne:layer_ml:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
18
|
+
| `UPDATE_STATE` | `vne:layer_ml:update_state` | Merge a partial into the controller state. |
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Constants
|
|
21
21
|
|
|
22
22
|
- **`LAYER`** — "ml"
|
|
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.ml.controller` |
|
|
39
|
-
| `layer.ml.props` |
|
|
40
|
-
| `layer.ml.bg` |
|
|
41
|
-
| `layer.ml.sprite` |
|
|
42
|
-
| `layer.ml.text` |
|
|
43
|
-
| `layer.ml.video` |
|
|
44
|
-
| `layer.ml.view` |
|
|
36
|
+
| Module | Role |
|
|
37
|
+
| --------------------- | --------------------------------- |
|
|
38
|
+
| `layer.ml.controller` | Plugin `ml.controller` submodule. |
|
|
39
|
+
| `layer.ml.props` | Plugin `ml.props` submodule. |
|
|
40
|
+
| `layer.ml.bg` | Plugin `ml.bg` submodule. |
|
|
41
|
+
| `layer.ml.sprite` | Plugin `ml.sprite` submodule. |
|
|
42
|
+
| `layer.ml.text` | Plugin `ml.text` submodule. |
|
|
43
|
+
| `layer.ml.video` | Plugin `ml.video` submodule. |
|
|
44
|
+
| `layer.ml.view` | Plugin `ml.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
|
|
@@ -1,53 +1,53 @@
|
|
|
1
1
|
# plugins/canvas.layers/ul/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.layers.ul` · namespace: `LAYER_UL`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Top canvas layer `ul` without pointer-events; bg, sprite, and text.
|
|
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.ul`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | --------------------------- |
|
|
13
|
-
| `SHOW` | `vne:layer_ul:show` |
|
|
14
|
-
| `HIDE` | `vne:layer_ul:hide` |
|
|
15
|
-
| `UPDATE` | `vne:layer_ul:update` |
|
|
16
|
-
| `UPDATE_FAST` | `vne:layer_ul:update_fast` |
|
|
17
|
-
| `UPDATE_FORCE` | `vne:layer_ul:update_force` |
|
|
18
|
-
| `UPDATE_STATE` | `vne:layer_ul:update_state` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | --------------------------- | ------------------------------------------------------ |
|
|
13
|
+
| `SHOW` | `vne:layer_ul:show` | Show the UI or layer. |
|
|
14
|
+
| `HIDE` | `vne:layer_ul:hide` | Hide the UI or layer. |
|
|
15
|
+
| `UPDATE` | `vne:layer_ul:update` | Update state or display. |
|
|
16
|
+
| `UPDATE_FAST` | `vne:layer_ul:update_fast` | Fast display update. |
|
|
17
|
+
| `UPDATE_FORCE` | `vne:layer_ul:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
18
|
+
| `UPDATE_STATE` | `vne:layer_ul:update_state` | Merge a partial into the controller state. |
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Constants
|
|
21
21
|
|
|
22
22
|
- **`LAYER`** — "ul"
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Parameters
|
|
25
25
|
|
|
26
|
-
|
|
|
27
|
-
| -------- | -------- |
|
|
28
|
-
| `ZINDEX` | `number` |
|
|
26
|
+
| Key | Type | Meaning |
|
|
27
|
+
| -------- | -------- | -------------- |
|
|
28
|
+
| `ZINDEX` | `number` | Default: 1500. |
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Settings
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
None.
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Modules
|
|
35
35
|
|
|
36
|
-
|
|
|
37
|
-
| --------------------- |
|
|
38
|
-
| `layer.ul.controller` |
|
|
39
|
-
| `layer.ul.bg` |
|
|
40
|
-
| `layer.ul.props` |
|
|
41
|
-
| `layer.ul.sprite` |
|
|
42
|
-
| `layer.ul.text` |
|
|
43
|
-
| `layer.ul.view` |
|
|
36
|
+
| Module | Role |
|
|
37
|
+
| --------------------- | --------------------------------- |
|
|
38
|
+
| `layer.ul.controller` | Plugin `ul.controller` submodule. |
|
|
39
|
+
| `layer.ul.bg` | Plugin `ul.bg` submodule. |
|
|
40
|
+
| `layer.ul.props` | Plugin `ul.props` submodule. |
|
|
41
|
+
| `layer.ul.sprite` | Plugin `ul.sprite` submodule. |
|
|
42
|
+
| `layer.ul.text` | Plugin `ul.text` submodule. |
|
|
43
|
+
| `layer.ul.view` | Plugin `ul.view` submodule. |
|
|
44
44
|
|
|
45
|
-
##
|
|
45
|
+
## Related plugins
|
|
46
46
|
|
|
47
47
|
### plugins/core/
|
|
48
48
|
|
|
49
|
-
—
|
|
49
|
+
— None
|
|
50
50
|
|
|
51
|
-
###
|
|
51
|
+
### Other
|
|
52
52
|
|
|
53
|
-
—
|
|
53
|
+
— None
|
|
@@ -1,43 +1,43 @@
|
|
|
1
1
|
# plugins/canvas.props/animation/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.props.animation` · namespace: `LAYER_ANIMATION`
|
|
4
4
|
|
|
5
|
-
CSS
|
|
5
|
+
CSS animation on a canvas layer, saved in state.
|
|
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.props.animation`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------- | --------------------------- |
|
|
13
|
-
| `SET` | `vne:layer_animation:set` |
|
|
14
|
-
| `UNSET` | `vne:layer_animation:unset` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------- | --------------------------- | ------------------------------- |
|
|
13
|
+
| `SET` | `vne:layer_animation:set` | Write or update a value. |
|
|
14
|
+
| `UNSET` | `vne:layer_animation:unset` | Plugin namespace `UNSET` event. |
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Constants
|
|
17
17
|
|
|
18
18
|
- **`EXEC_ACTIONS`** — `set` / `unset`.
|
|
19
|
-
- **`LINE_KEYWORDS.DANGEROUS`** — `"dangerous"`:
|
|
19
|
+
- **`LINE_KEYWORDS.DANGEROUS`** — `"dangerous"`: allow "dangerous" animation (when enabled in settings).
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Parameters
|
|
22
22
|
|
|
23
|
-
|
|
|
24
|
-
| --------------------------- | --------- |
|
|
25
|
-
| `ANIMATIONS` | `string` |
|
|
26
|
-
| `DEFAULT_DANGEROUS_ENABLED` | `boolean` |
|
|
23
|
+
| Key | Type | Meaning |
|
|
24
|
+
| --------------------------- | --------- | --------------------------------- |
|
|
25
|
+
| `ANIMATIONS` | `string` | Default: "ANIMATIONS". |
|
|
26
|
+
| `DEFAULT_DANGEROUS_ENABLED` | `boolean` | Default for enabling the feature. |
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Settings
|
|
29
29
|
|
|
30
|
-
|
|
|
31
|
-
| ------------------------------------------------------------- | --------- |
|
|
32
|
-
| `DANGEROUS_ENABLED` (`vne:layer_animation:dangerous_enabled`) | `boolean` |
|
|
30
|
+
| Key | Type | Meaning |
|
|
31
|
+
| ------------------------------------------------------------- | --------- | ------------------------------ |
|
|
32
|
+
| `DANGEROUS_ENABLED` (`vne:layer_animation:dangerous_enabled`) | `boolean` | Enable or disable the feature. |
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Modules
|
|
35
35
|
|
|
36
|
-
|
|
|
37
|
-
| ----------------- |
|
|
38
|
-
| `layer.animation` |
|
|
36
|
+
| Module | Role |
|
|
37
|
+
| ----------------- | ----------------------------------- |
|
|
38
|
+
| `layer.animation` | Handles SET, UNSET, CLEAR, CHANGED. |
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Related plugins
|
|
41
41
|
|
|
42
42
|
### plugins/core/
|
|
43
43
|
|
|
@@ -45,6 +45,6 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
45
45
|
- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT
|
|
46
46
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
47
47
|
|
|
48
|
-
###
|
|
48
|
+
### Other
|
|
49
49
|
|
|
50
50
|
- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.PROPS_UPDATE, EVENTS.UPDATE_FORCE
|
|
@@ -1,45 +1,45 @@
|
|
|
1
1
|
# plugins/canvas.props/clip/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.props.clip` · namespace: `LAYER_CLIP`
|
|
4
4
|
|
|
5
|
-
CSS clip-path canvas
|
|
5
|
+
CSS `clip-path` on a canvas layer with smooth changes.
|
|
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.props.clip`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------- | ---------------------- |
|
|
13
|
-
| `SET` | `vne:layer_clip:set` |
|
|
14
|
-
| `UNSET` | `vne:layer_clip:unset` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------- | ---------------------- | ------------------------------- |
|
|
13
|
+
| `SET` | `vne:layer_clip:set` | Write or update a value. |
|
|
14
|
+
| `UNSET` | `vne:layer_clip:unset` | Plugin namespace `UNSET` event. |
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Constants
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
None.
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Parameters
|
|
21
21
|
|
|
22
|
-
|
|
|
23
|
-
| ------- | -------- |
|
|
24
|
-
| `CLIPS` | `string` |
|
|
22
|
+
| Key | Type | Meaning |
|
|
23
|
+
| ------- | -------- | ----------------- |
|
|
24
|
+
| `CLIPS` | `string` | Default: "CLIPS". |
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Settings
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
None.
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Modules
|
|
31
31
|
|
|
32
|
-
|
|
|
33
|
-
| ------------ |
|
|
34
|
-
| `layer.clip` |
|
|
32
|
+
| Module | Role |
|
|
33
|
+
| ------------ | -------------------------- |
|
|
34
|
+
| `layer.clip` | Handles SET, UNSET, CLEAR. |
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Related plugins
|
|
37
37
|
|
|
38
38
|
### plugins/core/
|
|
39
39
|
|
|
40
40
|
- [interact.md](../core/interact.md) — `INTERACT`: INTERACT
|
|
41
41
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
42
42
|
|
|
43
|
-
###
|
|
43
|
+
### Other
|
|
44
44
|
|
|
45
45
|
- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.PROPS_UPDATE, EVENTS.UPDATE_FORCE
|
|
@@ -1,44 +1,44 @@
|
|
|
1
1
|
# plugins/canvas.props/filters/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.props.filters` · namespace: `LAYER_FILTER`
|
|
4
4
|
|
|
5
|
-
CSS filter canvas
|
|
5
|
+
CSS `filter` on a canvas layer with smooth changes.
|
|
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.props.filter`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------- | ------------------------ |
|
|
13
|
-
| `SET` | `vne:layer_filter:set` |
|
|
14
|
-
| `UNSET` | `vne:layer_filter:unset` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------- | ------------------------ | --------------------------------- |
|
|
13
|
+
| `SET` | `vne:layer_filter:set` | Write or update a value. |
|
|
14
|
+
| `UNSET` | `vne:layer_filter:unset` | Remove the filter from the layer. |
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Constants
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
None.
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Parameters
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
None.
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Settings
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
None.
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Modules
|
|
29
29
|
|
|
30
|
-
|
|
|
31
|
-
| -------------- |
|
|
32
|
-
| `layer.filter` |
|
|
30
|
+
| Module | Role |
|
|
31
|
+
| -------------- | -------------------------- |
|
|
32
|
+
| `layer.filter` | Handles SET, UNSET, CLEAR. |
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Related plugins
|
|
35
35
|
|
|
36
36
|
### plugins/core/
|
|
37
37
|
|
|
38
38
|
- [interact.md](../core/interact.md) — `INTERACT`: INTERACT
|
|
39
39
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
40
40
|
|
|
41
|
-
###
|
|
41
|
+
### Other
|
|
42
42
|
|
|
43
43
|
- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.PROPS_UPDATE, EVENTS.UPDATE_FORCE
|
|
44
44
|
- [filter.md](./filter.md) — `LAYER_FILTER`: EVENTS.SET, EVENTS.UNSET, PARAMS.FILTERS
|
|
@@ -1,46 +1,46 @@
|
|
|
1
1
|
# plugins/canvas.props/mask/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.props.mask` · namespace: `LAYER_MASK`
|
|
4
4
|
|
|
5
|
-
CSS mask canvas
|
|
5
|
+
CSS `mask` on a canvas layer with animated parameter changes.
|
|
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.props.mask`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------- | ----------------------- |
|
|
13
|
-
| `SET` | `vne:layer_mask:set` |
|
|
14
|
-
| `UNSET` | `vne:layer_mask:unset` |
|
|
15
|
-
| `CHANGE` | `vne:layer_mask:change` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------- | ----------------------- | -------------------------------- |
|
|
13
|
+
| `SET` | `vne:layer_mask:set` | Write or update a value. |
|
|
14
|
+
| `UNSET` | `vne:layer_mask:unset` | Plugin namespace `UNSET` event. |
|
|
15
|
+
| `CHANGE` | `vne:layer_mask:change` | Plugin namespace `CHANGE` event. |
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## Constants
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
None.
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Parameters
|
|
22
22
|
|
|
23
|
-
|
|
|
24
|
-
| ------- | -------- |
|
|
25
|
-
| `MASKS` | `string` |
|
|
23
|
+
| Key | Type | Meaning |
|
|
24
|
+
| ------- | -------- | ----------------- |
|
|
25
|
+
| `MASKS` | `string` | Default: "MASKS". |
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Settings
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
None.
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Modules
|
|
32
32
|
|
|
33
|
-
|
|
|
34
|
-
| ------------ |
|
|
35
|
-
| `layer.mask` |
|
|
33
|
+
| Module | Role |
|
|
34
|
+
| ------------ | ---------------------------------- |
|
|
35
|
+
| `layer.mask` | Handles SET, UNSET, CHANGE, CLEAR. |
|
|
36
36
|
|
|
37
|
-
##
|
|
37
|
+
## Related plugins
|
|
38
38
|
|
|
39
39
|
### plugins/core/
|
|
40
40
|
|
|
41
41
|
- [interact.md](../core/interact.md) — `INTERACT`: INTERACT
|
|
42
42
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
43
43
|
|
|
44
|
-
###
|
|
44
|
+
### Other
|
|
45
45
|
|
|
46
46
|
- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.UPDATE_FORCE, EVENTS.PROPS_UPDATE
|
|
@@ -1,43 +1,43 @@
|
|
|
1
1
|
# plugins/canvas.props/scale/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.canvas.props.scale` · namespace: `LAYER_SCALE`
|
|
4
4
|
|
|
5
|
-
CSS scale
|
|
5
|
+
CSS `scale` and `transform-origin` on a canvas layer.
|
|
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.props.scale`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------- | ----------------------- |
|
|
13
|
-
| `SET` | `vne:layer_scale:set` |
|
|
14
|
-
| `UNSET` | `vne:layer_scale:unset` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------- | ----------------------- | ------------------------------- |
|
|
13
|
+
| `SET` | `vne:layer_scale:set` | Write or update a value. |
|
|
14
|
+
| `UNSET` | `vne:layer_scale:unset` | Plugin namespace `UNSET` event. |
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Constants
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
None.
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Parameters
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
None.
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Settings
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
None.
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Modules
|
|
29
29
|
|
|
30
|
-
|
|
|
31
|
-
| ------------- |
|
|
32
|
-
| `layer.scale` |
|
|
30
|
+
| Module | Role |
|
|
31
|
+
| ------------- | -------------------------- |
|
|
32
|
+
| `layer.scale` | Handles SET, UNSET, CLEAR. |
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Related plugins
|
|
35
35
|
|
|
36
36
|
### plugins/core/
|
|
37
37
|
|
|
38
38
|
- [interact.md](../core/interact.md) — `INTERACT`: INTERACT
|
|
39
39
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
40
40
|
|
|
41
|
-
###
|
|
41
|
+
### Other
|
|
42
42
|
|
|
43
43
|
- [layer.md](../canvas/layer.md) — `LAYER`: EVENTS.PROPS_UPDATE, EVENTS.UPDATE_FORCE
|