@vnejs/docs 0.2.65 → 0.2.67
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -35
- package/architecture/backends.md +18 -0
- package/architecture/build.md +37 -0
- package/architecture/bundles.md +20 -0
- package/architecture/cli.md +25 -0
- package/architecture/compatibility.md +22 -0
- package/architecture/configs.md +19 -0
- package/architecture/contracts.md +30 -0
- package/architecture/dependencies.md +55 -0
- package/architecture/editor.md +7 -0
- package/architecture/games.md +38 -0
- package/architecture/helpers.md +14 -0
- package/architecture/model.md +43 -0
- package/architecture/modules.md +87 -0
- package/architecture/packages.md +43 -0
- package/architecture/plugins.md +36 -0
- package/architecture/uis.md +23 -0
- package/changelog/0.2.18.md +7 -0
- package/changelog/0.2.19.md +14 -0
- package/changelog/0.2.20.md +10 -0
- package/changelog/0.2.21.md +5 -0
- package/changelog/0.2.22.md +11 -0
- package/changelog/0.2.23.md +4 -0
- package/changelog/0.2.25.md +6 -0
- package/changelog/0.2.26.md +12 -0
- package/changelog/0.2.29.md +10 -0
- package/changelog/0.2.31.md +5 -0
- package/changelog/0.2.32.md +3 -0
- package/changelog/0.2.33.md +5 -0
- package/changelog/0.2.34.md +8 -0
- package/changelog/0.2.35.md +33 -0
- package/changelog/0.2.36.md +10 -0
- package/changelog/0.2.38.md +19 -0
- package/changelog/0.2.39.md +16 -0
- package/changelog/0.2.40.md +9 -0
- package/changelog/0.2.42.md +3 -0
- package/changelog/0.2.43.md +10 -0
- package/changelog/0.2.46.md +3 -0
- package/changelog/0.2.47.md +25 -0
- package/changelog/0.2.49.md +3 -0
- package/changelog/0.2.50.md +6 -0
- package/changelog/0.2.51.md +6 -0
- package/changelog/0.2.52.md +5 -0
- package/changelog/0.2.53.md +12 -0
- package/changelog/0.2.55.md +19 -0
- package/changelog/0.2.56.md +11 -0
- package/changelog/0.2.57.md +7 -0
- package/changelog/0.2.58.md +8 -0
- package/changelog/0.2.59.md +6 -0
- package/changelog/0.2.60.md +5 -0
- package/changelog/0.2.61.md +11 -0
- package/changelog/0.2.62.md +8 -0
- package/changelog/0.2.63.md +4 -0
- package/changelog/0.2.64.md +4 -0
- package/changelog/0.2.65.md +3 -0
- package/changelog/0.2.66.md +5 -0
- package/changelog/README.md +43 -0
- package/manifest.json +66 -5
- package/package.json +6 -4
- package/plugins/ai/ai.md +29 -29
- package/plugins/ai/checkers.md +26 -26
- package/plugins/audio/ambient.md +20 -20
- package/plugins/audio/audio.md +40 -40
- package/plugins/audio/music.md +20 -20
- package/plugins/audio/sound.md +20 -20
- package/plugins/audio/voice.md +23 -23
- package/plugins/canvas/bg.md +44 -44
- package/plugins/canvas/bg.speak.md +34 -34
- package/plugins/canvas/fill.md +33 -33
- package/plugins/canvas/layer.md +35 -35
- package/plugins/canvas/sprite.md +46 -46
- package/plugins/canvas/sprite.speak.md +33 -33
- package/plugins/canvas/text.md +37 -37
- package/plugins/canvas/video.md +37 -37
- package/plugins/canvas.layers/bl.md +33 -33
- package/plugins/canvas.layers/fl.md +33 -33
- package/plugins/canvas.layers/ml.md +33 -33
- package/plugins/canvas.layers/ul.md +32 -32
- package/plugins/canvas.props/animation.md +25 -25
- package/plugins/canvas.props/clip.md +22 -22
- package/plugins/canvas.props/filters.md +20 -20
- package/plugins/canvas.props/mask.md +23 -23
- package/plugins/canvas.props/scale.md +20 -20
- package/plugins/common/grid.md +23 -23
- package/plugins/common/turn.md +18 -18
- package/plugins/controls/controls.md +31 -31
- package/plugins/controls/cursor.md +54 -54
- package/plugins/controls/gamepad.md +56 -56
- package/plugins/controls/keyboard.md +17 -17
- package/plugins/core/components.md +28 -28
- package/plugins/core/interact.md +26 -26
- package/plugins/core/logs.md +28 -28
- package/plugins/core/media.md +38 -38
- package/plugins/core/memory.md +28 -28
- package/plugins/core/platforms.md +19 -19
- package/plugins/core/scenario.md +48 -48
- package/plugins/core/settings.md +24 -24
- package/plugins/core/stack.md +39 -39
- package/plugins/core/state.md +30 -30
- package/plugins/core/storage.md +56 -56
- package/plugins/core/system.md +37 -37
- package/plugins/core/vendors.md +19 -19
- package/plugins/entities/entities.md +16 -16
- package/plugins/entities/wallet.md +27 -27
- package/plugins/font/montserrat.md +16 -16
- package/plugins/game/checkers.md +38 -38
- package/plugins/platform/android.md +17 -17
- package/plugins/platform/electron.md +21 -21
- package/plugins/platform/metric.md +23 -23
- package/plugins/rpg/damage.md +22 -22
- package/plugins/rpg/hit.md +24 -24
- package/plugins/rpg/skills.md +26 -26
- package/plugins/save/auto.md +26 -26
- package/plugins/save/continue.md +23 -23
- package/plugins/save/quick.md +24 -24
- package/plugins/save/save.md +37 -37
- package/plugins/scales/health.md +17 -17
- package/plugins/scales/mana.md +17 -17
- package/plugins/scales/scales.md +31 -31
- package/plugins/scenario/autoread.md +36 -36
- package/plugins/scenario/choose.md +74 -65
- package/plugins/scenario/fastforward.md +46 -46
- package/plugins/scenario/history.md +41 -41
- package/plugins/scenario/pause.md +27 -27
- package/plugins/scenario/point_and_click.md +51 -51
- package/plugins/scenario/qte.md +54 -54
- package/plugins/scenario/random.md +17 -17
- package/plugins/settings/filter.md +19 -19
- package/plugins/settings/potato.md +22 -22
- package/plugins/settings/ratio.md +19 -19
- package/plugins/settings/textsize.md +19 -19
- package/plugins/settings/volume.md +21 -21
- package/plugins/text/inject.md +22 -22
- package/plugins/text/locs.md +36 -36
- package/plugins/text/meet.md +19 -19
- package/plugins/text/smooth.md +33 -33
- package/plugins/text/text.md +76 -69
- package/plugins/text/wall.md +20 -20
- package/plugins/time/date.md +22 -22
- package/plugins/time/time.md +23 -23
- package/plugins/vars/counters.md +28 -28
- package/plugins/vars/flags.md +24 -24
- package/plugins/vars/vars.md +29 -29
- package/plugins/views/achievement.md +44 -44
- package/plugins/views/comment.md +31 -31
- package/plugins/views/controls.hints.md +34 -34
- package/plugins/views/cursor.md +19 -19
- package/plugins/views/fps.md +33 -33
- package/plugins/views/gamepad.debug.md +32 -32
- package/plugins/views/settings.md +39 -39
- package/plugins/views/video.md +37 -37
- package/plugins/views.scenario/choose.md +41 -41
- package/plugins/views.scenario/interface.controls.md +31 -31
- package/plugins/views.scenario/interface.fastforward.md +29 -29
- package/plugins/views.scenario/interface.md +74 -74
- package/plugins/views.scenario/point_and_click.md +39 -39
- package/plugins/views.scenario/qte.md +51 -51
- package/plugins/views.screens/checkers.md +35 -35
- package/plugins/views.screens/confirm.md +35 -35
- package/plugins/views.screens/credits.md +31 -31
- package/plugins/views.screens/disclaimer.md +42 -42
- package/plugins/views.screens/eula.md +37 -37
- package/plugins/views.screens/gallery.full.md +41 -41
- package/plugins/views.screens/gallery.md +75 -75
- package/plugins/views.screens/gamemenu.md +41 -41
- package/plugins/views.screens/history.md +39 -39
- package/plugins/views.screens/intro.md +32 -32
- package/plugins/views.screens/loading.md +30 -30
- package/plugins/views.screens/mainmenu.md +49 -49
- package/plugins/views.screens/mainmenu.socials.md +25 -25
- package/plugins/views.screens/save.md +66 -66
- package/plugins/views.screens/settings.defaults.md +37 -37
- package/plugins/views.screens/settings.md +40 -40
- package/scenario.catalog/README.md +13 -13
- package/scenario.catalog/index.md +35 -35
- package/scenario.catalog/stubs/achievement.md +4 -4
- package/scenario.catalog/stubs/audio.ambient.md +4 -4
- package/scenario.catalog/stubs/audio.music.md +4 -4
- package/scenario.catalog/stubs/audio.sound.md +4 -4
- package/scenario.catalog/stubs/audio.voice.md +4 -4
- package/scenario.catalog/stubs/bl.animation.md +5 -5
- package/scenario.catalog/stubs/bl.bg.md +5 -5
- package/scenario.catalog/stubs/bl.clip.md +5 -5
- package/scenario.catalog/stubs/bl.fill.md +5 -5
- package/scenario.catalog/stubs/bl.filter.md +5 -5
- package/scenario.catalog/stubs/bl.mask.md +5 -5
- package/scenario.catalog/stubs/bl.scale.md +5 -5
- package/scenario.catalog/stubs/bl.sprite.md +5 -5
- package/scenario.catalog/stubs/bl.text.md +5 -5
- package/scenario.catalog/stubs/bl.video.md +5 -5
- package/scenario.catalog/stubs/choose.block.md +7 -7
- package/scenario.catalog/stubs/choose.md +4 -4
- package/scenario.catalog/stubs/choose.option.md +7 -7
- package/scenario.catalog/stubs/comment.md +5 -5
- package/scenario.catalog/stubs/counter.md +5 -5
- package/scenario.catalog/stubs/credits.md +4 -4
- package/scenario.catalog/stubs/date.md +4 -4
- package/scenario.catalog/stubs/disclaimer.md +5 -5
- package/scenario.catalog/stubs/fl.animation.md +5 -5
- package/scenario.catalog/stubs/fl.bg.md +5 -5
- package/scenario.catalog/stubs/fl.clip.md +5 -5
- package/scenario.catalog/stubs/fl.fill.md +5 -5
- package/scenario.catalog/stubs/fl.filter.md +5 -5
- package/scenario.catalog/stubs/fl.mask.md +5 -5
- package/scenario.catalog/stubs/fl.scale.md +5 -5
- package/scenario.catalog/stubs/fl.sprite.md +5 -5
- package/scenario.catalog/stubs/fl.text.md +5 -5
- package/scenario.catalog/stubs/fl.video.md +5 -5
- package/scenario.catalog/stubs/flag.md +13 -13
- package/scenario.catalog/stubs/interface.md +4 -4
- package/scenario.catalog/stubs/intro.md +4 -4
- package/scenario.catalog/stubs/mainmenu.md +4 -4
- package/scenario.catalog/stubs/ml.animation.md +5 -5
- package/scenario.catalog/stubs/ml.bg.md +5 -5
- package/scenario.catalog/stubs/ml.clip.md +5 -5
- package/scenario.catalog/stubs/ml.fill.md +5 -5
- package/scenario.catalog/stubs/ml.filter.md +5 -5
- package/scenario.catalog/stubs/ml.mask.md +5 -5
- package/scenario.catalog/stubs/ml.scale.md +5 -5
- package/scenario.catalog/stubs/ml.sprite.md +5 -5
- package/scenario.catalog/stubs/ml.text.md +5 -5
- package/scenario.catalog/stubs/ml.video.md +5 -5
- package/scenario.catalog/stubs/other.md +6 -6
- package/scenario.catalog/stubs/pause.md +5 -5
- package/scenario.catalog/stubs/point-and-click.block.md +4 -4
- package/scenario.catalog/stubs/point-and-click.md +4 -4
- package/scenario.catalog/stubs/point-and-click.option.md +4 -4
- package/scenario.catalog/stubs/qte.md +4 -4
- package/scenario.catalog/stubs/random.md +4 -4
- package/scenario.catalog/stubs/random.option.md +4 -4
- package/scenario.catalog/stubs/save.auto.md +4 -4
- package/scenario.catalog/stubs/save.md +5 -5
- package/scenario.catalog/stubs/scenario.md +4 -4
- package/scenario.catalog/stubs/settings.defaults.md +4 -4
- package/scenario.catalog/stubs/stack.md +4 -4
- package/scenario.catalog/stubs/text.meet.md +4 -4
- package/scenario.catalog/stubs/text.wall.md +4 -4
- package/scenario.catalog/stubs/time.md +4 -4
- package/scenario.catalog/stubs/ul.animation.md +5 -5
- package/scenario.catalog/stubs/ul.bg.md +5 -5
- package/scenario.catalog/stubs/ul.clip.md +5 -5
- package/scenario.catalog/stubs/ul.fill.md +5 -5
- package/scenario.catalog/stubs/ul.filter.md +5 -5
- package/scenario.catalog/stubs/ul.mask.md +5 -5
- package/scenario.catalog/stubs/ul.scale.md +5 -5
- package/scenario.catalog/stubs/ul.sprite.md +5 -5
- package/scenario.catalog/stubs/ul.text.md +5 -5
- package/scenario.catalog/stubs/video.md +4 -4
- package/scenario.catalog/stubs/wallet.md +4 -4
- package/scenario.guide/README.md +38 -38
- package/scenario.guide/audio.md +11 -11
- package/scenario.guide/canvas.md +23 -23
- package/scenario.guide/choose.md +28 -28
- package/scenario.guide/dialogue.md +23 -23
- package/scenario.guide/flow.md +21 -21
- package/scenario.guide/point-and-click.md +12 -12
- package/scenario.guide/qte-random.md +20 -20
- package/scenario.guide/vars.md +19 -19
- package/scenario.guide/views.md +20 -20
- package/CHANGELOG.md +0 -387
- package/architecture.md +0 -566
|
@@ -1,67 +1,67 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Command index (SCENARIO_COMMANDS)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
One-line notes point at a stub. Guide: [`../scenario.guide/`](../scenario.guide/).
|
|
4
4
|
|
|
5
5
|
## Core / flow
|
|
6
6
|
|
|
7
|
-
|
|
|
7
|
+
| Command | Short | Stub |
|
|
8
8
|
| ------------- | --------------------- | ------------------------------------ |
|
|
9
9
|
| `$ scenario` | `anchor`, `goto` | [scenario.md](./stubs/scenario.md) |
|
|
10
10
|
| `$ stack` | `jump`, `call`, `pop` | [stack.md](./stubs/stack.md) |
|
|
11
|
-
| `$ pause` |
|
|
11
|
+
| `$ pause` | pause | [pause.md](./stubs/pause.md) |
|
|
12
12
|
| `$ save` | `key` | [save.md](./stubs/save.md) |
|
|
13
|
-
| `$ save.auto` |
|
|
13
|
+
| `$ save.auto` | autosave | [save.auto.md](./stubs/save.auto.md) |
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Dialogue / text
|
|
16
16
|
|
|
17
|
-
|
|
|
18
|
-
|
|
|
19
|
-
| `other` (
|
|
20
|
-
| `$ text.meet`
|
|
21
|
-
| `$ text.wall`
|
|
17
|
+
| Command | Short | Stub |
|
|
18
|
+
| ---------------- | ----------------------------- | ------------------------------------ |
|
|
19
|
+
| `other` (no `$`) | lines `"…"` / `<speaker> "…"` | [other.md](./stubs/other.md) |
|
|
20
|
+
| `$ text.meet` | record meeting a speaker | [text.meet.md](./stubs/text.meet.md) |
|
|
21
|
+
| `$ text.wall` | `start`, `end`, `clear` | [text.wall.md](./stubs/text.wall.md) |
|
|
22
22
|
|
|
23
23
|
## Vars
|
|
24
24
|
|
|
25
|
-
|
|
|
26
|
-
| ------------------------- |
|
|
27
|
-
| `$ flag` / `% flag` | set/unset
|
|
28
|
-
| `$ counter` / `% counter` |
|
|
25
|
+
| Command | Short | Stub |
|
|
26
|
+
| ------------------------- | --------------------------------- | -------------------------------- |
|
|
27
|
+
| `$ flag` / `% flag` | set/unset and a conditional block | [flag.md](./stubs/flag.md) |
|
|
28
|
+
| `$ counter` / `% counter` | arithmetic and comparisons | [counter.md](./stubs/counter.md) |
|
|
29
29
|
|
|
30
30
|
## Choose / PAC / QTE / random
|
|
31
31
|
|
|
32
|
-
|
|
|
32
|
+
| Command | Short | Stub |
|
|
33
33
|
| -------------------------- | --------------- | -------------------------------------------------------------- |
|
|
34
|
-
| `% choose` |
|
|
35
|
-
| `% choose.option` |
|
|
34
|
+
| `% choose` | option menu | [choose.block.md](./stubs/choose.block.md) |
|
|
35
|
+
| `% choose.option` | option branch | [choose.option.md](./stubs/choose.option.md) |
|
|
36
36
|
| `$ choose` | `repeat` | [choose.md](./stubs/choose.md) |
|
|
37
37
|
| `% point-and-click` | hotspots | [point-and-click.block.md](./stubs/point-and-click.block.md) |
|
|
38
38
|
| `% point-and-click.option` | `{icon} x y` | [point-and-click.option.md](./stubs/point-and-click.option.md) |
|
|
39
39
|
| `$ point-and-click` | `repeat` | [point-and-click.md](./stubs/point-and-click.md) |
|
|
40
|
-
| `% qte` | QTE
|
|
41
|
-
| `% random` |
|
|
42
|
-
| `% random.option` |
|
|
40
|
+
| `% qte` | QTE by id | [qte.md](./stubs/qte.md) |
|
|
41
|
+
| `% random` | a random branch | [random.md](./stubs/random.md) |
|
|
42
|
+
| `% random.option` | a random option | [random.option.md](./stubs/random.option.md) |
|
|
43
43
|
|
|
44
44
|
## Audio
|
|
45
45
|
|
|
46
|
-
|
|
|
46
|
+
| Command | Short | Stub |
|
|
47
47
|
| ----------------- | ----------------------------- | -------------------------------------------- |
|
|
48
48
|
| `$ audio.music` | play/stop/pause/resume/volume | [audio.music.md](./stubs/audio.music.md) |
|
|
49
|
-
| `$ audio.ambient` |
|
|
50
|
-
| `$ audio.sound` |
|
|
51
|
-
| `$ audio.voice` |
|
|
49
|
+
| `$ audio.ambient` | the same | [audio.ambient.md](./stubs/audio.ambient.md) |
|
|
50
|
+
| `$ audio.sound` | the same | [audio.sound.md](./stubs/audio.sound.md) |
|
|
51
|
+
| `$ audio.voice` | the same | [audio.voice.md](./stubs/audio.voice.md) |
|
|
52
52
|
|
|
53
53
|
## Views / screens / entities / time
|
|
54
54
|
|
|
55
|
-
|
|
|
55
|
+
| Command | Short | Stub |
|
|
56
56
|
| --------------------- | ---------------------- | ---------------------------------------------------- |
|
|
57
57
|
| `$ interface` | `show`, `hide`, `view` | [interface.md](./stubs/interface.md) |
|
|
58
|
-
| `$ intro` |
|
|
58
|
+
| `$ intro` | intro | [intro.md](./stubs/intro.md) |
|
|
59
59
|
| `$ disclaimer` | `show` + id | [disclaimer.md](./stubs/disclaimer.md) |
|
|
60
|
-
| `$ mainmenu` |
|
|
60
|
+
| `$ mainmenu` | main menu | [mainmenu.md](./stubs/mainmenu.md) |
|
|
61
61
|
| `$ credits` | `show`, `hide` | [credits.md](./stubs/credits.md) |
|
|
62
|
-
| `$ settings.defaults` |
|
|
62
|
+
| `$ settings.defaults` | settings defaults | [settings.defaults.md](./stubs/settings.defaults.md) |
|
|
63
63
|
| `$ video` | `play` | [video.md](./stubs/video.md) |
|
|
64
|
-
| `$ comment` |
|
|
64
|
+
| `$ comment` | a comment / `hide` | [comment.md](./stubs/comment.md) |
|
|
65
65
|
| `$ achievement` | `lock`, `unlock` | [achievement.md](./stubs/achievement.md) |
|
|
66
66
|
| `$ wallet` | `add`, `set`, `reset` | [wallet.md](./stubs/wallet.md) |
|
|
67
67
|
| `$ time` | `add`, `set` | [time.md](./stubs/time.md) |
|
|
@@ -69,11 +69,11 @@
|
|
|
69
69
|
|
|
70
70
|
## Canvas layers
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Pattern: `$ <layer>.<kind> <action> …`. Layers: `bl`, `fl`, `ml`, `ul`. Guide: [canvas.md](../scenario.guide/canvas.md).
|
|
73
73
|
|
|
74
74
|
### bl
|
|
75
75
|
|
|
76
|
-
|
|
|
76
|
+
| Command | Actions | Stub |
|
|
77
77
|
| ---------------- | ------------------------ | ------------------------------------------ |
|
|
78
78
|
| `$ bl.bg` | show, hide, change | [bl.bg.md](./stubs/bl.bg.md) |
|
|
79
79
|
| `$ bl.sprite` | show, hide, change, move | [bl.sprite.md](./stubs/bl.sprite.md) |
|
|
@@ -88,16 +88,16 @@
|
|
|
88
88
|
|
|
89
89
|
### fl / ml
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
The same kinds as `bl` (`bg` … `animation`, including `video`):
|
|
92
92
|
|
|
93
93
|
- `fl.*` → [fl.bg.md](./stubs/fl.bg.md), [fl.sprite.md](./stubs/fl.sprite.md), [fl.video.md](./stubs/fl.video.md), [fl.text.md](./stubs/fl.text.md), [fl.fill.md](./stubs/fl.fill.md), [fl.filter.md](./stubs/fl.filter.md), [fl.scale.md](./stubs/fl.scale.md), [fl.clip.md](./stubs/fl.clip.md), [fl.mask.md](./stubs/fl.mask.md), [fl.animation.md](./stubs/fl.animation.md)
|
|
94
94
|
- `ml.*` → [ml.bg.md](./stubs/ml.bg.md), [ml.sprite.md](./stubs/ml.sprite.md), [ml.video.md](./stubs/ml.video.md), [ml.text.md](./stubs/ml.text.md), [ml.fill.md](./stubs/ml.fill.md), [ml.filter.md](./stubs/ml.filter.md), [ml.scale.md](./stubs/ml.scale.md), [ml.clip.md](./stubs/ml.clip.md), [ml.mask.md](./stubs/ml.mask.md), [ml.animation.md](./stubs/ml.animation.md)
|
|
95
95
|
|
|
96
96
|
### ul
|
|
97
97
|
|
|
98
|
-
|
|
98
|
+
No `video`:
|
|
99
99
|
|
|
100
|
-
|
|
|
100
|
+
| Command | Stub |
|
|
101
101
|
| ---------------- | ------------------------------------------ |
|
|
102
102
|
| `$ ul.bg` | [ul.bg.md](./stubs/ul.bg.md) |
|
|
103
103
|
| `$ ul.sprite` | [ul.sprite.md](./stubs/ul.sprite.md) |
|
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ------------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ achievement <action> …` |
|
|
7
7
|
| Actions / args | lock, unlock |
|
|
8
8
|
| Plugin doc | [views/achievement.md](../plugins/views/achievement.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ achievement unlock id
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
16
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ audio.ambient <action> …` |
|
|
7
7
|
| Actions / args | play, stop, pause, resume, volume |
|
|
8
8
|
| Plugin doc | [audio/ambient.md](../plugins/audio/ambient.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ audio.ambient play {rain}
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
16
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ audio.music <action> …` |
|
|
7
7
|
| Actions / args | play, stop, pause, resume, volume |
|
|
8
8
|
| Plugin doc | [audio/music.md](../plugins/audio/music.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ audio.music play {theme}
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
16
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ audio.sound <action> …` |
|
|
7
7
|
| Actions / args | play, stop, pause, resume, volume |
|
|
8
8
|
| Plugin doc | [audio/sound.md](../plugins/audio/sound.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ audio.sound play {ui/click}
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
16
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ audio.voice <action> …` |
|
|
7
7
|
| Actions / args | play, stop, pause, resume, volume |
|
|
8
8
|
| Plugin doc | [audio/voice.md](../plugins/audio/voice.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ audio.voice play {fl/line_01}
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
16
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.animation <action> …` |
|
|
7
7
|
| Actions / args | set, unset |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.animation set …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.bg <action> …` |
|
|
7
7
|
| Actions / args | show, hide, change |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.bg show …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.clip <action> …` |
|
|
7
7
|
| Actions / args | set, unset |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.clip set …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.fill <action> …` |
|
|
7
7
|
| Actions / args | show, change, hide |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.fill show …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.filter <action> …` |
|
|
7
7
|
| Actions / args | set, unset |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.filter set …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.mask <action> …` |
|
|
7
7
|
| Actions / args | set, unset, change |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.mask set …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.scale <action> …` |
|
|
7
7
|
| Actions / args | set, unset |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.scale set …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.sprite <action> …` |
|
|
7
7
|
| Actions / args | show, hide, change, move |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.sprite show …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.text <action> …` |
|
|
7
7
|
| Actions / args | show, hide, change, move |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.text show …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ bl.video <action> …` |
|
|
7
7
|
| Actions / args | show, hide, change |
|
|
8
8
|
| Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ bl.video show …
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Every layer uses the same pattern. See [guide canvas](../../scenario.guide/canvas.md).
|
|
17
17
|
|
|
18
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
18
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -2,24 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| ---------- | ------------------------------------------------------ |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `block` (`%`) |
|
|
6
|
+
| Signature | `% choose` |
|
|
7
7
|
| Plugin doc | [scenario/choose.md](../../plugins/scenario/choose.md) |
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Examples
|
|
10
10
|
|
|
11
11
|
```vne
|
|
12
12
|
% choose
|
|
13
|
-
% choose.option "
|
|
13
|
+
% choose.option "Look around"
|
|
14
14
|
hided: $ flag seen
|
|
15
15
|
$ flag seen
|
|
16
16
|
$ choose repeat
|
|
17
|
-
% choose.option "
|
|
17
|
+
% choose.option "Leave"
|
|
18
18
|
"…"
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
When every option is `hided`, the block is skipped.
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
See [guide choose](../../scenario.guide/choose.md).
|
|
24
24
|
|
|
25
25
|
Source of truth: `contracts/scenario/choose/src/commands.ts`.
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| ---------- | ------------------------------------------------------ |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ choose repeat` |
|
|
7
7
|
| Actions | `repeat` |
|
|
8
8
|
| Plugin doc | [scenario/choose.md](../../plugins/scenario/choose.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ choose repeat
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Return to the nearest `% choose` above in the same label. The full look-around loop is in [guide choose](../../scenario.guide/choose.md).
|
|
17
17
|
|
|
18
18
|
Source of truth: `contracts/scenario/choose/src/commands.ts`.
|
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| ---------- | ------------------------------------------------------ |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `block` (`%`) |
|
|
6
|
+
| Signature | `% choose.option "…"` |
|
|
7
7
|
| Plugin doc | [scenario/choose.md](../../plugins/scenario/choose.md) |
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Examples
|
|
10
10
|
|
|
11
11
|
```vne
|
|
12
|
-
% choose.option "
|
|
13
|
-
"
|
|
14
|
-
% choose.option "
|
|
12
|
+
% choose.option "Leave"
|
|
13
|
+
"Branch"
|
|
14
|
+
% choose.option "With QTE"
|
|
15
15
|
qte: easy
|
|
16
16
|
% choose.option "Fallback" | qte-fallback
|
|
17
17
|
"…"
|
|
@@ -19,6 +19,6 @@
|
|
|
19
19
|
|
|
20
20
|
Props: `hided:`, `disabled:`, `qte:`. Keyword `| qte-fallback`.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
See [guide choose](../../scenario.guide/choose.md).
|
|
23
23
|
|
|
24
24
|
Source of truth: `contracts/scenario/choose/src/commands.ts`.
|
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| -------------- | ----------------------------------------------- |
|
|
5
|
-
|
|
|
6
|
-
|
|
|
5
|
+
| Type | `module` (`$`) |
|
|
6
|
+
| Signature | `$ comment …` |
|
|
7
7
|
| Actions / args | hide (+ freeform text line) |
|
|
8
8
|
| Plugin doc | [views/comment.md](../plugins/views/comment.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
|
-
$ comment "
|
|
13
|
+
$ comment "Hint" 5000
|
|
14
14
|
$ comment hide
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
17
|
+
Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
# counter ($
|
|
1
|
+
# counter ($ and %)
|
|
2
2
|
|
|
3
3
|
| | |
|
|
4
4
|
| ----------- | --------------------------------------------------------------------- |
|
|
5
|
-
|
|
|
5
|
+
| Type | `module` (`$`) and `block` (`%`) |
|
|
6
6
|
| `$ counter` | `$ counter <name> [op] [number]` — `++` `--` `+=` `-=` `=` |
|
|
7
7
|
| `% counter` | `% counter <name> <compare> [number]` — `>` `>=` `===` `!==` `<` `<=` |
|
|
8
8
|
| Plugin doc | [vars/counters.md](../../plugins/vars/counters.md) |
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Examples
|
|
11
11
|
|
|
12
12
|
```vne
|
|
13
13
|
$ counter n ++
|
|
@@ -16,6 +16,6 @@ $ counter n = 10 | global
|
|
|
16
16
|
"…"
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
See also [guide vars](../../scenario.guide/vars.md).
|
|
20
20
|
|
|
21
|
-
Source of truth: `SCENARIO_COMMANDS`
|
|
21
|
+
Source of truth: `SCENARIO_COMMANDS` in `contracts/vars/counters/src/commands.ts`.
|