@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,51 +1,51 @@
|
|
|
1
1
|
# plugins/core/components/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.core.components` · namespace: `COMPONENTS`
|
|
4
4
|
|
|
5
|
-
React/DOM
|
|
5
|
+
React/DOM container for mounting view components and an inject-handler chain.
|
|
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.core.components`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ----------------- | -------------------------------- |
|
|
13
|
-
| `RENDER` | `vne:components:render` |
|
|
14
|
-
| `INJECT` | `vne:components:inject` |
|
|
15
|
-
| `INJECT_REG` | `vne:components:inject_reg` |
|
|
16
|
-
| `EXTERNAL_UPDATE` | `vne:components:external_update` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ----------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
13
|
+
| `RENDER` | `vne:components:render` | Render request: create a child container, call the passed `renderFunc`; finishes when the component calls `onMount`. |
|
|
14
|
+
| `INJECT` | `vne:components:inject` | Run a value through all registered inject handlers in order; returns an array of results. |
|
|
15
|
+
| `INJECT_REG` | `vne:components:inject_reg` | Register a new inject handler in the chain. |
|
|
16
|
+
| `EXTERNAL_UPDATE` | `vne:components:external_update` | Request a UI update. `ModuleController` responds with `state.isShow && updateViewFast()`. |
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Constants
|
|
19
19
|
|
|
20
|
-
- **`LOGS_ACTIONS.RENDER`** — `"render"`:
|
|
21
|
-
- **`LOGS_ACTIONS.SHOW` / `HIDE`** — `"show"` / `"hide"`:
|
|
22
|
-
- **`LIFECYCLE_PRIORITY.SHOW` / `HIDE`** —
|
|
20
|
+
- **`LOGS_ACTIONS.RENDER`** — `"render"`: log action label on render.
|
|
21
|
+
- **`LOGS_ACTIONS.SHOW` / `HIDE`** — `"show"` / `"hide"`: labels for `ModuleController` (show/hide view).
|
|
22
|
+
- **`LIFECYCLE_PRIORITY.SHOW` / `HIDE`** — phases `GATE`, `BEFORE`, `MAIN`, `CONTROLS`, `AFTER`, `CLEANUP`. On `GATE`, `ModuleController` decides whether to run the other phases. On `BEFORE` / `AFTER` it calls hooks `onShowBefore` / `onShowAfter` / `onHideBefore` / `onHideAfter` (subclasses override methods; do not subscribe themselves). On `HIDE.CLEANUP` it calls `setDefaultState` when `SHOULD_CLEAR_STATE_ON_CLEANUP`. Base `EVENTS.SETTINGS.CHANGED`: `state.isShow && updateViewFast()` (`onSettingChange`).
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Parameters
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
None.
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Settings
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
None.
|
|
31
31
|
|
|
32
|
-
##
|
|
32
|
+
## Modules
|
|
33
33
|
|
|
34
|
-
|
|
|
35
|
-
| ------------------- |
|
|
36
|
-
| `components.render` |
|
|
37
|
-
| `components.inject` |
|
|
38
|
-
| `components.logs` |
|
|
34
|
+
| Module | Role |
|
|
35
|
+
| ------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
36
|
+
| `components.render` | In `postinject` — `shared.viewForceAnimationSources`; in `setup` creates `#components` in the DOM; handles `RENDER`. |
|
|
37
|
+
| `components.inject` | Register and sequentially call inject handlers on `INJECT` / `INJECT_REG`. |
|
|
38
|
+
| `components.logs` | Log `RENDER` (result filtered from emit response). |
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Related plugins
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
Plugins whose events, constants, parameters, or settings are used in `@vnejs/plugins.core.components` code.
|
|
43
43
|
|
|
44
44
|
### plugins/core/
|
|
45
45
|
|
|
46
46
|
- [logs.md](./logs.md) — `LOGS`: `EVENTS.LOGS.EMIT` (`action`, …), `CONST.LOGS.FILTER_FROM_RESULT_OPTIONS`
|
|
47
47
|
- [system.md](./system.md) — `SYSTEM`: `CONST.SYSTEM.DOM_IDS` (`APP`, `COMPONENTS`)
|
|
48
48
|
|
|
49
|
-
###
|
|
49
|
+
### Other
|
|
50
50
|
|
|
51
|
-
—
|
|
51
|
+
— None
|
package/plugins/core/interact.md
CHANGED
|
@@ -1,47 +1,47 @@
|
|
|
1
1
|
# plugins/core/interact/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.core.interact` · namespace: `INTERACT`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Queue of user interaction handlers (continue click, wait for input, etc.) with push/pop keys.
|
|
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.core.interact`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ---------- | ----------------------- |
|
|
13
|
-
| `EMIT` | `vne:interact:emit` |
|
|
14
|
-
| `PUSH` | `vne:interact:push` |
|
|
15
|
-
| `POP` | `vne:interact:pop` |
|
|
16
|
-
| `PUSH_POP` | `vne:interact:push_pop` |
|
|
17
|
-
| `STARTED` | `vne:interact:started` |
|
|
18
|
-
| `ENDED` | `vne:interact:ended` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ---------- | ----------------------- | ------------------------------------------------------------------------------------------------- |
|
|
13
|
+
| `EMIT` | `vne:interact:emit` | Start an interaction cycle: if not busy — `STARTED`, call all handlers in parallel, then `ENDED`. |
|
|
14
|
+
| `PUSH` | `vne:interact:push` | Register a handler under a key. Payload: `{ key?, handler? }`. |
|
|
15
|
+
| `POP` | `vne:interact:pop` | Remove a handler by key. Payload: `{ key? }`. |
|
|
16
|
+
| `PUSH_POP` | `vne:interact:push_pop` | Temporarily replace a handler (`skipHandler`), run `handler`, then pop by `key`. |
|
|
17
|
+
| `STARTED` | `vne:interact:started` | Start of interaction cycle — before parallel handler calls. |
|
|
18
|
+
| `ENDED` | `vne:interact:ended` | End of interaction cycle — after all handlers finish. |
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Constants
|
|
21
21
|
|
|
22
|
-
- **`LOGS_ACTIONS`** —
|
|
22
|
+
- **`LOGS_ACTIONS`** — log labels: `EMIT`, `PUSH`, `POP`, `PUSH_POP`, `STARTED`, `ENDED`.
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Parameters
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
None.
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Settings
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
None.
|
|
31
31
|
|
|
32
|
-
##
|
|
32
|
+
## Modules
|
|
33
33
|
|
|
34
|
-
|
|
|
35
|
-
| --------------- |
|
|
36
|
-
| `interact` |
|
|
37
|
-
| `interact.logs` |
|
|
34
|
+
| Module | Role |
|
|
35
|
+
| --------------- | --------------------------------------------------------------------------------------------------------- |
|
|
36
|
+
| `interact` | In `postinject` — `shared.isInteractInProcess = false`; handler stack; `EMIT`, `PUSH`, `POP`, `PUSH_POP`. |
|
|
37
|
+
| `interact.logs` | Log all interact events. |
|
|
38
38
|
|
|
39
|
-
##
|
|
39
|
+
## Related plugins
|
|
40
40
|
|
|
41
41
|
### plugins/core/
|
|
42
42
|
|
|
43
43
|
- [logs.md](./logs.md) — `LOGS`: `EVENTS.LOGS.EMIT` (`action`, …), `CONST.LOGS.FILTER_FROM_RESULT_OPTIONS`
|
|
44
44
|
|
|
45
|
-
###
|
|
45
|
+
### Other
|
|
46
46
|
|
|
47
|
-
—
|
|
47
|
+
— None
|
package/plugins/core/logs.md
CHANGED
|
@@ -1,51 +1,51 @@
|
|
|
1
1
|
# plugins/core/logs/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.core.logs` · namespace: `LOGS`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Centralized logging to `window.VneLogs` and optionally the console.
|
|
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.core.logs`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| ------- | ---------------- |
|
|
13
|
-
| `EMIT` | `vne:logs:emit` |
|
|
14
|
-
| `PUSH` | `vne:logs:push` |
|
|
15
|
-
| `LOAD` | `vne:logs:load` |
|
|
16
|
-
| `CLEAR` | `vne:logs:clear` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| ------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
13
|
+
| `EMIT` | `vne:logs:emit` | Enqueue a log entry (when logging is on); then build `PUSH` with uid and timestamp. Source module name comes from `EmitParams.module`, not from the payload. |
|
|
14
|
+
| `PUSH` | `vne:logs:push` | Write a line to `window.VneLogs` and optionally print to the console. |
|
|
15
|
+
| `LOAD` | `vne:logs:load` | Download accumulated logs as a JSON file via `SYSTEM.FILE_LOAD`. |
|
|
16
|
+
| `CLEAR` | `vne:logs:clear` | Clear `window.VneLogs`. |
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
`EMIT` payload (`LogsEmitPayload`): `LogsValue` fields (`action: string` and other `LogsCloneable`: strings, numbers, boolean, bigint, null, arrays, and plain objects) plus optional `level`. No `module` in payload: `Module.emit(this.EVENTS.LOGS.EMIT, { action, … })` passes the module name via `EmitParams`.
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
In `ModuleCore`-based modules: `this.emit(this.EVENTS.LOGS.EMIT, { action: …, … })`.
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Constants
|
|
23
23
|
|
|
24
|
-
- **`FILTER_FROM_RESULT_OPTIONS`** — `{ filterFromResult: true }`:
|
|
24
|
+
- **`FILTER_FROM_RESULT_OPTIONS`** — `{ filterFromResult: true }`: on emit, the handler result is not included in the response array.
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Parameters
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
None.
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Settings
|
|
31
31
|
|
|
32
|
-
|
|
|
33
|
-
| ------------------------------ | --------- |
|
|
34
|
-
| `ENABLED` (`vne:logs:enabled`) | `boolean` |
|
|
32
|
+
| Key | Type | Meaning |
|
|
33
|
+
| ------------------------------ | --------- | -------------------------------------------------- |
|
|
34
|
+
| `ENABLED` (`vne:logs:enabled`) | `boolean` | Whether logging is on; `SETTINGS.INIT` in `setup`. |
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Modules
|
|
37
37
|
|
|
38
|
-
|
|
|
39
|
-
| ------ |
|
|
40
|
-
| `logs` | `SETTINGS.INIT` `ENABLED`
|
|
38
|
+
| Module | Role |
|
|
39
|
+
| ------ | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
40
|
+
| `logs` | `SETTINGS.INIT` `ENABLED` in `setup`; before `isReady` buffer `EMIT`; in `init` flush/clear by `ENABLED`; `PUSH`/`LOAD`/`CLEAR`. |
|
|
41
41
|
|
|
42
|
-
##
|
|
42
|
+
## Related plugins
|
|
43
43
|
|
|
44
44
|
### plugins/core/
|
|
45
45
|
|
|
46
46
|
- [settings.md](./settings.md) — `SETTINGS`: `INIT`; `SETTINGS.LOGS.ENABLED`
|
|
47
|
-
- [system.md](./system.md) — `SYSTEM`: `FILE_LOAD` (
|
|
47
|
+
- [system.md](./system.md) — `SYSTEM`: `FILE_LOAD` (download logs)
|
|
48
48
|
|
|
49
|
-
###
|
|
49
|
+
### Other
|
|
50
50
|
|
|
51
|
-
—
|
|
51
|
+
— None
|
package/plugins/core/media.md
CHANGED
|
@@ -1,61 +1,61 @@
|
|
|
1
1
|
# plugins/core/media/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.core.media` · namespace: `MEDIA`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Load, process, and cache media (image/audio/video) with concurrency limits.
|
|
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.core.media`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| --------------- | ------------------------- |
|
|
13
|
-
| `GET` | `vne:media:get` |
|
|
14
|
-
| `SET` | `vne:media:set` |
|
|
15
|
-
| `LOAD` | `vne:media:load` |
|
|
16
|
-
| `LOAD_CHECK` | `vne:media:load_check` |
|
|
17
|
-
| `LOAD_START` | `vne:media:load_start` |
|
|
18
|
-
| `LOAD_END` | `vne:media:load_end` |
|
|
19
|
-
| `ERROR_NO_SRC` | `vne:media:error_no_src` |
|
|
20
|
-
| `ERROR_FETCH` | `vne:media:error_fetch` |
|
|
21
|
-
| `PROCESS` | `vne:media:process` |
|
|
22
|
-
| `PROCESS_CHECK` | `vne:media:process_check` |
|
|
23
|
-
| `MEMORY_GET` | `vne:media:memory_get` |
|
|
24
|
-
| `MEMORY_SET` | `vne:media:memory_set` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| --------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
13
|
+
| `GET` | `vne:media:get` | Get a ready media element: from cache or through the load chain. Missing or broken asset → `null`, no infinite wait. |
|
|
14
|
+
| `SET` | `vne:media:set` | Put a ready DOM element in the media memory subsystem. |
|
|
15
|
+
| `LOAD` | `vne:media:load` | Start load by id/type/name with semaphore and dedup via `LOAD_CHECK`. Queue slot is released on error too. |
|
|
16
|
+
| `LOAD_CHECK` | `vne:media:load_check` | Check: already in memory, in process, or loading. |
|
|
17
|
+
| `LOAD_START` | `vne:media:load_start` | Asset load start (lifecycle marker). |
|
|
18
|
+
| `LOAD_END` | `vne:media:load_end` | Asset load end (lifecycle marker). |
|
|
19
|
+
| `ERROR_NO_SRC` | `vne:media:error_no_src` | Manifest has no src for the requested asset. |
|
|
20
|
+
| `ERROR_FETCH` | `vne:media:error_fetch` | Fetch error: network, non-ok HTTP, timeout. Broken blob is not stored in memory. |
|
|
21
|
+
| `PROCESS` | `vne:media:process` | Download blob, create `<img>` / `<audio>` / `<video>`, call `SET`. |
|
|
22
|
+
| `PROCESS_CHECK` | `vne:media:process_check` | Whether a process promise/result already exists for `mediaId`. |
|
|
23
|
+
| `MEMORY_GET` | `vne:media:memory_get` | Proxy to `MEMORY.GET` for the media namespace. |
|
|
24
|
+
| `MEMORY_SET` | `vne:media:memory_set` | Proxy to `MEMORY.SET` for the media namespace. |
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Constants
|
|
27
27
|
|
|
28
28
|
- **`TYPES`** — `"image"` | `"audio"` | `"video"`.
|
|
29
|
-
- **`PRIORITIES`** —
|
|
30
|
-
- **`LOGS_ACTIONS`** —
|
|
29
|
+
- **`PRIORITIES`** — queue priority numbers: `HIGH` (0), `MEDIUM` (1), `LOW` (2), `BACKGROUND` (3).
|
|
30
|
+
- **`LOGS_ACTIONS`** — log labels: get, set, load, load_start, load_end, error_no_src, error_fetch.
|
|
31
31
|
|
|
32
|
-
##
|
|
32
|
+
## Parameters
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
None.
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Settings
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
None.
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Modules
|
|
41
41
|
|
|
42
|
-
|
|
|
43
|
-
| --------------- |
|
|
44
|
-
| `media.load` | Semaphore
|
|
45
|
-
| `media.process` |
|
|
46
|
-
| `media.memory` |
|
|
47
|
-
| `media` |
|
|
48
|
-
| `media.logs` |
|
|
42
|
+
| Module | Role |
|
|
43
|
+
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
44
|
+
| `media.load` | Semaphore in `setup`; gated load, dedup, delegate to process/memory. Slot always released (`finally`), even when process rejects. |
|
|
45
|
+
| `media.process` | In `postinject` — `shared.mediaNoTimeoutSources` (on WEB immediately `.add("web")`); fetch blob and create DOM media. Non-ok HTTP and fetch timeout → `ERROR_FETCH`, no `SET`. |
|
|
46
|
+
| `media.memory` | In `setup`: hidden `#media` and `MEMORY.REG` (`onAdd` / `onClear`). |
|
|
47
|
+
| `media` | High-level get/set. `GET` returns `null` when asset is missing or not ready (broken image, error). |
|
|
48
|
+
| `media.logs` | Log media lifecycle. |
|
|
49
49
|
|
|
50
|
-
##
|
|
50
|
+
## Related plugins
|
|
51
51
|
|
|
52
52
|
### plugins/core/
|
|
53
53
|
|
|
54
54
|
- [logs.md](./logs.md) — `LOGS`: `EVENTS.LOGS.EMIT` (`action`, …), `CONST.LOGS.FILTER_FROM_RESULT_OPTIONS`
|
|
55
|
-
- [memory.md](./memory.md) — `MEMORY`: `REG`, `GET`, `SET` (
|
|
56
|
-
- [platforms.md](./platforms.md) — `PLATFORMS`: `CONST`, `PARAMS.CURRENT_PLATFORM` (
|
|
55
|
+
- [memory.md](./memory.md) — `MEMORY`: `REG`, `GET`, `SET` (via `MEMORY_GET` / `MEMORY_SET`)
|
|
56
|
+
- [platforms.md](./platforms.md) — `PLATFORMS`: `CONST`, `PARAMS.CURRENT_PLATFORM` (semaphore limit, mediaNoTimeout)
|
|
57
57
|
- [system.md](./system.md) — `SYSTEM`: `CONST.SYSTEM.HOST`, `DOM_IDS.MEDIA`
|
|
58
58
|
|
|
59
|
-
###
|
|
59
|
+
### Other
|
|
60
60
|
|
|
61
|
-
—
|
|
61
|
+
— None
|
package/plugins/core/memory.md
CHANGED
|
@@ -1,48 +1,48 @@
|
|
|
1
1
|
# plugins/core/memory/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.core.memory` · namespace: `MEMORY`
|
|
4
4
|
|
|
5
|
-
In-memory
|
|
5
|
+
In-memory cache with reference counting per module namespace; used by media, scenario, and others. Namespace registry — `shared.memory`, created in `Memory.postinject`.
|
|
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.core.memory`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| --------- | -------------------- |
|
|
13
|
-
| `GET` | `vne:memory:get` |
|
|
14
|
-
| `SET` | `vne:memory:set` |
|
|
15
|
-
| `REG` | `vne:memory:reg` |
|
|
16
|
-
| `KEYS` | `vne:memory:keys` |
|
|
17
|
-
| `CLEAR` | `vne:memory:clear` |
|
|
18
|
-
| `CLEARED` | `vne:memory:cleared` | In-memory
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| --------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
13
|
+
| `GET` | `vne:memory:get` | Get value by `module` + `key`; reset reference count to `initCounter`. |
|
|
14
|
+
| `SET` | `vne:memory:set` | Store a value; on first write call the namespace’s registered `onAdd`. |
|
|
15
|
+
| `REG` | `vne:memory:reg` | Register a namespace with `initCounter`, hooks `onAdd` / `onClear`. |
|
|
16
|
+
| `KEYS` | `vne:memory:keys` | List keys in the namespace. |
|
|
17
|
+
| `CLEAR` | `vne:memory:clear` | If module `memory.clear` is not `isReady` yet — no-op. Else decrement counts, remove zero-count entries, call `onClear` and `CLEARED`. |
|
|
18
|
+
| `CLEARED` | `vne:memory:cleared` | In-memory cache fully cleared. |
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## Constants
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
None.
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Parameters
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
None.
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Settings
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
None.
|
|
31
31
|
|
|
32
|
-
##
|
|
32
|
+
## Modules
|
|
33
33
|
|
|
34
|
-
|
|
|
35
|
-
| -------------- |
|
|
36
|
-
| `memory` | `REG`
|
|
37
|
-
| `memory.store` | `GET` / `SET` / `KEYS`
|
|
38
|
-
| `memory.clear` | `CLEAR`:
|
|
34
|
+
| Module | Role |
|
|
35
|
+
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
36
|
+
| `memory` | `REG` and `shared.memory = {}` in `postinject`. |
|
|
37
|
+
| `memory.store` | `GET` / `SET` / `KEYS` via `shared.memory`. Do not wait for `REG` — namespaces register in `setup`. Unregistered: `GET` → `null`, `SET` no-op, `KEYS` → `[]`. |
|
|
38
|
+
| `memory.clear` | `CLEAR`: ignored until `isReady`. Else decrement counts in `shared.memory`, remove zero-count entries, `onClear`, then `CLEARED`. |
|
|
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
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
# plugins/core/platforms/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.core.platforms` · namespace: `PLATFORMS`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Static registration of platform constants and the current platform (no modules or events).
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
None.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Constants
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Platform identifiers (strings):
|
|
14
14
|
|
|
15
|
-
|
|
|
15
|
+
| Key | Value |
|
|
16
16
|
| ---------- | ------------ |
|
|
17
17
|
| `WEB` | `"web"` |
|
|
18
18
|
| `MOBILE` | `"mobile"` |
|
|
@@ -23,26 +23,26 @@
|
|
|
23
23
|
| `LINUX` | `"linux"` |
|
|
24
24
|
| `WINDOWS` | `"windows"` |
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Parameters
|
|
27
27
|
|
|
28
|
-
|
|
|
29
|
-
| ------------------ |
|
|
30
|
-
| `CURRENT_PLATFORM` | `Platform` (
|
|
28
|
+
| Key | Type | Meaning |
|
|
29
|
+
| ------------------ | -------------------------------------- | -------------------------------- |
|
|
30
|
+
| `CURRENT_PLATFORM` | `Platform` (one of `CONSTANTS` values) | Current platform; Default `WEB`. |
|
|
31
31
|
|
|
32
|
-
##
|
|
32
|
+
## Settings
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
None.
|
|
35
35
|
|
|
36
|
-
##
|
|
36
|
+
## Modules
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
None.
|
|
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
|