@vnejs/docs 0.2.21 → 0.2.23

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.
Files changed (193) hide show
  1. package/CHANGELOG.md +17 -1
  2. package/README.md +7 -7
  3. package/architecture.md +75 -75
  4. package/manifest.json +1 -7
  5. package/package.json +1 -1
  6. package/plugins/audio/ambient.md +5 -5
  7. package/plugins/audio/audio.md +26 -26
  8. package/plugins/audio/music.md +5 -5
  9. package/plugins/audio/sound.md +5 -5
  10. package/plugins/audio/voice.md +9 -9
  11. package/plugins/canvas/bg.md +23 -23
  12. package/plugins/canvas/bg.speak.md +19 -19
  13. package/plugins/canvas/fill.md +23 -23
  14. package/plugins/canvas/layer.md +20 -20
  15. package/plugins/canvas/sprite.md +29 -29
  16. package/plugins/canvas/sprite.speak.md +16 -16
  17. package/plugins/canvas/text.md +24 -24
  18. package/plugins/canvas/video.md +22 -22
  19. package/plugins/canvas.layers/bl.md +12 -12
  20. package/plugins/canvas.layers/fl.md +12 -12
  21. package/plugins/canvas.layers/ml.md +12 -12
  22. package/plugins/canvas.layers/ul.md +11 -11
  23. package/plugins/canvas.props/animation.md +10 -10
  24. package/plugins/canvas.props/clip.md +7 -7
  25. package/plugins/canvas.props/filters.md +2 -2
  26. package/plugins/canvas.props/mask.md +8 -8
  27. package/plugins/canvas.props/scale.md +5 -5
  28. package/plugins/controls/controls.md +15 -15
  29. package/plugins/controls/cursor.md +34 -34
  30. package/plugins/controls/gamepad.md +27 -27
  31. package/plugins/controls/keyboard.md +2 -2
  32. package/plugins/core/components.md +10 -10
  33. package/plugins/core/interact.md +12 -12
  34. package/plugins/core/logs.md +10 -10
  35. package/plugins/core/media.md +21 -21
  36. package/plugins/core/memory.md +10 -10
  37. package/plugins/core/platforms.md +11 -11
  38. package/plugins/core/scenario.md +22 -22
  39. package/plugins/core/settings.md +9 -9
  40. package/plugins/core/stack.md +18 -18
  41. package/plugins/core/state.md +13 -13
  42. package/plugins/core/storage.md +32 -32
  43. package/plugins/core/system.md +24 -24
  44. package/plugins/core/vendors.md +7 -11
  45. package/plugins/entities/wallet.md +11 -11
  46. package/plugins/platform/android.md +2 -2
  47. package/plugins/platform/electron.md +2 -2
  48. package/plugins/platform/metric.md +7 -7
  49. package/plugins/rpg/damage.md +7 -7
  50. package/plugins/rpg/hit.md +8 -8
  51. package/plugins/rpg/skills.md +11 -11
  52. package/plugins/save/auto.md +11 -11
  53. package/plugins/save/continue.md +8 -8
  54. package/plugins/save/save.md +23 -23
  55. package/plugins/scales/health.md +2 -2
  56. package/plugins/scales/mana.md +2 -2
  57. package/plugins/scales/scales.md +15 -15
  58. package/plugins/scenario/autoread.md +14 -14
  59. package/plugins/scenario/choose.md +36 -36
  60. package/plugins/scenario/fastforward.md +38 -27
  61. package/plugins/scenario/pause.md +6 -6
  62. package/plugins/scenario/point_and_click.md +30 -30
  63. package/plugins/scenario/qte.md +16 -16
  64. package/plugins/scenario/random.md +3 -3
  65. package/plugins/settings/filter.md +5 -5
  66. package/plugins/settings/potato.md +6 -6
  67. package/plugins/settings/ratio.md +4 -4
  68. package/plugins/settings/textsize.md +5 -5
  69. package/plugins/settings/volume.md +7 -7
  70. package/plugins/text/inject.md +7 -7
  71. package/plugins/text/locs.md +13 -13
  72. package/plugins/text/meet.md +4 -4
  73. package/plugins/text/smooth.md +18 -18
  74. package/plugins/text/text.md +41 -41
  75. package/plugins/text/wall.md +4 -4
  76. package/plugins/time/date.md +6 -6
  77. package/plugins/time/time.md +7 -7
  78. package/plugins/vars/counters.md +12 -12
  79. package/plugins/vars/flags.md +10 -10
  80. package/plugins/vars/vars.md +16 -16
  81. package/plugins/views/achievement.md +26 -26
  82. package/plugins/views/comment.md +13 -13
  83. package/plugins/views/controls.hints.md +12 -12
  84. package/plugins/views/cursor.md +3 -3
  85. package/plugins/views/fps.md +13 -13
  86. package/plugins/views/gamepad.debug.md +16 -16
  87. package/plugins/views/settings.md +22 -22
  88. package/plugins/views/video.md +18 -18
  89. package/plugins/views.scenario/choose.md +21 -21
  90. package/plugins/views.scenario/interface.controls.md +13 -13
  91. package/plugins/views.scenario/interface.fastforward.md +11 -11
  92. package/plugins/views.scenario/interface.md +29 -29
  93. package/plugins/views.scenario/point_and_click.md +15 -15
  94. package/plugins/views.scenario/qte.md +25 -25
  95. package/plugins/views.screens/confirm.md +20 -20
  96. package/plugins/views.screens/credits.md +14 -14
  97. package/plugins/views.screens/disclaimer.md +20 -20
  98. package/plugins/views.screens/eula.md +21 -21
  99. package/plugins/views.screens/gallery.full.md +10 -10
  100. package/plugins/views.screens/gallery.md +30 -30
  101. package/plugins/views.screens/gamemenu.md +21 -21
  102. package/plugins/views.screens/history.md +26 -26
  103. package/plugins/views.screens/intro.md +14 -14
  104. package/plugins/views.screens/loading.md +13 -13
  105. package/plugins/views.screens/mainmenu.md +33 -33
  106. package/plugins/views.screens/mainmenu.socials.md +7 -7
  107. package/plugins/views.screens/save.md +21 -21
  108. package/plugins/views.screens/settings.defaults.md +14 -14
  109. package/plugins/views.screens/settings.md +16 -16
  110. package/scenario.catalog/index.md +69 -69
  111. package/scenario.catalog/stubs/achievement.md +6 -6
  112. package/scenario.catalog/stubs/audio.ambient.md +6 -6
  113. package/scenario.catalog/stubs/audio.music.md +6 -6
  114. package/scenario.catalog/stubs/audio.sound.md +6 -6
  115. package/scenario.catalog/stubs/audio.voice.md +6 -6
  116. package/scenario.catalog/stubs/bl.animation.md +6 -6
  117. package/scenario.catalog/stubs/bl.bg.md +6 -6
  118. package/scenario.catalog/stubs/bl.clip.md +6 -6
  119. package/scenario.catalog/stubs/bl.fill.md +6 -6
  120. package/scenario.catalog/stubs/bl.filter.md +6 -6
  121. package/scenario.catalog/stubs/bl.mask.md +6 -6
  122. package/scenario.catalog/stubs/bl.scale.md +6 -6
  123. package/scenario.catalog/stubs/bl.sprite.md +6 -6
  124. package/scenario.catalog/stubs/bl.text.md +6 -6
  125. package/scenario.catalog/stubs/bl.video.md +6 -6
  126. package/scenario.catalog/stubs/choose.block.md +4 -4
  127. package/scenario.catalog/stubs/choose.md +5 -5
  128. package/scenario.catalog/stubs/choose.option.md +4 -4
  129. package/scenario.catalog/stubs/comment.md +6 -6
  130. package/scenario.catalog/stubs/counter.md +5 -5
  131. package/scenario.catalog/stubs/credits.md +6 -6
  132. package/scenario.catalog/stubs/date.md +6 -6
  133. package/scenario.catalog/stubs/disclaimer.md +6 -6
  134. package/scenario.catalog/stubs/fl.animation.md +6 -6
  135. package/scenario.catalog/stubs/fl.bg.md +6 -6
  136. package/scenario.catalog/stubs/fl.clip.md +6 -6
  137. package/scenario.catalog/stubs/fl.fill.md +6 -6
  138. package/scenario.catalog/stubs/fl.filter.md +6 -6
  139. package/scenario.catalog/stubs/fl.mask.md +6 -6
  140. package/scenario.catalog/stubs/fl.scale.md +6 -6
  141. package/scenario.catalog/stubs/fl.sprite.md +6 -6
  142. package/scenario.catalog/stubs/fl.text.md +6 -6
  143. package/scenario.catalog/stubs/fl.video.md +6 -6
  144. package/scenario.catalog/stubs/flag.md +7 -7
  145. package/scenario.catalog/stubs/interface.md +6 -6
  146. package/scenario.catalog/stubs/intro.md +6 -6
  147. package/scenario.catalog/stubs/mainmenu.md +6 -6
  148. package/scenario.catalog/stubs/ml.animation.md +6 -6
  149. package/scenario.catalog/stubs/ml.bg.md +6 -6
  150. package/scenario.catalog/stubs/ml.clip.md +6 -6
  151. package/scenario.catalog/stubs/ml.fill.md +6 -6
  152. package/scenario.catalog/stubs/ml.filter.md +6 -6
  153. package/scenario.catalog/stubs/ml.mask.md +6 -6
  154. package/scenario.catalog/stubs/ml.scale.md +6 -6
  155. package/scenario.catalog/stubs/ml.sprite.md +6 -6
  156. package/scenario.catalog/stubs/ml.text.md +6 -6
  157. package/scenario.catalog/stubs/ml.video.md +6 -6
  158. package/scenario.catalog/stubs/other.md +6 -6
  159. package/scenario.catalog/stubs/pause.md +6 -6
  160. package/scenario.catalog/stubs/point-and-click.block.md +4 -4
  161. package/scenario.catalog/stubs/point-and-click.md +5 -5
  162. package/scenario.catalog/stubs/point-and-click.option.md +4 -4
  163. package/scenario.catalog/stubs/qte.md +6 -6
  164. package/scenario.catalog/stubs/random.md +6 -6
  165. package/scenario.catalog/stubs/random.option.md +6 -6
  166. package/scenario.catalog/stubs/save.auto.md +6 -6
  167. package/scenario.catalog/stubs/save.md +6 -6
  168. package/scenario.catalog/stubs/scenario.md +6 -6
  169. package/scenario.catalog/stubs/settings.defaults.md +6 -6
  170. package/scenario.catalog/stubs/stack.md +6 -6
  171. package/scenario.catalog/stubs/text.meet.md +6 -6
  172. package/scenario.catalog/stubs/text.wall.md +6 -6
  173. package/scenario.catalog/stubs/time.md +6 -6
  174. package/scenario.catalog/stubs/ul.animation.md +6 -6
  175. package/scenario.catalog/stubs/ul.bg.md +6 -6
  176. package/scenario.catalog/stubs/ul.clip.md +6 -6
  177. package/scenario.catalog/stubs/ul.fill.md +6 -6
  178. package/scenario.catalog/stubs/ul.filter.md +6 -6
  179. package/scenario.catalog/stubs/ul.mask.md +6 -6
  180. package/scenario.catalog/stubs/ul.scale.md +6 -6
  181. package/scenario.catalog/stubs/ul.sprite.md +6 -6
  182. package/scenario.catalog/stubs/ul.text.md +6 -6
  183. package/scenario.catalog/stubs/video.md +6 -6
  184. package/scenario.catalog/stubs/wallet.md +6 -6
  185. package/scenario.guide/README.md +21 -21
  186. package/scenario.guide/audio.md +6 -6
  187. package/scenario.guide/canvas.md +13 -13
  188. package/scenario.guide/choose.md +5 -5
  189. package/scenario.guide/flow.md +10 -10
  190. package/scenario.guide/point-and-click.md +5 -5
  191. package/scenario.guide/qte-random.md +4 -4
  192. package/scenario.guide/vars.md +6 -6
  193. package/scenario.guide/views.md +12 -12
@@ -4,22 +4,22 @@
4
4
 
5
5
  ## Слои
6
6
 
7
- | Префикс | Обычный смысл |
8
- |---------|----------------|
9
- | `bl` | Back layer (фон, дальние объекты) |
10
- | `ml` | Middle |
11
- | `fl` | Front / персонажи часто здесь |
12
- | `ul` | UI / верхний слой |
7
+ | Префикс | Обычный смысл |
8
+ | ------- | --------------------------------- |
9
+ | `bl` | Back layer (фон, дальние объекты) |
10
+ | `ml` | Middle |
11
+ | `fl` | Front / персонажи часто здесь |
12
+ | `ul` | UI / верхний слой |
13
13
 
14
14
  Состав `kind` зависит от слоя (например у `ul` может не быть `video`). Типичные kind:
15
15
 
16
- | Kind | Действия (часто) |
17
- |------|------------------|
18
- | `bg` | `show`, `hide`, `change` |
19
- | `sprite` | `show`, `hide`, `change`, `move` |
20
- | `video` | `show`, `hide`, `change` |
21
- | `text` | `show`, `hide`, `change`, `move` |
22
- | `fill` | `show`, `change`, `hide` |
16
+ | Kind | Действия (часто) |
17
+ | -------------------------------------------------- | ------------------------------------- |
18
+ | `bg` | `show`, `hide`, `change` |
19
+ | `sprite` | `show`, `hide`, `change`, `move` |
20
+ | `video` | `show`, `hide`, `change` |
21
+ | `text` | `show`, `hide`, `change`, `move` |
22
+ | `fill` | `show`, `change`, `hide` |
23
23
  | `filter` / `scale` / `clip` / `mask` / `animation` | `set` / `unset` (у mask ещё `change`) |
24
24
 
25
25
  ## Примеры
@@ -16,11 +16,11 @@
16
16
 
17
17
  ## Команды
18
18
 
19
- | Синтаксис | Смысл |
20
- |-----------|--------|
21
- | `% choose` | Открыть выбор; собрать `% choose.option` |
22
- | `% choose.option "…"` | Ветка; невыбранные пропускаются по indent |
23
- | `$ choose repeat` | Вернуться к ближайшему `% choose` **выше** в той же метке |
19
+ | Синтаксис | Смысл |
20
+ | --------------------- | --------------------------------------------------------- |
21
+ | `% choose` | Открыть выбор; собрать `% choose.option` |
22
+ | `% choose.option "…"` | Ветка; невыбранные пропускаются по indent |
23
+ | `$ choose repeat` | Вернуться к ближайшему `% choose` **выше** в той же метке |
24
24
 
25
25
  Если все опции `hided` (или список пуст) — блок пропускается.
26
26
 
@@ -8,11 +8,11 @@ $ stack call testsStackSubroutine
8
8
  $ stack pop
9
9
  ```
10
10
 
11
- | Действие | Смысл |
12
- |----------|--------|
13
- | `jump <label>` | Перейти на метку **без** сохранения возврата |
11
+ | Действие | Смысл |
12
+ | -------------- | ---------------------------------------------------------------------------- |
13
+ | `jump <label>` | Перейти на метку **без** сохранения возврата |
14
14
  | `call <label>` | Push текущей позиции, затем переход; в конце метки обычно `pop` или auto-pop |
15
- | `pop` | Вернуться к сохранённой позиции |
15
+ | `pop` | Вернуться к сохранённой позиции |
16
16
 
17
17
  `call` может передавать аргументы (см. тесты `tests/stack` в играх).
18
18
 
@@ -24,10 +24,10 @@ $ scenario anchor loop_start
24
24
  $ scenario goto loop_start
25
25
  ```
26
26
 
27
- | Действие | Смысл |
28
- |----------|--------|
27
+ | Действие | Смысл |
28
+ | --------------- | --------------------------------- |
29
29
  | `anchor <name>` | Именованная точка в текущей метке |
30
- | `goto <name>` | Перейти к якорю (в той же метке) |
30
+ | `goto <name>` | Перейти к якорю (в той же метке) |
31
31
 
32
32
  ## pause
33
33
 
@@ -44,10 +44,10 @@ $ save key "Глава: «Пробуждение в кошмаре»"
44
44
  $ save.auto
45
45
  ```
46
46
 
47
- | Команда | Смысл |
48
- |---------|--------|
47
+ | Команда | Смысл |
48
+ | ---------------- | ------------------------------------ |
49
49
  | `$ save key "…"` | Задать ключ/подпись слота сохранения |
50
- | `$ save.auto` | Автосохранение |
50
+ | `$ save.auto` | Автосохранение |
51
51
 
52
52
  ## Типичный каркас
53
53
 
@@ -19,11 +19,11 @@ Hotspot-выбор на фоне. UI — view-плагин; ветки — ка
19
19
 
20
20
  ## Команды
21
21
 
22
- | Синтаксис | Смысл |
23
- |-----------|--------|
24
- | `% point-and-click` | Открыть режим; собрать `.option` |
25
- | `% point-and-click.option {icon} x y` | Hotspot: иконка + координаты |
26
- | `$ point-and-click repeat` | Вернуться к ближайшему `% point-and-click` выше |
22
+ | Синтаксис | Смысл |
23
+ | ------------------------------------- | ----------------------------------------------- |
24
+ | `% point-and-click` | Открыть режим; собрать `.option` |
25
+ | `% point-and-click.option {icon} x y` | Hotspot: иконка + координаты |
26
+ | `$ point-and-click repeat` | Вернуться к ближайшему `% point-and-click` выше |
27
27
 
28
28
  `x` / `y` — числа (проценты/координаты UI — по конвенции игры). `{icon}` — id иконки из медиа.
29
29
 
@@ -10,10 +10,10 @@ Quick Time Event по id из параметров игры (`PARAMS.QTE.ITEMS`)
10
10
  "Провал или после блока — следующая строка"
11
11
  ```
12
12
 
13
- | Исход | Поведение |
14
- |-------|-----------|
15
- | Success | `curLine` на первую строку внутри блока |
16
- | Fail / неизвестный id | Пропуск indented-блока |
13
+ | Исход | Поведение |
14
+ | --------------------- | --------------------------------------- |
15
+ | Success | `curLine` на первую строку внутри блока |
16
+ | Fail / неизвестный id | Пропуск indented-блока |
17
17
 
18
18
  UI — [`../plugins/views.scenario/qte.md`](../plugins/views.scenario/qte.md).
19
19
 
@@ -9,12 +9,12 @@ $ flag seen unset
9
9
  $ flag seen unset | global
10
10
  ```
11
11
 
12
- | Форма | Смысл |
13
- |-------|--------|
14
- | `$ flag <name>` | Установить (set) |
15
- | `$ flag <name> set` | Явный set |
16
- | `$ flag <name> unset` | Снять |
17
- | `\| global` | Глобальный (между прохождениями / слотами — по правилам vars) |
12
+ | Форма | Смысл |
13
+ | --------------------- | ------------------------------------------------------------- |
14
+ | `$ flag <name>` | Установить (set) |
15
+ | `$ flag <name> set` | Явный set |
16
+ | `$ flag <name> unset` | Снять |
17
+ | `\| global` | Глобальный (между прохождениями / слотами — по правилам vars) |
18
18
 
19
19
  ### Условный блок `% flag`
20
20
 
@@ -21,13 +21,13 @@ $ credits hide
21
21
  $ settings.defaults
22
22
  ```
23
23
 
24
- | Команда | Смысл |
25
- |---------|--------|
26
- | `$ intro` | Интро-экран |
27
- | `$ disclaimer show <id>` | Дисклеймер (title/text/accept по id из locs) |
28
- | `$ mainmenu` | Главное меню |
29
- | `$ credits show` / `hide` | Титры |
30
- | `$ settings.defaults` | Сброс/дефолты настроек (по плагину) |
24
+ | Команда | Смысл |
25
+ | ------------------------- | -------------------------------------------- |
26
+ | `$ intro` | Интро-экран |
27
+ | `$ disclaimer show <id>` | Дисклеймер (title/text/accept по id из locs) |
28
+ | `$ mainmenu` | Главное меню |
29
+ | `$ credits show` / `hide` | Титры |
30
+ | `$ settings.defaults` | Сброс/дефолты настроек (по плагину) |
31
31
 
32
32
  Точный момент вызова (из `init`, из меню) задаёт сценарий игры.
33
33
 
@@ -40,11 +40,11 @@ $ achievement unlock some_id
40
40
  $ achievement lock some_id
41
41
  ```
42
42
 
43
- | Модуль | Действия |
44
- |--------|----------|
45
- | `video` | `play` |
46
- | `comment` | текст + опционально длительность; `hide` |
47
- | `achievement` | `lock`, `unlock` |
43
+ | Модуль | Действия |
44
+ | ------------- | ---------------------------------------- |
45
+ | `video` | `play` |
46
+ | `comment` | текст + опционально длительность; `hide` |
47
+ | `achievement` | `lock`, `unlock` |
48
48
 
49
49
  ## wallet / time / date
50
50