@vnejs/docs 0.2.64 → 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 -383
- package/architecture.md +0 -566
|
@@ -1,44 +1,44 @@
|
|
|
1
1
|
# plugins/platform/metric/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.platform.metric` · namespace: `METRIC`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Connects Yandex.Metrica: goals, params, and stack events.
|
|
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.platform.metric`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------- | ------------------- |
|
|
13
|
-
| `GOAL` | `vne.metric.goal` |
|
|
14
|
-
| `PARAMS` | `vne.metric.params` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------- | ------------------- | -------------------------------- |
|
|
13
|
+
| `GOAL` | `vne.metric.goal` | Plugin namespace event `GOAL`. |
|
|
14
|
+
| `PARAMS` | `vne.metric.params` | Plugin namespace event `PARAMS`. |
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Constants
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
None.
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Parameters
|
|
21
21
|
|
|
22
|
-
|
|
|
23
|
-
| --------------- | -------- |
|
|
24
|
-
| `YA_COUNTER_ID` | `number` |
|
|
22
|
+
| Key | Type | Meaning |
|
|
23
|
+
| --------------- | -------- | ------------- |
|
|
24
|
+
| `YA_COUNTER_ID` | `number` | Default: `0`. |
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Settings
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
None.
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Modules
|
|
31
31
|
|
|
32
|
-
|
|
|
33
|
-
| -------- |
|
|
34
|
-
| `metric` |
|
|
32
|
+
| Module | Role |
|
|
33
|
+
| -------- | --------------------------- |
|
|
34
|
+
| `metric` | Handles EMIT, GOAL, PARAMS. |
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Related plugins
|
|
37
37
|
|
|
38
38
|
### plugins/core/
|
|
39
39
|
|
|
40
40
|
- [stack.md](../core/stack.md) — `STACK`: EVENTS.EMIT
|
|
41
41
|
|
|
42
|
-
###
|
|
42
|
+
### Other
|
|
43
43
|
|
|
44
|
-
—
|
|
44
|
+
— None
|
package/plugins/rpg/damage.md
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
# plugins/rpg/damage/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.rpg.damage` · namespace: `DAMAGE`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Computes final damage through a chain of modifiers (shift, multiplier).
|
|
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.rpg.damage`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------------- | ------------------------ |
|
|
13
|
-
| `EMIT` | `vne:damage:emit` |
|
|
14
|
-
| `CALC_DAMAGE` | `vne:damage:calc_damage` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------------- | ------------------------ | ------------------------------------- |
|
|
13
|
+
| `EMIT` | `vne:damage:emit` | Start an action or cycle. |
|
|
14
|
+
| `CALC_DAMAGE` | `vne:damage:calc_damage` | Plugin namespace event `CALC_DAMAGE`. |
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Constants
|
|
17
17
|
|
|
18
18
|
- **`SOURCES.PHYSICAL`** — "physical"
|
|
19
19
|
- **`SOURCES.MAGIC`** — "magic"
|
|
@@ -22,27 +22,27 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
22
22
|
- **`SUBSOURCES.PIERCING`** — "piercing"
|
|
23
23
|
- **`SUBSOURCES.FIST`** — "fist"
|
|
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
|
-
| `damage.calc` |
|
|
38
|
-
| `damage` |
|
|
35
|
+
| Module | Role |
|
|
36
|
+
| ------------- | ------------------------------------------ |
|
|
37
|
+
| `damage.calc` | Plugin `calc` submodule. |
|
|
38
|
+
| `damage` | Emit entry point: prepare and run process. |
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Related plugins
|
|
41
41
|
|
|
42
42
|
### plugins/core/
|
|
43
43
|
|
|
44
|
-
—
|
|
44
|
+
— None
|
|
45
45
|
|
|
46
|
-
###
|
|
46
|
+
### Other
|
|
47
47
|
|
|
48
|
-
—
|
|
48
|
+
— None
|
package/plugins/rpg/hit.md
CHANGED
|
@@ -1,48 +1,48 @@
|
|
|
1
1
|
# plugins/rpg/hit/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.rpg.hit` · namespace: `HIT`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Determines attack outcome: miss, hit, crit, or crit-miss.
|
|
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.rpg.hit`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ----------------------- | ------------------------------- |
|
|
13
|
-
| `EMIT` | `vne:hit:emit` |
|
|
14
|
-
| `CALC_CRIT_MISS_CHANCE` | `vne:hit:calc_crit_miss_chance` |
|
|
15
|
-
| `CALC_ACCURACY` | `vne:hit:calc_accuracy` |
|
|
16
|
-
| `CALC_CRIT_CHANCE` | `vne:hit:calc_crit_chance` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ----------------------- | ------------------------------- | ----------------------------------------------- |
|
|
13
|
+
| `EMIT` | `vne:hit:emit` | Start an action or cycle. |
|
|
14
|
+
| `CALC_CRIT_MISS_CHANCE` | `vne:hit:calc_crit_miss_chance` | Plugin namespace event `CALC_CRIT_MISS_CHANCE`. |
|
|
15
|
+
| `CALC_ACCURACY` | `vne:hit:calc_accuracy` | Plugin namespace event `CALC_ACCURACY`. |
|
|
16
|
+
| `CALC_CRIT_CHANCE` | `vne:hit:calc_crit_chance` | Plugin namespace event `CALC_CRIT_CHANCE`. |
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Constants
|
|
19
19
|
|
|
20
20
|
- **`STATUS.CRITICAL_MISSED`** — "critical_missed"
|
|
21
21
|
- **`STATUS.MISSED`** — "missed"
|
|
22
22
|
- **`STATUS.HIT`** — "hit"
|
|
23
23
|
- **`STATUS.CRITICAL`** — "critical"
|
|
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
|
-
| `hit.calc` |
|
|
38
|
-
| `hit` |
|
|
35
|
+
| Module | Role |
|
|
36
|
+
| ---------- | --------------------------------------------------------------- |
|
|
37
|
+
| `hit.calc` | Handles CALC_CRIT_MISS_CHANCE, CALC_ACCURACY, CALC_CRIT_CHANCE. |
|
|
38
|
+
| `hit` | Emit entry point: prepare and run process. |
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Related plugins
|
|
41
41
|
|
|
42
42
|
### plugins/core/
|
|
43
43
|
|
|
44
|
-
—
|
|
44
|
+
— None
|
|
45
45
|
|
|
46
|
-
###
|
|
46
|
+
### Other
|
|
47
47
|
|
|
48
|
-
—
|
|
48
|
+
— None
|
package/plugins/rpg/skills.md
CHANGED
|
@@ -1,49 +1,49 @@
|
|
|
1
1
|
# plugins/rpg/skills/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.rpg.skills` · namespace: `SKILLS`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Logs skill lifecycle: emit, start, and finish.
|
|
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.rpg.skills`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------------- | ------------------------ |
|
|
13
|
-
| `EMIT` | `vne:skills:emit` |
|
|
14
|
-
| `EMIT_START` | `vne:skills:emit_start` |
|
|
15
|
-
| `EMIT_FINISH` | `vne:skills:emit_finish` |
|
|
16
|
-
| `CHECK` | `vne:skills:check` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------------- | ------------------------ | --------------------------------- |
|
|
13
|
+
| `EMIT` | `vne:skills:emit` | Start an action or cycle. |
|
|
14
|
+
| `EMIT_START` | `vne:skills:emit_start` | Start a process. |
|
|
15
|
+
| `EMIT_FINISH` | `vne:skills:emit_finish` | Start an action or cycle. |
|
|
16
|
+
| `CHECK` | `vne:skills:check` | Check state or resource presence. |
|
|
17
17
|
|
|
18
|
-
Payload `EMIT`: `{ id?, caster?, target? }`. Lifecycle (`EMIT_START` / `EMIT_FINISH`): `{ skillId?, caster?, target? }`. `caster` —
|
|
18
|
+
Payload `EMIT`: `{ id?, caster?, target? }`. Lifecycle (`EMIT_START` / `EMIT_FINISH`): `{ skillId?, caster?, target? }`. `caster` — who applies the skill, `target` — the target.
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Constants
|
|
21
21
|
|
|
22
22
|
- **`LOGS_ACTIONS`** — `emit`, `start`, `finish`.
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Parameters
|
|
25
25
|
|
|
26
|
-
|
|
|
27
|
-
| ------- | -------- |
|
|
28
|
-
| `TYPES` | `string` |
|
|
29
|
-
| `ITEMS` | `object` |
|
|
26
|
+
| Key | Type | Meaning |
|
|
27
|
+
| ------- | -------- | ---------------------------------- |
|
|
28
|
+
| `TYPES` | `string` | Skill kinds (`damage`, `heal`, …). |
|
|
29
|
+
| `ITEMS` | `object` | Parameter `ITEMS`. |
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Settings
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
None.
|
|
34
34
|
|
|
35
|
-
##
|
|
35
|
+
## Modules
|
|
36
36
|
|
|
37
|
-
|
|
|
38
|
-
| -------- |
|
|
39
|
-
| `skills` |
|
|
37
|
+
| Module | Role |
|
|
38
|
+
| -------- | -------------------------------------- |
|
|
39
|
+
| `skills` | Handles EMIT, EMIT_START, EMIT_FINISH. |
|
|
40
40
|
|
|
41
|
-
##
|
|
41
|
+
## Related plugins
|
|
42
42
|
|
|
43
43
|
### plugins/core/
|
|
44
44
|
|
|
45
45
|
- [logs.md](../core/logs.md) — `LOGS`: `EVENTS.LOGS.EMIT` (`action`, …)
|
|
46
46
|
|
|
47
|
-
###
|
|
47
|
+
### Other
|
|
48
48
|
|
|
49
|
-
—
|
|
49
|
+
— None
|
package/plugins/save/auto.md
CHANGED
|
@@ -1,49 +1,49 @@
|
|
|
1
1
|
# plugins/save/auto/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.save.auto` · namespace: `SAVE_AUTO`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Creates autosaves on an interval or by 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.save.auto`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------ | ------------------- |
|
|
13
|
-
| `MAKE` | `vne:autosave:make` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------ | ------------------- | ------------------------------ |
|
|
13
|
+
| `MAKE` | `vne:autosave:make` | Plugin namespace event `MAKE`. |
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Constants
|
|
16
16
|
|
|
17
|
-
|
|
|
18
|
-
| ------------ |
|
|
19
|
-
| `SAVE_GROUP` | Storage group
|
|
17
|
+
| Key | Meaning |
|
|
18
|
+
| ------------ | ----------------------------------------------------------------------------------------- |
|
|
19
|
+
| `SAVE_GROUP` | Storage group for autosaves (`"autosave"`); access via `this.CONST.SAVE_AUTO.SAVE_GROUP`. |
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Parameters
|
|
22
22
|
|
|
23
|
-
|
|
|
24
|
-
| ------------------ | -------- |
|
|
25
|
-
| `DEFAULT_INTERVAL` | `number` |
|
|
26
|
-
| `MAX_INDEX` | `number` |
|
|
23
|
+
| Key | Type | Meaning |
|
|
24
|
+
| ------------------ | -------- | --------------- |
|
|
25
|
+
| `DEFAULT_INTERVAL` | `number` | Default: `300`. |
|
|
26
|
+
| `MAX_INDEX` | `number` | Default: `9`. |
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Settings
|
|
29
29
|
|
|
30
|
-
|
|
|
31
|
-
| ------------------------------------ | -------- |
|
|
32
|
-
| `INTERVAL` (`vne:autosave:interval`) | `string` |
|
|
30
|
+
| Key | Type | Meaning |
|
|
31
|
+
| ------------------------------------ | -------- | ----------------------------------------------------- |
|
|
32
|
+
| `INTERVAL` (`vne:autosave:interval`) | `string` | Setting `vne:autosave:interval` in `shared.settings`. |
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Modules
|
|
35
35
|
|
|
36
|
-
|
|
|
37
|
-
| ----------- |
|
|
38
|
-
| `save.auto` |
|
|
36
|
+
| Module | Role |
|
|
37
|
+
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
38
|
+
| `save.auto` | In `postinject` — `shared.autosaveDisableSources`; `SETTINGS.INIT` in `setup`; `LINE_EXEC_REG` in `init`; `SAVE.CREATE` with `group: "autosave"`. |
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Related plugins
|
|
41
41
|
|
|
42
42
|
### plugins/core/
|
|
43
43
|
|
|
44
44
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.LINE_EXEC_REG
|
|
45
45
|
- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.INIT
|
|
46
46
|
|
|
47
|
-
###
|
|
47
|
+
### Other
|
|
48
48
|
|
|
49
49
|
- [save.md](./save.md) — `SAVE`: EVENTS.CREATE
|
package/plugins/save/continue.md
CHANGED
|
@@ -1,45 +1,45 @@
|
|
|
1
1
|
# plugins/save/continue/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.save.continue` · namespace: `SAVE_CONTINUE`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Manages the Continue slot: create, load, and preload.
|
|
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.save.continue`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| --------- | --------------------------- |
|
|
13
|
-
| `MAKE` | `vne:save_continue:make` |
|
|
14
|
-
| `LOAD` | `vne:save_continue:load` |
|
|
15
|
-
| `PRELOAD` | `vne:save_continue:preload` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| --------- | --------------------------- | --------------------------------- |
|
|
13
|
+
| `MAKE` | `vne:save_continue:make` | Plugin namespace event `MAKE`. |
|
|
14
|
+
| `LOAD` | `vne:save_continue:load` | Load data or a resource. |
|
|
15
|
+
| `PRELOAD` | `vne:save_continue:preload` | Plugin namespace event `PRELOAD`. |
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## Constants
|
|
18
18
|
|
|
19
|
-
|
|
|
20
|
-
| ------------ |
|
|
21
|
-
| `SAVE_GROUP` | Storage group
|
|
19
|
+
| Key | Meaning |
|
|
20
|
+
| ------------ | ----------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| `SAVE_GROUP` | Storage group for the continue slot (`"continue"`); access via `this.CONST.SAVE_CONTINUE.SAVE_GROUP`. |
|
|
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
|
-
| `save.continue` |
|
|
33
|
+
| Module | Role |
|
|
34
|
+
| --------------- | --------------------------------------------------------------------- |
|
|
35
|
+
| `save.continue` | Handles MAKE, LOAD, PRELOAD; slot in `SAVE` with `group: "continue"`. |
|
|
36
36
|
|
|
37
|
-
##
|
|
37
|
+
## Related plugins
|
|
38
38
|
|
|
39
39
|
### plugins/core/
|
|
40
40
|
|
|
41
41
|
- [state.md](../core/state.md) — `STATE`: CONST.MIGRATE_STATUS.OK
|
|
42
42
|
|
|
43
|
-
###
|
|
43
|
+
### Other
|
|
44
44
|
|
|
45
45
|
- [save.md](./save.md) — `SAVE`: EVENTS.GET, EVENTS.CREATE, EVENTS.LOAD, EVENTS.PRELOAD
|
package/plugins/save/quick.md
CHANGED
|
@@ -1,46 +1,46 @@
|
|
|
1
1
|
# plugins/save/quick/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.save.quick` · namespace: `SAVE_QUICK`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Manages the quick-save slot: create, load, and preload.
|
|
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.save.quick`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| --------- | ------------------------ |
|
|
13
|
-
| `MAKE` | `vne:save_quick:make` |
|
|
14
|
-
| `LOAD` | `vne:save_quick:load` |
|
|
15
|
-
| `PRELOAD` | `vne:save_quick:preload` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| --------- | ------------------------ | --------------------------------- |
|
|
13
|
+
| `MAKE` | `vne:save_quick:make` | Plugin namespace event `MAKE`. |
|
|
14
|
+
| `LOAD` | `vne:save_quick:load` | Load data or a resource. |
|
|
15
|
+
| `PRELOAD` | `vne:save_quick:preload` | Plugin namespace event `PRELOAD`. |
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## Constants
|
|
18
18
|
|
|
19
|
-
|
|
|
20
|
-
| ------------ |
|
|
21
|
-
| `SAVE_GROUP` | Storage group
|
|
19
|
+
| Key | Meaning |
|
|
20
|
+
| ------------ | -------------------------------------------------------------------------------------------- |
|
|
21
|
+
| `SAVE_GROUP` | Storage group for the quick slot (`"quick"`); access via `this.CONST.SAVE_QUICK.SAVE_GROUP`. |
|
|
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
|
-
| `save.quick` |
|
|
33
|
+
| Module | Role |
|
|
34
|
+
| ------------ | ------------------------------------------------------------------ |
|
|
35
|
+
| `save.quick` | Handles MAKE, LOAD, PRELOAD; slot in `SAVE` with `group: "quick"`. |
|
|
36
36
|
|
|
37
|
-
##
|
|
37
|
+
## Related plugins
|
|
38
38
|
|
|
39
39
|
### plugins/core/
|
|
40
40
|
|
|
41
41
|
- [state.md](../core/state.md) — `STATE`: CONST.MIGRATE_STATUS.OK
|
|
42
42
|
|
|
43
|
-
###
|
|
43
|
+
### Other
|
|
44
44
|
|
|
45
45
|
- [save.md](./save.md) — `SAVE`: EVENTS.GET, EVENTS.CREATE, EVENTS.LOAD, EVENTS.PRELOAD
|
|
46
|
-
- [continue.md](./continue.md) —
|
|
46
|
+
- [continue.md](./continue.md) — same pattern for the Continue slot
|
package/plugins/save/save.md
CHANGED
|
@@ -1,54 +1,54 @@
|
|
|
1
1
|
# plugins/save/save/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.save.save` · namespace: `SAVE`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Saves and loads game state with migration and screenshots.
|
|
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.save`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------------ | --------------------- |
|
|
13
|
-
| `GET` | `vne:save:get` |
|
|
14
|
-
| `CLEAR` | `vne:save:clear` |
|
|
15
|
-
| `DELETE` | `vne:save:delete` |
|
|
16
|
-
| `CREATE` | `vne:save:create` |
|
|
17
|
-
| `KEY` | `vne:save:key` |
|
|
18
|
-
| `SCREENSHOT` | `vne:save:screenshot` |
|
|
19
|
-
| `LOAD` | `vne:save:load` |
|
|
20
|
-
| `PRELOAD` | `vne:save:preload` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------------ | --------------------- | ------------------------------------------------- |
|
|
13
|
+
| `GET` | `vne:save:get` | Read slot (`{ key, group? }`) from `STORAGE`. |
|
|
14
|
+
| `CLEAR` | `vne:save:clear` | Delete all slots of module `save` in `STORAGE`. |
|
|
15
|
+
| `DELETE` | `vne:save:delete` | Delete slot (`{ key, group? }`). |
|
|
16
|
+
| `CREATE` | `vne:save:create` | Create slot (`{ key, group?, withScreenshot? }`). |
|
|
17
|
+
| `KEY` | `vne:save:key` | Plugin namespace event `KEY`. |
|
|
18
|
+
| `SCREENSHOT` | `vne:save:screenshot` | Take a screenshot for the slot. |
|
|
19
|
+
| `LOAD` | `vne:save:load` | Load slot into `STATE` (`{ key, group? }`). |
|
|
20
|
+
| `PRELOAD` | `vne:save:preload` | Preload slot (`{ key, group? }`). |
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Constants
|
|
23
23
|
|
|
24
|
-
- **`LOGS_ACTIONS`** —
|
|
24
|
+
- **`LOGS_ACTIONS`** — log labels: `GET`, `SAVE`, `LOAD`, `DELETE`, `PRELOAD`, `CLEAR`, `KEY` (field value — `action`, not `type`).
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Parameters
|
|
27
27
|
|
|
28
|
-
|
|
|
29
|
-
| -------------------- | -------- |
|
|
30
|
-
| `SCREENSHOT_QUALITY` | `number` |
|
|
31
|
-
| `SCREENSHOT_WIDTH` | `number` |
|
|
32
|
-
| `SCREENSHOT_HEIGHT` | `number` |
|
|
28
|
+
| Key | Type | Meaning |
|
|
29
|
+
| -------------------- | -------- | ---------------- |
|
|
30
|
+
| `SCREENSHOT_QUALITY` | `number` | Default: `0.5`. |
|
|
31
|
+
| `SCREENSHOT_WIDTH` | `number` | Default: `1280`. |
|
|
32
|
+
| `SCREENSHOT_HEIGHT` | `number` | Default: `720`. |
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
Events `GET` / `CREATE` / `DELETE` / `LOAD` / `PRELOAD` accept optional `group` and pass it to `STORAGE`. Concrete groups are set by calling plugins (page number in save view, `autosave`, `continue`).
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Settings
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
None.
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Modules
|
|
41
41
|
|
|
42
|
-
|
|
|
43
|
-
| ------------- |
|
|
44
|
-
| `save.exec` |
|
|
45
|
-
| `save.key` |
|
|
46
|
-
| `save.load` |
|
|
47
|
-
| `save.logs` |
|
|
48
|
-
| `save` |
|
|
49
|
-
| `save.screen` |
|
|
42
|
+
| Module | Role |
|
|
43
|
+
| ------------- | ----------------------------------- |
|
|
44
|
+
| `save.exec` | Plugin `exec` submodule. |
|
|
45
|
+
| `save.key` | Handles KEY, SET, CLEAR. |
|
|
46
|
+
| `save.load` | Handles LOAD, PRELOAD. |
|
|
47
|
+
| `save.logs` | Handles GET, KEY, CLEAR, CREATE, …. |
|
|
48
|
+
| `save` | Handles GET, CLEAR, DELETE, CREATE. |
|
|
49
|
+
| `save.screen` | Plugin `screen` submodule. |
|
|
50
50
|
|
|
51
|
-
##
|
|
51
|
+
## Related plugins
|
|
52
52
|
|
|
53
53
|
### plugins/core/
|
|
54
54
|
|
|
@@ -59,6 +59,6 @@ Payloads и результаты хендлеров типизированы ч
|
|
|
59
59
|
- [system.md](../core/system.md) — `SYSTEM`: CONST.DOM_IDS.APP
|
|
60
60
|
- [vendors.md](../core/vendors.md) — `VENDORS`: EVENTS.SCREEN
|
|
61
61
|
|
|
62
|
-
###
|
|
62
|
+
### Other
|
|
63
63
|
|
|
64
|
-
—
|
|
64
|
+
— None
|