@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,50 +1,50 @@
|
|
|
1
|
-
# QTE
|
|
1
|
+
# QTE and random
|
|
2
2
|
|
|
3
3
|
## % qte
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
A quick time event by id from the game params (`PARAMS.QTE.ITEMS`).
|
|
6
6
|
|
|
7
7
|
```vne
|
|
8
8
|
% qte door_lock
|
|
9
|
-
"
|
|
10
|
-
"
|
|
9
|
+
"Success — the indented body"
|
|
10
|
+
"Fail, or after the block — the next line"
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
| Success
|
|
16
|
-
| Fail /
|
|
13
|
+
| Result | Behavior |
|
|
14
|
+
| ----------------- | -------------------------------------------------- |
|
|
15
|
+
| Success | `curLine` moves to the first line inside the block |
|
|
16
|
+
| Fail / unknown id | Skip the indented block |
|
|
17
17
|
|
|
18
|
-
UI
|
|
18
|
+
The UI is [`../plugins/views.scenario/qte.md`](../plugins/views.scenario/qte.md).
|
|
19
19
|
|
|
20
|
-
### QTE
|
|
20
|
+
### QTE on a choose option
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
The bundle needs choose↔qte compatibility:
|
|
23
23
|
|
|
24
24
|
```vne
|
|
25
25
|
% choose
|
|
26
|
-
% choose.option "
|
|
26
|
+
% choose.option "Take the risk"
|
|
27
27
|
qte: easy
|
|
28
|
-
"
|
|
29
|
-
% choose.option "
|
|
30
|
-
"
|
|
28
|
+
"QTE success"
|
|
29
|
+
% choose.option "Give up" | qte-fallback
|
|
30
|
+
"A direct pick, or a failed QTE"
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
The keyword `| qte-fallback` marks the branch used on failure.
|
|
34
34
|
|
|
35
35
|
## % random
|
|
36
36
|
|
|
37
|
-
|
|
37
|
+
Picks one nested `% random.option` at random:
|
|
38
38
|
|
|
39
39
|
```vne
|
|
40
40
|
% random
|
|
41
41
|
% random.option
|
|
42
|
-
"
|
|
42
|
+
"Branch A"
|
|
43
43
|
% random.option
|
|
44
|
-
"
|
|
44
|
+
"Branch B"
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
##
|
|
47
|
+
## See also
|
|
48
48
|
|
|
49
49
|
- [`../plugins/scenario/qte.md`](../plugins/scenario/qte.md)
|
|
50
50
|
- [`../plugins/scenario/random.md`](../plugins/scenario/random.md)
|
package/scenario.guide/vars.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Variables: flag and counter
|
|
2
2
|
|
|
3
|
-
## flag —
|
|
3
|
+
## flag — boolean flags
|
|
4
4
|
|
|
5
5
|
```vne
|
|
6
6
|
$ flag seen
|
|
@@ -9,25 +9,25 @@ $ flag seen unset
|
|
|
9
9
|
$ flag seen unset | global
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
|
|
|
13
|
-
| --------------------- |
|
|
14
|
-
| `$ flag <name>` |
|
|
15
|
-
| `$ flag <name> set` |
|
|
16
|
-
| `$ flag <name> unset` |
|
|
17
|
-
| `\| global` |
|
|
12
|
+
| Form | Meaning |
|
|
13
|
+
| --------------------- | -------------------------------------------------------- |
|
|
14
|
+
| `$ flag <name>` | Set the flag |
|
|
15
|
+
| `$ flag <name> set` | Set the flag explicitly |
|
|
16
|
+
| `$ flag <name> unset` | Clear the flag |
|
|
17
|
+
| `\| global` | Global (across playthroughs / slots — by the vars rules) |
|
|
18
18
|
|
|
19
|
-
###
|
|
19
|
+
### Conditional block `% flag`
|
|
20
20
|
|
|
21
21
|
```vne
|
|
22
22
|
% flag testsFlags1
|
|
23
|
-
"
|
|
23
|
+
"The body runs when the flag is set"
|
|
24
24
|
% flag testsFlags5 unset
|
|
25
|
-
"
|
|
25
|
+
"The body runs when the flag is clear"
|
|
26
26
|
% flag testsFlags1 | global
|
|
27
|
-
"
|
|
27
|
+
"Check a global flag"
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
## counter —
|
|
30
|
+
## counter — numbers
|
|
31
31
|
|
|
32
32
|
```vne
|
|
33
33
|
$ counter n ++
|
|
@@ -38,9 +38,9 @@ $ counter n = 10
|
|
|
38
38
|
$ counter n ++ | global
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
Change ops: `++`, `--`, `+=`, `-=`, `=`.
|
|
42
42
|
|
|
43
|
-
###
|
|
43
|
+
### Conditional block `% counter`
|
|
44
44
|
|
|
45
45
|
```vne
|
|
46
46
|
% counter n > 0
|
|
@@ -49,19 +49,19 @@ $ counter n ++ | global
|
|
|
49
49
|
"…"
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
Comparisons: `>`, `>=`, `===`, `!==`, `<`, `<=`.
|
|
53
53
|
|
|
54
|
-
###
|
|
54
|
+
### In option props
|
|
55
55
|
|
|
56
56
|
```vne
|
|
57
57
|
% choose.option "+1"
|
|
58
58
|
disabled: $ counter n > 0 | global
|
|
59
59
|
$ counter n ++ | global
|
|
60
|
-
% choose.option "
|
|
60
|
+
% choose.option "Reset"
|
|
61
61
|
hided: $ counter n === 0 | global
|
|
62
62
|
$ counter n = 0 | global
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
-
##
|
|
65
|
+
## See also
|
|
66
66
|
|
|
67
67
|
- [`../plugins/vars/flags.md`](../plugins/vars/flags.md), [`counters.md`](../plugins/vars/counters.md)
|
package/scenario.guide/views.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# UI
|
|
1
|
+
# UI and screens
|
|
2
2
|
|
|
3
|
-
## interface (ADV / UI
|
|
3
|
+
## interface (ADV / scenario UI)
|
|
4
4
|
|
|
5
5
|
```vne
|
|
6
6
|
$ interface show
|
|
@@ -8,9 +8,9 @@ $ interface hide
|
|
|
8
8
|
$ interface view adv
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Actions: `show`, `hide`, `view` (the interface mode or view — a game value, often `adv`).
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## Screens
|
|
14
14
|
|
|
15
15
|
```vne
|
|
16
16
|
$ intro
|
|
@@ -21,34 +21,34 @@ $ credits hide
|
|
|
21
21
|
$ settings.defaults
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
|
|
|
25
|
-
| ------------------------- |
|
|
26
|
-
| `$ intro` |
|
|
27
|
-
| `$ disclaimer show <id>` |
|
|
28
|
-
| `$ mainmenu` |
|
|
29
|
-
| `$ credits show` / `hide` |
|
|
30
|
-
| `$ settings.defaults` |
|
|
24
|
+
| Command | Meaning |
|
|
25
|
+
| ------------------------- | ---------------------------------------------- |
|
|
26
|
+
| `$ intro` | Intro screen |
|
|
27
|
+
| `$ disclaimer show <id>` | Disclaimer (title/text/accept by id from locs) |
|
|
28
|
+
| `$ mainmenu` | Main menu |
|
|
29
|
+
| `$ credits show` / `hide` | Credits |
|
|
30
|
+
| `$ settings.defaults` | Reset settings to defaults (by the plugin) |
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
The game scenario decides when to call these (from `init`, from a menu).
|
|
33
33
|
|
|
34
34
|
## video / comment / achievement
|
|
35
35
|
|
|
36
36
|
```vne
|
|
37
37
|
$ video play {cutscene/01}
|
|
38
|
-
$ comment "
|
|
38
|
+
$ comment "A hint for the player" 5000
|
|
39
39
|
$ achievement unlock some_id
|
|
40
40
|
$ achievement lock some_id
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
|
|
|
44
|
-
| ------------- |
|
|
45
|
-
| `video` | `play`
|
|
46
|
-
| `comment` |
|
|
47
|
-
| `achievement` | `lock`, `unlock`
|
|
43
|
+
| Module | Actions |
|
|
44
|
+
| ------------- | -------------------------------------- |
|
|
45
|
+
| `video` | `play` |
|
|
46
|
+
| `comment` | text plus an optional duration; `hide` |
|
|
47
|
+
| `achievement` | `lock`, `unlock` |
|
|
48
48
|
|
|
49
49
|
## wallet / time / date
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
Less common in dialogue, but present in the command catalog:
|
|
52
52
|
|
|
53
53
|
```vne
|
|
54
54
|
$ wallet add …
|
|
@@ -60,7 +60,7 @@ $ date add …
|
|
|
60
60
|
$ date set …
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
##
|
|
63
|
+
## See also
|
|
64
64
|
|
|
65
65
|
- [`../plugins/views.scenario/interface.md`](../plugins/views.scenario/interface.md)
|
|
66
66
|
- Screens: [`../plugins/views.screens/`](../plugins/views.screens/)
|