@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/time/time.md
CHANGED
|
@@ -1,45 +1,45 @@
|
|
|
1
1
|
# plugins/time/time/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.time.time` · namespace: `TIME`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Stores and changes game time: hours, minutes, seconds with rollover across days.
|
|
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.time.time`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ---------- | ------------------- |
|
|
13
|
-
| `SET` | `vne:time:set` |
|
|
14
|
-
| `ADD` | `vne:time:add` |
|
|
15
|
-
| `CHANGED` | `vne:time:changed` |
|
|
16
|
-
| `ROLLOVER` | `vne:time:rollover` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ---------- | ------------------- | ---------------------------------- |
|
|
13
|
+
| `SET` | `vne:time:set` | Write or update a value. |
|
|
14
|
+
| `ADD` | `vne:time:add` | Plugin namespace event `ADD`. |
|
|
15
|
+
| `CHANGED` | `vne:time:changed` | Record a state change. |
|
|
16
|
+
| `ROLLOVER` | `vne:time:rollover` | Plugin namespace event `ROLLOVER`. |
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Constants
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
None.
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Parameters
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
None.
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Settings
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
None.
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Modules
|
|
31
31
|
|
|
32
|
-
|
|
|
33
|
-
| ------ |
|
|
34
|
-
| `time` |
|
|
32
|
+
| Module | Role |
|
|
33
|
+
| ------ | ------------------------ |
|
|
34
|
+
| `time` | Handles SET, ADD, CLEAR. |
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Related plugins
|
|
37
37
|
|
|
38
38
|
### plugins/core/
|
|
39
39
|
|
|
40
40
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.NEXT, EVENTS.LINE_EXEC_REG
|
|
41
41
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
42
42
|
|
|
43
|
-
###
|
|
43
|
+
### Other
|
|
44
44
|
|
|
45
|
-
—
|
|
45
|
+
— None
|
package/plugins/vars/counters.md
CHANGED
|
@@ -1,50 +1,50 @@
|
|
|
1
1
|
# plugins/vars/counters/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.vars.counters` · namespace: `VARS_COUNTERS`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Numeric counter variables with arithmetic and comparison in scenario lines.
|
|
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.vars.counters`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------------ | ----------------------------- |
|
|
13
|
-
| `SET` | `vne:vars_counter:set` |
|
|
14
|
-
| `GET` | `vne:vars_counter:get` |
|
|
15
|
-
| `CHANGE` | `vne:vars_counter:change` |
|
|
16
|
-
| `COMPARE` | `vne:vars_counter:compare` |
|
|
17
|
-
| `EXEC_INFO` | `vne:vars_counter:exec_info` |
|
|
18
|
-
| `EXEC_CHECK` | `vne:vars_counter:exec_check` |
|
|
19
|
-
| `EXEC_GET` | `vne:vars_counter:exec_get` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------------ | ----------------------------- | --------------------------------------------- |
|
|
13
|
+
| `SET` | `vne:vars_counter:set` | Write or update a value. |
|
|
14
|
+
| `GET` | `vne:vars_counter:get` | Get a value or resource. |
|
|
15
|
+
| `CHANGE` | `vne:vars_counter:change` | Plugin namespace event `CHANGE`. |
|
|
16
|
+
| `COMPARE` | `vne:vars_counter:compare` | Plugin namespace event `COMPARE`. |
|
|
17
|
+
| `EXEC_INFO` | `vne:vars_counter:exec_info` | Ask handlers for data and continue the chain. |
|
|
18
|
+
| `EXEC_CHECK` | `vne:vars_counter:exec_check` | Ask handlers for data and continue the chain. |
|
|
19
|
+
| `EXEC_GET` | `vne:vars_counter:exec_get` | Ask handlers for data and continue the chain. |
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Constants
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
None.
|
|
24
24
|
|
|
25
|
-
##
|
|
25
|
+
## Parameters
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
None.
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## Settings
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
None.
|
|
32
32
|
|
|
33
|
-
##
|
|
33
|
+
## Modules
|
|
34
34
|
|
|
35
|
-
|
|
|
36
|
-
| ------------------------ |
|
|
37
|
-
| `vars.counters` |
|
|
38
|
-
| `vars.counters.handlers` |
|
|
39
|
-
| `vars.counters.exec` |
|
|
40
|
-
| `vars.counters.scenario` |
|
|
35
|
+
| Module | Role |
|
|
36
|
+
| ------------------------ | ----------------------------------------------------- |
|
|
37
|
+
| `vars.counters` | Handles SET, GET; registers DEFAULT_REG. |
|
|
38
|
+
| `vars.counters.handlers` | Handles CHANGE, COMPARE. |
|
|
39
|
+
| `vars.counters.exec` | Handles EXEC_INFO, EXEC_CHECK, EXEC_GET. |
|
|
40
|
+
| `vars.counters.scenario` | Registers LINE_EXEC for module/block (`$/% counter`). |
|
|
41
41
|
|
|
42
|
-
##
|
|
42
|
+
## Related plugins
|
|
43
43
|
|
|
44
44
|
### plugins/core/
|
|
45
45
|
|
|
46
46
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.NEXT, EVENTS.LINE_EXEC_REG
|
|
47
47
|
|
|
48
|
-
###
|
|
48
|
+
### Other
|
|
49
49
|
|
|
50
50
|
- [vars.md](./vars.md) — `VARS`: EVENTS.DEFAULT_REG, EVENTS.SET, EVENTS.GET, EVENTS.SCENARIO, CONST.LINE_KEYWORDS.GLOBAL
|
package/plugins/vars/flags.md
CHANGED
|
@@ -1,46 +1,46 @@
|
|
|
1
1
|
# plugins/vars/flags/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.vars.flags` · namespace: `VARS_FLAGS`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Boolean flags with set and check in scenario exec lines.
|
|
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.vars.flags`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------------ | --------------------------- |
|
|
13
|
-
| `SET` | `vne:vars_flags:set` |
|
|
14
|
-
| `GET` | `vne:vars_flags:get` |
|
|
15
|
-
| `EXEC_INFO` | `vne:vars_flags:exec_info` |
|
|
16
|
-
| `EXEC_CHECK` | `vne:vars_flags:exec_check` |
|
|
17
|
-
| `EXEC_GET` | `vne:vars_flags:exec_get` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------------ | --------------------------- | --------------------------------------------- |
|
|
13
|
+
| `SET` | `vne:vars_flags:set` | Write or update a value. |
|
|
14
|
+
| `GET` | `vne:vars_flags:get` | Get a value or resource. |
|
|
15
|
+
| `EXEC_INFO` | `vne:vars_flags:exec_info` | Ask handlers for data and continue the chain. |
|
|
16
|
+
| `EXEC_CHECK` | `vne:vars_flags:exec_check` | Ask handlers for data and continue the chain. |
|
|
17
|
+
| `EXEC_GET` | `vne:vars_flags:exec_get` | Ask handlers for data and continue the chain. |
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Constants
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
None.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Parameters
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
None.
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Settings
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
None.
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Modules
|
|
32
32
|
|
|
33
|
-
|
|
|
34
|
-
| ----------------- |
|
|
35
|
-
| `vars.flags.exec` |
|
|
36
|
-
| `vars.flags` |
|
|
33
|
+
| Module | Role |
|
|
34
|
+
| ----------------- | ------------------------------------------- |
|
|
35
|
+
| `vars.flags.exec` | Plugin `flags.exec` submodule. |
|
|
36
|
+
| `vars.flags` | Handles SET, GET, EXEC_INFO, EXEC_CHECK, …. |
|
|
37
37
|
|
|
38
|
-
##
|
|
38
|
+
## Related plugins
|
|
39
39
|
|
|
40
40
|
### plugins/core/
|
|
41
41
|
|
|
42
42
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.NEXT, EVENTS.LINE_EXEC_REG
|
|
43
43
|
|
|
44
|
-
###
|
|
44
|
+
### Other
|
|
45
45
|
|
|
46
46
|
- [vars.md](./vars.md) — `VARS`: EVENTS.SCENARIO, EVENTS.DEFAULT_REG, EVENTS.SET, EVENTS.GET, CONST.LINE_KEYWORDS.GLOBAL
|
package/plugins/vars/vars.md
CHANGED
|
@@ -1,46 +1,46 @@
|
|
|
1
1
|
# plugins/vars/vars/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.vars.vars` · namespace: `VARS`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Base variable system: local and global get/set with defaults by type.
|
|
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.vars`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | ----------------------- |
|
|
13
|
-
| `GET` | `vne:vars:get` |
|
|
14
|
-
| `SET` | `vne:vars:set` |
|
|
15
|
-
| `INJECT` | `vne:vars:inject` |
|
|
16
|
-
| `SCENARIO` | `vne:vars:scenario` |
|
|
17
|
-
| `DEFAULT_REG` | `vne:vars:default_reg` |
|
|
18
|
-
| `GLOBAL_SET` | `vne:vars:global_set` |
|
|
19
|
-
| `GLOBAL_GET` | `vne:vars:global_get` |
|
|
20
|
-
| `GLOBAL_CLEAR` | `vne:vars:global_clear` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | ----------------------- | --------------------------------------------- |
|
|
13
|
+
| `GET` | `vne:vars:get` | Ask handlers for data and continue the chain. |
|
|
14
|
+
| `SET` | `vne:vars:set` | Write or update a value. |
|
|
15
|
+
| `INJECT` | `vne:vars:inject` | Plugin namespace event `INJECT`. |
|
|
16
|
+
| `SCENARIO` | `vne:vars:scenario` | Ask handlers for data and continue the chain. |
|
|
17
|
+
| `DEFAULT_REG` | `vne:vars:default_reg` | Register a `DEFAULT` handler. |
|
|
18
|
+
| `GLOBAL_SET` | `vne:vars:global_set` | Write or update a value. |
|
|
19
|
+
| `GLOBAL_GET` | `vne:vars:global_get` | Get a value or resource. |
|
|
20
|
+
| `GLOBAL_CLEAR` | `vne:vars:global_clear` | Clear accumulated state. |
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Constants
|
|
23
23
|
|
|
24
|
-
- **`LINE_KEYWORDS.GLOBAL`** — `"global"`:
|
|
24
|
+
- **`LINE_KEYWORDS.GLOBAL`** — `"global"`: read/write the variable in global scope.
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Parameters
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
None.
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Settings
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
None.
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Modules
|
|
35
35
|
|
|
36
|
-
|
|
|
36
|
+
| Module | Role |
|
|
37
37
|
| --------------- | --------------------------------------------------------------------- |
|
|
38
|
-
| `vars.global` |
|
|
39
|
-
| `vars.inject` |
|
|
40
|
-
| `vars` |
|
|
41
|
-
| `vars.scenario` |
|
|
38
|
+
| `vars.global` | Handles GLOBAL_GET, GLOBAL_SET, GLOBAL_CLEAR. |
|
|
39
|
+
| `vars.inject` | Plugin `inject` submodule. |
|
|
40
|
+
| `vars` | `DEFAULT_REG` handler registry. |
|
|
41
|
+
| `vars.scenario` | On `SCENARIO`: enter inside or `getBlockSkipShift` past indent block. |
|
|
42
42
|
|
|
43
|
-
##
|
|
43
|
+
## Related plugins
|
|
44
44
|
|
|
45
45
|
### plugins/core/
|
|
46
46
|
|
|
@@ -48,6 +48,6 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
48
48
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
49
49
|
- [storage.md](../core/storage.md) — `STORAGE`: EVENTS.GET_ALL, EVENTS.SET, EVENTS.RM_ALL
|
|
50
50
|
|
|
51
|
-
###
|
|
51
|
+
### Other
|
|
52
52
|
|
|
53
|
-
—
|
|
53
|
+
— None
|
|
@@ -1,63 +1,63 @@
|
|
|
1
1
|
# plugins/views/achievement/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.views.achievement` · namespace: `ACHIEVEMENT`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Unlocks achievements, saves progress, and shows notifications.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.views.achievement`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | ------------------------------ |
|
|
13
|
-
| `CLEAR` | `vne:achievement:clear` |
|
|
14
|
-
| `LOAD` | `vne:achievement:load` |
|
|
15
|
-
| `UNLOCK` | `vne:achievement:unlock` |
|
|
16
|
-
| `APPEND` | `vne:achievement:append` |
|
|
17
|
-
| `SHOW` | `vne:achievement:show` |
|
|
18
|
-
| `HIDE` | `vne:achievement:hide` |
|
|
19
|
-
| `UPDATE` | `vne:achievement:update` |
|
|
20
|
-
| `UPDATE_FAST` | `vne:achievement:update_fast` |
|
|
21
|
-
| `UPDATE_FORCE` | `vne:achievement:update_force` |
|
|
22
|
-
| `UPDATE_STATE` | `vne:achievement:update_state` |
|
|
23
|
-
| `LOCKED` | `vne:achievement:locked` |
|
|
24
|
-
| `UNLOCKED` | `vne:achievement:unlocked` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | ------------------------------ | ------------------------------------------------------ |
|
|
13
|
+
| `CLEAR` | `vne:achievement:clear` | Clear accumulated state. |
|
|
14
|
+
| `LOAD` | `vne:achievement:load` | Load data or a resource. |
|
|
15
|
+
| `UNLOCK` | `vne:achievement:unlock` | Ask handlers for data and continue the chain. |
|
|
16
|
+
| `APPEND` | `vne:achievement:append` | Plugin `APPEND` namespace event. |
|
|
17
|
+
| `SHOW` | `vne:achievement:show` | Show the UI or layer. |
|
|
18
|
+
| `HIDE` | `vne:achievement:hide` | Hide the UI or layer. |
|
|
19
|
+
| `UPDATE` | `vne:achievement:update` | Update state or display. |
|
|
20
|
+
| `UPDATE_FAST` | `vne:achievement:update_fast` | Fast display update. |
|
|
21
|
+
| `UPDATE_FORCE` | `vne:achievement:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
22
|
+
| `UPDATE_STATE` | `vne:achievement:update_state` | Merge a partial into the controller state. |
|
|
23
|
+
| `LOCKED` | `vne:achievement:locked` | Plugin `LOCKED` namespace event. |
|
|
24
|
+
| `UNLOCKED` | `vne:achievement:unlocked` | Plugin `UNLOCKED` namespace event. |
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Constants
|
|
27
27
|
|
|
28
28
|
- **`EXEC_ACTIONS.UNLOCK`** — "unlock"
|
|
29
29
|
- **`LOGS_ACTIONS.UNLOCKED`** — "unlocked"
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Parameters
|
|
32
32
|
|
|
33
|
-
|
|
|
34
|
-
| --------------- | -------- |
|
|
35
|
-
| `TRANSITION` | `string` |
|
|
36
|
-
| `ZINDEX` | `string` |
|
|
37
|
-
| `LOC_LABEL` | `string` |
|
|
38
|
-
| `SHOW_DURATION` | `string` |
|
|
39
|
-
| `VIEW_PROPS` | `string` |
|
|
40
|
-
| `TOP` | `string` |
|
|
41
|
-
| `TOP_SHIFT` | `string` |
|
|
42
|
-
| `LEFT` | `string` |
|
|
43
|
-
| `LEFT_SHIFT` | `string` |
|
|
44
|
-
| `INFO` | `string` |
|
|
33
|
+
| Key | Type | Meaning |
|
|
34
|
+
| --------------- | -------- | -------------------------- |
|
|
35
|
+
| `TRANSITION` | `string` | Default: "TRANSITION". |
|
|
36
|
+
| `ZINDEX` | `string` | Default: "ZINDEX". |
|
|
37
|
+
| `LOC_LABEL` | `string` | Label name or entry point. |
|
|
38
|
+
| `SHOW_DURATION` | `string` | Default: "SHOW_DURATION". |
|
|
39
|
+
| `VIEW_PROPS` | `string` | Default: "VIEW_PROPS". |
|
|
40
|
+
| `TOP` | `string` | Default: "TOP". |
|
|
41
|
+
| `TOP_SHIFT` | `string` | Default: "TOP_SHIFT". |
|
|
42
|
+
| `LEFT` | `string` | Default: "LEFT". |
|
|
43
|
+
| `LEFT_SHIFT` | `string` | Default: "LEFT_SHIFT". |
|
|
44
|
+
| `INFO` | `string` | Default: "INFO". |
|
|
45
45
|
|
|
46
|
-
##
|
|
46
|
+
## Settings
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
None.
|
|
49
49
|
|
|
50
|
-
##
|
|
50
|
+
## Modules
|
|
51
51
|
|
|
52
|
-
|
|
|
53
|
-
| ------------------------ |
|
|
54
|
-
| `achievement` |
|
|
55
|
-
| `achievement.controller` |
|
|
56
|
-
| `achievement.exec` |
|
|
57
|
-
| `achievement.logs` |
|
|
58
|
-
| `achievement.view` |
|
|
52
|
+
| Module | Role |
|
|
53
|
+
| ------------------------ | ----------------------------- |
|
|
54
|
+
| `achievement` | Handles CLEAR, UNLOCK. |
|
|
55
|
+
| `achievement.controller` | Handles UPDATE, LOAD, APPEND. |
|
|
56
|
+
| `achievement.exec` | Plugin `exec` submodule. |
|
|
57
|
+
| `achievement.logs` | Plugin `logs` submodule. |
|
|
58
|
+
| `achievement.view` | Plugin `view` submodule. |
|
|
59
59
|
|
|
60
|
-
##
|
|
60
|
+
## Related plugins
|
|
61
61
|
|
|
62
62
|
### plugins/core/
|
|
63
63
|
|
|
@@ -66,6 +66,6 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
66
66
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.NEXT, EVENTS.LINE_EXEC_REG, EVENTS.LINE_LOAD_REG, CONST.LINE_KEYWORDS.SKIP_IF_POSSIBLE
|
|
67
67
|
- [storage.md](../core/storage.md) — `STORAGE`: EVENTS.RM_ALL, EVENTS.GET, EVENTS.SET
|
|
68
68
|
|
|
69
|
-
###
|
|
69
|
+
### Other
|
|
70
70
|
|
|
71
71
|
- [layer.md](../canvas/layer.md) — `LAYER`: SETTINGS.QUALITY
|
package/plugins/views/comment.md
CHANGED
|
@@ -1,48 +1,48 @@
|
|
|
1
1
|
# plugins/views/comment/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.views.comment` · namespace: `COMMENT`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Shows temporary comments over the game via a scenario command.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.views.comment`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | -------------------------- |
|
|
13
|
-
| `SHOW` | `vne:comment:show` |
|
|
14
|
-
| `HIDE` | `vne:comment:hide` |
|
|
15
|
-
| `UPDATE` | `vne:comment:update` |
|
|
16
|
-
| `UPDATE_FAST` | `vne:comment:update_fast` |
|
|
17
|
-
| `UPDATE_FORCE` | `vne:comment:update_force` |
|
|
18
|
-
| `UPDATE_STATE` | `vne:comment:update_state` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | -------------------------- | ------------------------------------------------------ |
|
|
13
|
+
| `SHOW` | `vne:comment:show` | Show the UI or layer. |
|
|
14
|
+
| `HIDE` | `vne:comment:hide` | Hide the UI or layer. |
|
|
15
|
+
| `UPDATE` | `vne:comment:update` | Update state or display. |
|
|
16
|
+
| `UPDATE_FAST` | `vne:comment:update_fast` | Fast display update. |
|
|
17
|
+
| `UPDATE_FORCE` | `vne:comment:update_force` | Redraw the view with `isForce`; state does not change. |
|
|
18
|
+
| `UPDATE_STATE` | `vne:comment:update_state` | Merge a partial into the controller state. |
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Constants
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
None.
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Parameters
|
|
25
25
|
|
|
26
|
-
|
|
|
27
|
-
| ------------ | -------- |
|
|
28
|
-
| `ZINDEX` | `string` |
|
|
29
|
-
| `TRANSITION` | `string` |
|
|
30
|
-
| `VIEW_PROPS` | `string` |
|
|
26
|
+
| Key | Type | Meaning |
|
|
27
|
+
| ------------ | -------- | ---------------------- |
|
|
28
|
+
| `ZINDEX` | `string` | Default: "ZINDEX". |
|
|
29
|
+
| `TRANSITION` | `string` | Default: "TRANSITION". |
|
|
30
|
+
| `VIEW_PROPS` | `string` | Default: "VIEW_PROPS". |
|
|
31
31
|
|
|
32
|
-
##
|
|
32
|
+
## Settings
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
None.
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Modules
|
|
37
37
|
|
|
38
|
-
|
|
|
39
|
-
| -------------------- |
|
|
40
|
-
| `comment` |
|
|
41
|
-
| `comment.controller` |
|
|
42
|
-
| `comment.hide` |
|
|
43
|
-
| `comment.view` |
|
|
38
|
+
| Module | Role |
|
|
39
|
+
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
40
|
+
| `comment` | Scenario command shows or hides the comment. Auto-hide timer clears on `HIDE.MAIN` if the controller did not abort hide on `GATE`. |
|
|
41
|
+
| `comment.controller` | Handles UPDATE, SHOW, HIDE. `EXTERNAL_UPDATE` recomputes text and updates the view. |
|
|
42
|
+
| `comment.hide` | Extends `@vnejs/module.controller.hide.on.state`: `STATE.SET` / `STATE.CLEAR` → `HIDE` with `{ isForce: true }`. |
|
|
43
|
+
| `comment.view` | Plugin `view` submodule. |
|
|
44
44
|
|
|
45
|
-
##
|
|
45
|
+
## Related plugins
|
|
46
46
|
|
|
47
47
|
### plugins/core/
|
|
48
48
|
|
|
@@ -50,6 +50,6 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
50
50
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.NEXT, EVENTS.LINE_EXEC_REG
|
|
51
51
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
52
52
|
|
|
53
|
-
###
|
|
53
|
+
### Other
|
|
54
54
|
|
|
55
55
|
- [text.md](../text/text.md) — `TEXT`: EVENTS.REPLACE
|