@amxts/core 0.1.0

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 (247) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +162 -0
  3. package/README.ru.md +162 -0
  4. package/amxmodx/base/include/amxconst.inc +594 -0
  5. package/amxmodx/base/include/amxmisc.inc +902 -0
  6. package/amxmodx/base/include/amxmodx.inc +3447 -0
  7. package/amxmodx/base/include/amxmodx_version.inc +20 -0
  8. package/amxmodx/base/include/cellarray.inc +525 -0
  9. package/amxmodx/base/include/cellstack.inc +166 -0
  10. package/amxmodx/base/include/celltrie.inc +412 -0
  11. package/amxmodx/base/include/core.inc +202 -0
  12. package/amxmodx/base/include/csstats.inc +298 -0
  13. package/amxmodx/base/include/csstats_const.inc +29 -0
  14. package/amxmodx/base/include/cstrike.inc +1287 -0
  15. package/amxmodx/base/include/cstrike_const.inc +521 -0
  16. package/amxmodx/base/include/csx.inc +259 -0
  17. package/amxmodx/base/include/cvars.inc +547 -0
  18. package/amxmodx/base/include/datapack.inc +161 -0
  19. package/amxmodx/base/include/dbi.inc +154 -0
  20. package/amxmodx/base/include/dodconst.inc +152 -0
  21. package/amxmodx/base/include/dodfun.inc +152 -0
  22. package/amxmodx/base/include/dodstats.inc +69 -0
  23. package/amxmodx/base/include/dodx.inc +161 -0
  24. package/amxmodx/base/include/engine.inc +1343 -0
  25. package/amxmodx/base/include/engine_const.inc +310 -0
  26. package/amxmodx/base/include/engine_stocks.inc +248 -0
  27. package/amxmodx/base/include/esf.inc +70 -0
  28. package/amxmodx/base/include/esf_const.inc +74 -0
  29. package/amxmodx/base/include/fakemeta.inc +1127 -0
  30. package/amxmodx/base/include/fakemeta_const.inc +793 -0
  31. package/amxmodx/base/include/fakemeta_stocks.inc +395 -0
  32. package/amxmodx/base/include/fakemeta_util.inc +882 -0
  33. package/amxmodx/base/include/file.inc +666 -0
  34. package/amxmodx/base/include/float.inc +422 -0
  35. package/amxmodx/base/include/fun.inc +333 -0
  36. package/amxmodx/base/include/gameconfig.inc +93 -0
  37. package/amxmodx/base/include/geoip.inc +264 -0
  38. package/amxmodx/base/include/ham_const.inc +4352 -0
  39. package/amxmodx/base/include/hamsandwich.inc +439 -0
  40. package/amxmodx/base/include/hlsdk_const.inc +808 -0
  41. package/amxmodx/base/include/json.inc +777 -0
  42. package/amxmodx/base/include/lang.inc +119 -0
  43. package/amxmodx/base/include/message_const.inc +1130 -0
  44. package/amxmodx/base/include/message_stocks.inc +161 -0
  45. package/amxmodx/base/include/messages.inc +604 -0
  46. package/amxmodx/base/include/newmenus.inc +387 -0
  47. package/amxmodx/base/include/ns.inc +754 -0
  48. package/amxmodx/base/include/ns_const.inc +196 -0
  49. package/amxmodx/base/include/nvault.inc +154 -0
  50. package/amxmodx/base/include/regex.inc +348 -0
  51. package/amxmodx/base/include/sockets.inc +183 -0
  52. package/amxmodx/base/include/sorting.inc +107 -0
  53. package/amxmodx/base/include/sqlx.inc +582 -0
  54. package/amxmodx/base/include/string.inc +786 -0
  55. package/amxmodx/base/include/string_const.inc +156 -0
  56. package/amxmodx/base/include/string_stocks.inc +325 -0
  57. package/amxmodx/base/include/textparse_ini.inc +214 -0
  58. package/amxmodx/base/include/textparse_smc.inc +261 -0
  59. package/amxmodx/base/include/tfcconst.inc +84 -0
  60. package/amxmodx/base/include/tfcstats.inc +62 -0
  61. package/amxmodx/base/include/tfcx.inc +148 -0
  62. package/amxmodx/base/include/time.inc +118 -0
  63. package/amxmodx/base/include/tsconst.inc +154 -0
  64. package/amxmodx/base/include/tsfun.inc +198 -0
  65. package/amxmodx/base/include/tsstats.inc +65 -0
  66. package/amxmodx/base/include/tsx.inc +88 -0
  67. package/amxmodx/base/include/vault.inc +60 -0
  68. package/amxmodx/base/include/vector.inc +131 -0
  69. package/amxmodx/base/include/xs.inc +1570 -0
  70. package/as/amxts.d.ts +153 -0
  71. package/as/constants.ts +4730 -0
  72. package/as/effects.ts +1449 -0
  73. package/as/entities.ts +5482 -0
  74. package/as/events.ts +3054 -0
  75. package/as/facade.ts +4639 -0
  76. package/as/flags.ts +299 -0
  77. package/as/fs.ts +287 -0
  78. package/as/hooks.ts +18536 -0
  79. package/as/kit.ts +25 -0
  80. package/as/lib/check.ts +86 -0
  81. package/as/modules/http.ts +184 -0
  82. package/as/natives.ts +11845 -0
  83. package/as/os.ts +30 -0
  84. package/as/promise.ts +1392 -0
  85. package/as/promise.types.d.ts +82 -0
  86. package/as/remote.ts +288 -0
  87. package/as/tsconfig.json +22 -0
  88. package/as/vector.ts +65 -0
  89. package/bin/amxts.mjs +10 -0
  90. package/includes/menu_core.inc +355 -0
  91. package/includes/order.txt +54 -0
  92. package/includes/sources.json +27 -0
  93. package/includes/universal_config.inc +355 -0
  94. package/lint/oxlint-plugin.mjs +77 -0
  95. package/node_modules/assemblyscript/LICENSE +201 -0
  96. package/node_modules/assemblyscript/NOTICE +93 -0
  97. package/node_modules/assemblyscript/package.json +63 -0
  98. package/node_modules/assemblyscript/std/README.md +6 -0
  99. package/node_modules/assemblyscript/std/assembly/array.ts +526 -0
  100. package/node_modules/assemblyscript/std/assembly/arraybuffer.ts +77 -0
  101. package/node_modules/assemblyscript/std/assembly/atomics.ts +127 -0
  102. package/node_modules/assemblyscript/std/assembly/bindings/asyncify.ts +16 -0
  103. package/node_modules/assemblyscript/std/assembly/bindings/dom.ts +291 -0
  104. package/node_modules/assemblyscript/std/assembly/bindings/node.ts +6 -0
  105. package/node_modules/assemblyscript/std/assembly/builtins.ts +2631 -0
  106. package/node_modules/assemblyscript/std/assembly/compat.ts +2 -0
  107. package/node_modules/assemblyscript/std/assembly/console.ts +42 -0
  108. package/node_modules/assemblyscript/std/assembly/crypto.ts +9 -0
  109. package/node_modules/assemblyscript/std/assembly/dataview.ts +181 -0
  110. package/node_modules/assemblyscript/std/assembly/date.ts +373 -0
  111. package/node_modules/assemblyscript/std/assembly/diagnostics.ts +11 -0
  112. package/node_modules/assemblyscript/std/assembly/error.ts +44 -0
  113. package/node_modules/assemblyscript/std/assembly/function.ts +38 -0
  114. package/node_modules/assemblyscript/std/assembly/index.d.ts +2822 -0
  115. package/node_modules/assemblyscript/std/assembly/iterator.ts +35 -0
  116. package/node_modules/assemblyscript/std/assembly/map.ts +260 -0
  117. package/node_modules/assemblyscript/std/assembly/math.ts +3289 -0
  118. package/node_modules/assemblyscript/std/assembly/memory.ts +123 -0
  119. package/node_modules/assemblyscript/std/assembly/number.ts +388 -0
  120. package/node_modules/assemblyscript/std/assembly/object.ts +36 -0
  121. package/node_modules/assemblyscript/std/assembly/performance.ts +9 -0
  122. package/node_modules/assemblyscript/std/assembly/polyfills.ts +27 -0
  123. package/node_modules/assemblyscript/std/assembly/process.ts +50 -0
  124. package/node_modules/assemblyscript/std/assembly/reference.ts +48 -0
  125. package/node_modules/assemblyscript/std/assembly/regexp.ts +12 -0
  126. package/node_modules/assemblyscript/std/assembly/rt/README.md +83 -0
  127. package/node_modules/assemblyscript/std/assembly/rt/common.ts +81 -0
  128. package/node_modules/assemblyscript/std/assembly/rt/index-incremental.ts +2 -0
  129. package/node_modules/assemblyscript/std/assembly/rt/index-minimal.ts +2 -0
  130. package/node_modules/assemblyscript/std/assembly/rt/index-stub.ts +1 -0
  131. package/node_modules/assemblyscript/std/assembly/rt/index.d.ts +37 -0
  132. package/node_modules/assemblyscript/std/assembly/rt/itcms.ts +419 -0
  133. package/node_modules/assemblyscript/std/assembly/rt/rtrace.ts +15 -0
  134. package/node_modules/assemblyscript/std/assembly/rt/stub.ts +133 -0
  135. package/node_modules/assemblyscript/std/assembly/rt/tcms.ts +254 -0
  136. package/node_modules/assemblyscript/std/assembly/rt/tlsf.ts +592 -0
  137. package/node_modules/assemblyscript/std/assembly/rt.ts +87 -0
  138. package/node_modules/assemblyscript/std/assembly/set.ts +220 -0
  139. package/node_modules/assemblyscript/std/assembly/shared/feature.ts +65 -0
  140. package/node_modules/assemblyscript/std/assembly/shared/runtime.ts +11 -0
  141. package/node_modules/assemblyscript/std/assembly/shared/target.ts +11 -0
  142. package/node_modules/assemblyscript/std/assembly/shared/tsconfig.json +11 -0
  143. package/node_modules/assemblyscript/std/assembly/shared/typeinfo.ts +72 -0
  144. package/node_modules/assemblyscript/std/assembly/staticarray.ts +401 -0
  145. package/node_modules/assemblyscript/std/assembly/string.ts +847 -0
  146. package/node_modules/assemblyscript/std/assembly/symbol.ts +114 -0
  147. package/node_modules/assemblyscript/std/assembly/table.ts +16 -0
  148. package/node_modules/assemblyscript/std/assembly/tsconfig.json +6 -0
  149. package/node_modules/assemblyscript/std/assembly/typedarray.ts +1945 -0
  150. package/node_modules/assemblyscript/std/assembly/uri.ts +17 -0
  151. package/node_modules/assemblyscript/std/assembly/util/bytes.ts +107 -0
  152. package/node_modules/assemblyscript/std/assembly/util/casemap.ts +497 -0
  153. package/node_modules/assemblyscript/std/assembly/util/error.ts +54 -0
  154. package/node_modules/assemblyscript/std/assembly/util/hash.ts +117 -0
  155. package/node_modules/assemblyscript/std/assembly/util/math.ts +1922 -0
  156. package/node_modules/assemblyscript/std/assembly/util/memory.ts +290 -0
  157. package/node_modules/assemblyscript/std/assembly/util/number.ts +873 -0
  158. package/node_modules/assemblyscript/std/assembly/util/sort.ts +313 -0
  159. package/node_modules/assemblyscript/std/assembly/util/string.ts +1202 -0
  160. package/node_modules/assemblyscript/std/assembly/util/uri.ts +275 -0
  161. package/node_modules/assemblyscript/std/assembly/vector.ts +4 -0
  162. package/node_modules/assemblyscript/std/assembly.json +16 -0
  163. package/node_modules/assemblyscript/std/portable/index.d.ts +462 -0
  164. package/node_modules/assemblyscript/std/portable/index.js +416 -0
  165. package/node_modules/assemblyscript/std/portable.json +11 -0
  166. package/node_modules/assemblyscript/std/types/assembly/index.d.ts +1 -0
  167. package/node_modules/assemblyscript/std/types/assembly/package.json +3 -0
  168. package/node_modules/assemblyscript/std/types/portable/index.d.ts +1 -0
  169. package/node_modules/assemblyscript/std/types/portable/package.json +3 -0
  170. package/node_modules/assemblyscript/tsconfig-base.json +13 -0
  171. package/package.json +112 -0
  172. package/runtime/deps/assemblyscript/LICENSE +201 -0
  173. package/runtime/deps/assemblyscript/NOTICE +93 -0
  174. package/runtime/deps/assemblyscript/bin/asc.js +35 -0
  175. package/runtime/deps/assemblyscript/dist/asc.js +25035 -0
  176. package/runtime/deps/assemblyscript/dist/assemblyscript.js +337 -0
  177. package/runtime/deps/assemblyscript/node_modules/binaryen/LICENSE +201 -0
  178. package/runtime/deps/assemblyscript/node_modules/binaryen/index.js +28905 -0
  179. package/runtime/deps/assemblyscript/node_modules/binaryen/package.json +50 -0
  180. package/runtime/deps/assemblyscript/node_modules/long/LICENSE +202 -0
  181. package/runtime/deps/assemblyscript/node_modules/long/index.js +1581 -0
  182. package/runtime/deps/assemblyscript/node_modules/long/package.json +58 -0
  183. package/runtime/deps/assemblyscript/package.json +114 -0
  184. package/runtime/host/amxts.inc +85 -0
  185. package/runtime/licenses/AMXX-LICENSE.txt +34 -0
  186. package/runtime/licenses/AssemblyScript-LICENSE +201 -0
  187. package/runtime/licenses/AssemblyScript-NOTICE +93 -0
  188. package/runtime/licenses/Binaryen-LICENSE +201 -0
  189. package/runtime/licenses/Bun-LICENSE.md +84 -0
  190. package/runtime/licenses/GPL-3.0.txt +674 -0
  191. package/runtime/licenses/LLVM-LICENSE.TXT +279 -0
  192. package/runtime/licenses/README.md +25 -0
  193. package/runtime/licenses/WAMR-LICENSE +219 -0
  194. package/runtime/natives.txt +1095 -0
  195. package/runtime/patches/README.md +59 -0
  196. package/runtime/patches/assemblyscript-0.28.20-amxts.patch +14174 -0
  197. package/runtime/patches/wamr-2.4.5-amxts.patch +364 -0
  198. package/scripts/apply-docs.ts +508 -0
  199. package/scripts/asc.ts +27 -0
  200. package/scripts/auto-imports.ts +258 -0
  201. package/scripts/build-wasm.ts +595 -0
  202. package/scripts/check.ts +93 -0
  203. package/scripts/compile-cache.ts +179 -0
  204. package/scripts/compile.ts +401 -0
  205. package/scripts/docker-server.ts +73 -0
  206. package/scripts/docs/as/amxts.ts +210 -0
  207. package/scripts/docs/as/effects.ts +1684 -0
  208. package/scripts/docs/as/facade.ts +3302 -0
  209. package/scripts/docs/as/fs.ts +173 -0
  210. package/scripts/docs/as/lib/check.ts +68 -0
  211. package/scripts/docs/as/modules/http.ts +66 -0
  212. package/scripts/docs/as/os.ts +16 -0
  213. package/scripts/docs/as/promise.ts +132 -0
  214. package/scripts/docs/as/promise.types.ts +63 -0
  215. package/scripts/docs/as/vector.ts +48 -0
  216. package/scripts/docs/entities.ts +2338 -0
  217. package/scripts/docs/events.ts +245 -0
  218. package/scripts/docs/game.ts +497 -0
  219. package/scripts/docs/messages.ts +148 -0
  220. package/scripts/file-contents.ts +74 -0
  221. package/scripts/includes.ts +134 -0
  222. package/scripts/player-fields.ts +866 -0
  223. package/scripts/plugin-cache.ts +92 -0
  224. package/scripts/plugin-natives.ts +1157 -0
  225. package/scripts/prebuilt.ts +268 -0
  226. package/scripts/prepare.ts +134 -0
  227. package/scripts/project.ts +973 -0
  228. package/scripts/run.ts +28 -0
  229. package/scripts/shared-modules.ts +906 -0
  230. package/scripts/system.ts +33 -0
  231. package/scripts/tracked-fs.ts +115 -0
  232. package/scripts/typed-configs.ts +788 -0
  233. package/scripts/ui.ts +77 -0
  234. package/src/cli-api.mjs +175 -0
  235. package/src/parser/include-parser.ts +506 -0
  236. package/src/system.mjs +155 -0
  237. package/src/testing/compile-cache.ts +31 -0
  238. package/src/testing/compile.ts +222 -0
  239. package/src/testing/coroutines.ts +191 -0
  240. package/src/testing/index.ts +39 -0
  241. package/src/testing/kits.ts +55 -0
  242. package/src/testing/memory.ts +125 -0
  243. package/src/testing/natives.ts +925 -0
  244. package/src/testing/server.ts +1874 -0
  245. package/src/testing/setup.ts +63 -0
  246. package/src/testing/tables.ts +139 -0
  247. package/src/types.ts +51 -0
@@ -0,0 +1,173 @@
1
+ // The tooltips of as/fs.ts, in both languages: scripts/apply-docs.ts writes the
2
+ // one AMXTS_DOCS_LANG picks into the JSDoc above each element.
3
+ export default {
4
+ 'readFileSync': {
5
+ en: `
6
+ Reads a whole file as text; \`null\` when it cannot be opened.
7
+
8
+ \`\`\`ts
9
+ const text = fs.readFileSync("addons/amxmodx/configs/myplugin.ini");
10
+ if (text == null) return;
11
+ \`\`\`
12
+
13
+ The path is relative to the game folder (\`cstrike/\`), as for any AMX Mod X
14
+ plugin. The file is UTF-8; it is read whole, whatever its size.
15
+
16
+ Pawn: \`fopen\`, \`fread_blocks\`
17
+ `,
18
+ ru: `
19
+ Читает весь файл как текст; \`null\`, если его не удалось открыть.
20
+
21
+ \`\`\`ts
22
+ const text = fs.readFileSync("addons/amxmodx/configs/myplugin.ini");
23
+ if (text == null) return;
24
+ \`\`\`
25
+
26
+ Путь считается от папки игры (\`cstrike/\`), как у любого плагина AMX Mod X.
27
+ Файл в UTF-8; он читается целиком, какого бы размера ни был.
28
+
29
+ Pawn: \`fopen\`, \`fread_blocks\`
30
+ `,
31
+ },
32
+ 'writeFileSync': {
33
+ en: `
34
+ Writes text to a file, replacing what was there; \`false\` when it cannot be
35
+ opened (a folder that does not exist, for one).
36
+
37
+ \`\`\`ts
38
+ fs.writeFileSync("addons/amxmodx/data/last-map.txt", server.map);
39
+ \`\`\`
40
+
41
+ Pawn: \`fopen\`, \`fputs\`
42
+ `,
43
+ ru: `
44
+ Записывает текст в файл вместо того, что там было; \`false\`, если файл не
45
+ удалось открыть (например, такой папки нет).
46
+
47
+ \`\`\`ts
48
+ fs.writeFileSync("addons/amxmodx/data/last-map.txt", server.map);
49
+ \`\`\`
50
+
51
+ Pawn: \`fopen\`, \`fputs\`
52
+ `,
53
+ },
54
+ 'appendFileSync': {
55
+ en: `
56
+ Adds text to the end of a file, making it if there is none; \`false\` when it cannot be opened.
57
+
58
+ Pawn: \`fopen(path, "a")\`, \`fputs\`
59
+ `,
60
+ ru: `
61
+ Дописывает текст в конец файла, создавая его, если файла нет; \`false\`, если его не удалось открыть.
62
+
63
+ Pawn: \`fopen(path, "a")\`, \`fputs\`
64
+ `,
65
+ },
66
+ 'existsSync': {
67
+ en: `
68
+ \`true\` when the file or folder exists.
69
+
70
+ Pawn: \`file_exists\`, \`dir_exists\`
71
+ `,
72
+ ru: `
73
+ \`true\`, если такой файл или папка есть.
74
+
75
+ Pawn: \`file_exists\`, \`dir_exists\`
76
+ `,
77
+ },
78
+ 'readdirSync': {
79
+ en: `
80
+ Lists the names in a folder, without \`.\` and \`..\`; \`null\` when there is no
81
+ such folder.
82
+
83
+ \`\`\`ts
84
+ const maps = fs.readdirSync("maps");
85
+ \`\`\`
86
+
87
+ Pawn: \`open_dir\`, \`next_file\`
88
+ `,
89
+ ru: `
90
+ Возвращает имена в папке, без \`.\` и \`..\`; \`null\`, если такой папки нет.
91
+
92
+ \`\`\`ts
93
+ const maps = fs.readdirSync("maps");
94
+ \`\`\`
95
+
96
+ Pawn: \`open_dir\`, \`next_file\`
97
+ `,
98
+ },
99
+ 'MakeDirectoryOptions': {
100
+ en: `The options of \`mkdirSync\`: \`{ recursive: true }\` makes the missing folders above too.`,
101
+ ru: `Настройки \`mkdirSync\`: \`{ recursive: true }\` создаёт и недостающие папки выше.`,
102
+ },
103
+ 'MakeDirectoryOptions.recursive': {
104
+ en: `\`true\` to make every missing folder on the way too; \`false\` by default.`,
105
+ ru: `\`true\` — создать и все недостающие папки по пути; по умолчанию \`false\`.`,
106
+ },
107
+ 'mkdirSync': {
108
+ en: `
109
+ Makes a folder; \`false\` when it cannot be made, or - without \`recursive\` -
110
+ when it is there already or its parent is not.
111
+
112
+ \`\`\`ts
113
+ fs.mkdirSync("addons/amxmodx/data/stats", { recursive: true });
114
+ \`\`\`
115
+
116
+ With \`{ recursive: true }\` every missing folder on the way is made, and a
117
+ folder that is already there is fine, as in Node.
118
+
119
+ Pawn: \`mkdir\`
120
+ `,
121
+ ru: `
122
+ Создаёт папку; \`false\`, если создать не удалось, или — без \`recursive\` —
123
+ если она уже есть или нет родительской.
124
+
125
+ \`\`\`ts
126
+ fs.mkdirSync("addons/amxmodx/data/stats", { recursive: true });
127
+ \`\`\`
128
+
129
+ С \`{ recursive: true }\` создаются все недостающие папки по пути, а уже
130
+ существующая папка — не ошибка, как в Node.
131
+
132
+ Pawn: \`mkdir\`
133
+ `,
134
+ },
135
+ 'mkdir': {
136
+ en: `\`mkdirSync\` as a promise, rejected when the folder cannot be made.`,
137
+ ru: `\`mkdirSync\` в виде промиса; отклоняется, если папку не удалось создать.`,
138
+ },
139
+ 'readFile': {
140
+ en: `
141
+ \`readFileSync\` as a promise: it rejects with an \`ENOENT\` error when the file
142
+ cannot be opened, like Node's \`fs.promises.readFile\`.
143
+
144
+ \`\`\`ts
145
+ const text = await fs.readFile("addons/amxmodx/configs/myplugin.ini");
146
+ \`\`\`
147
+ `,
148
+ ru: `
149
+ \`readFileSync\` в виде промиса: если файл не удалось открыть, отклоняется с
150
+ ошибкой \`ENOENT\`, как \`fs.promises.readFile\` в Node.
151
+
152
+ \`\`\`ts
153
+ const text = await fs.readFile("addons/amxmodx/configs/myplugin.ini");
154
+ \`\`\`
155
+ `,
156
+ },
157
+ 'writeFile': {
158
+ en: `\`writeFileSync\` as a promise, rejected when the file cannot be opened.`,
159
+ ru: `\`writeFileSync\` в виде промиса; отклоняется, если файл не удалось открыть.`,
160
+ },
161
+ 'appendFile': {
162
+ en: `\`appendFileSync\` as a promise, rejected when the file cannot be opened.`,
163
+ ru: `\`appendFileSync\` в виде промиса; отклоняется, если файл не удалось открыть.`,
164
+ },
165
+ 'exists': {
166
+ en: `\`existsSync\` as a promise.`,
167
+ ru: `\`existsSync\` в виде промиса.`,
168
+ },
169
+ 'readdir': {
170
+ en: `\`readdirSync\` as a promise, rejected when there is no such folder.`,
171
+ ru: `\`readdirSync\` в виде промиса; отклоняется, если такой папки нет.`,
172
+ },
173
+ };
@@ -0,0 +1,68 @@
1
+ // The tooltips of as/lib/check.ts, in both languages: scripts/apply-docs.ts writes the
2
+ // one AMXTS_DOCS_LANG picks into the JSDoc above each element.
3
+ export default {
4
+ 'Checks': {
5
+ en: `
6
+ Checks of one piece of the API on a live server. Each goes to the server
7
+ console with the tag, as \`[tag] ok ...\` or \`[tag] FAIL ...\`; the player
8
+ who ran them gets the total in chat.
9
+
10
+ \`\`\`ts
11
+ const check = new Checks("api-async", player);
12
+ check.expect(player.gravity, "gravity").toBeCloseTo(0.5);
13
+ check.done();
14
+ \`\`\`
15
+ `,
16
+ ru: `
17
+ Проверки одной части API на живом сервере. Каждая пишется в консоль
18
+ сервера с тегом — \`[tag] ok ...\` или \`[tag] FAIL ...\`; игрок, который
19
+ их запустил, получает итог в чат.
20
+
21
+ \`\`\`ts
22
+ const check = new Checks("api-async", player);
23
+ check.expect(player.gravity, "gravity").toBeCloseTo(0.5);
24
+ check.done();
25
+ \`\`\`
26
+ `,
27
+ },
28
+ 'Checks.passed': {
29
+ en: `The number of checks passed so far.`,
30
+ ru: `Число пройденных проверок.`,
31
+ },
32
+ 'Checks.failed': {
33
+ en: `The number of checks failed so far.`,
34
+ ru: `Число проваленных проверок.`,
35
+ },
36
+ 'Checks.tag': {
37
+ en: `The checks' tag: every log line starts with it, \`[cvar]\`.`,
38
+ ru: `Тег проверок: с него начинается каждая строка лога, \`[cvar]\`.`,
39
+ },
40
+ 'Checks.player': {
41
+ en: `The player who ran the checks, if any: the total is printed to him too.`,
42
+ ru: `Игрок, запустивший проверки, если их запустил игрок: итог выводится и ему.`,
43
+ },
44
+ 'Checks.expect': {
45
+ en: `Starts a check of a value; \`what\` names it in the log: \`check.expect(player.gravity, "gravity")\`.`,
46
+ ru: `Начинает проверку значения; \`what\` — его имя в логе: \`check.expect(player.gravity, "gravity")\`.`,
47
+ },
48
+ 'Checks.done': {
49
+ en: `Prints the total, to the log and to the player.`,
50
+ ru: `Выводит итог — в лог и игроку.`,
51
+ },
52
+ 'Checks.record': {
53
+ en: `@hidden`,
54
+ ru: `@hidden Записывает одну проверку в лог и в итог.`,
55
+ },
56
+ 'Expectation': {
57
+ en: `One value under check, from \`check.expect(...)\`: \`toBe\` or \`toBeCloseTo\` logs the result.`,
58
+ ru: `Одно проверяемое значение из \`check.expect(...)\`: \`toBe\` или \`toBeCloseTo\` пишут результат в лог.`,
59
+ },
60
+ 'Expectation.toBe': {
61
+ en: `Checks the value equals \`expected\`: the same number, text or boolean.`,
62
+ ru: `Проверяет, что значение равно \`expected\`: то же число, текст или boolean.`,
63
+ },
64
+ 'Expectation.toBeCloseTo': {
65
+ en: `Checks the number is within \`0.001\` of \`expected\`: a value the game stores comes back rounded (\`0.5\` as \`0.49999\`).`,
66
+ ru: `Проверяет, что число отличается от \`expected\` меньше чем на \`0.001\`: значение, которое хранит игра, возвращается округлённым (\`0.5\` как \`0.49999\`).`,
67
+ },
68
+ };
@@ -0,0 +1,66 @@
1
+ // The tooltips of as/modules/http.ts, in both languages: scripts/apply-docs.ts writes the
2
+ // one AMXTS_DOCS_LANG picks into the JSDoc above each element.
3
+ export default {
4
+ 'RequestInit': {
5
+ en: `A request's options besides its URL. Every field is optional.`,
6
+ ru: `Настройки запроса помимо URL. Все поля необязательны.`,
7
+ },
8
+ 'RequestInit.method': {
9
+ en: `The request's method, one of \`"GET"\` (the default), \`"POST"\`, \`"PUT"\`, \`"PATCH"\`, \`"DELETE"\`.`,
10
+ ru: `Метод запроса, одно из \`"GET"\` (по умолчанию), \`"POST"\`, \`"PUT"\`, \`"PATCH"\`, \`"DELETE"\`.`,
11
+ },
12
+ 'RequestInit.body': {
13
+ en: `The text sent with the request, such as JSON for a POST; empty by default.`,
14
+ ru: `Текст, который уходит с запросом, например JSON для POST; по умолчанию пустой.`,
15
+ },
16
+ 'RequestInit.headers': {
17
+ en: `The request's headers, as pairs: \`[["Content-Type", "application/json"]]\`.`,
18
+ ru: `Заголовки запроса, парами: \`[["Content-Type", "application/json"]]\`.`,
19
+ },
20
+ 'RequestInit.signal': {
21
+ en: `
22
+ A signal that cancels the request; the promise then rejects with an
23
+ Error named \`"AbortError"\`. In an async command handler or player event,
24
+ the player leaving cancels the request too.
25
+ `,
26
+ ru: `
27
+ Сигнал, который отменяет запрос; промис тогда отклоняется с Error с
28
+ именем \`"AbortError"\`. В async-обработчике команды или события игрока
29
+ запрос отменяется и тогда, когда игрок выходит.
30
+ `,
31
+ },
32
+ 'Response': {
33
+ en: `The server's response to a request.`,
34
+ ru: `Ответ сервера на запрос.`,
35
+ },
36
+ 'Response.status': {
37
+ en: `The response's HTTP status: \`200\`, \`404\`, ...`,
38
+ ru: `HTTP-статус ответа: \`200\`, \`404\`, ...`,
39
+ },
40
+ 'Response.text': {
41
+ en: `The response's body, as text.`,
42
+ ru: `Тело ответа, текстом.`,
43
+ },
44
+ 'Response.ok': {
45
+ en: `\`true\` for a 2xx status.`,
46
+ ru: `\`true\` при статусе 2xx.`,
47
+ },
48
+ 'fetch': {
49
+ en: `
50
+ Sends a request. The promise is fulfilled with the response on a later
51
+ frame, and rejected when there is none - no connection, a bad URL, a
52
+ timeout, no \`easy_http\`, or an abort. An HTTP error such as \`404\` is a
53
+ response, as in fetch: check \`response.ok\`.
54
+
55
+ Pawn: \`ezhttp_get\`, \`ezhttp_post\` (easy_http)
56
+ `,
57
+ ru: `
58
+ Отправляет запрос. Промис выполняется с ответом в одном из следующих
59
+ кадров и отклоняется, если ответа нет: нет соединения, плохой URL,
60
+ таймаут, нет \`easy_http\` или отмена. HTTP-ошибка вроде \`404\` — это ответ,
61
+ как и в fetch: проверяйте \`response.ok\`.
62
+
63
+ Pawn: \`ezhttp_get\`, \`ezhttp_post\` (easy_http)
64
+ `,
65
+ },
66
+ };
@@ -0,0 +1,16 @@
1
+ // The tooltips of as/os.ts, in both languages: scripts/apply-docs.ts writes the
2
+ // one AMXTS_DOCS_LANG picks into the JSDoc above each element.
3
+ export default {
4
+ Platform: {
5
+ en: `The operating system's name as \`platform()\` gives it, with Node's names: one of \`"win32"\`, \`"linux"\`.`,
6
+ ru: `Имя операционной системы, как его даёт \`platform()\`, — те же имена, что в Node: одно из \`"win32"\`, \`"linux"\`.`,
7
+ },
8
+ platform: {
9
+ en: `Returns the operating system the server runs on, either \`"win32"\` or \`"linux"\`.`,
10
+ ru: `Возвращает операционную систему сервера, либо \`"win32"\`, либо \`"linux"\`.`,
11
+ },
12
+ EOL: {
13
+ en: `The line ending on this system, one of \`"\\r\\n"\` on Windows, \`"\\n"\` on Linux.`,
14
+ ru: `Конец строки в этой системе, одно из: \`"\\r\\n"\` на Windows, \`"\\n"\` на Linux.`,
15
+ },
16
+ };
@@ -0,0 +1,132 @@
1
+ // The tooltips of as/promise.ts, in both languages: scripts/apply-docs.ts writes the
2
+ // one AMXTS_DOCS_LANG picks into the JSDoc above each element.
3
+ export default {
4
+ 'PromiseBase': {
5
+ en: `The base of every Promise, whatever its value's type; a plugin uses Promise<T>.`,
6
+ ru: `Общая основа любого Promise, каким бы ни был тип значения; плагин пользуется Promise<T>.`,
7
+ },
8
+ 'PromiseLike': {
9
+ en: `Anything with a \`then\`: the type \`await\` takes in the editor. In a plugin, \`await\` a Promise.`,
10
+ ru: `Всё, у чего есть \`then\`: тип, который \`await\` принимает в редакторе. В плагине \`await\` ждёт Promise.`,
11
+ },
12
+ 'PromiseLike.then': {
13
+ en: `Calls \`onFulfilled\` with the value once there is one.`,
14
+ ru: `Вызывает \`onFulfilled\` со значением, когда оно появится.`,
15
+ },
16
+ 'Promise': {
17
+ en: `A value that is not there yet: the result of a request, a timer, an async function.`,
18
+ ru: `Значение, которого ещё нет: результат запроса, таймера, async-функции.`,
19
+ },
20
+ 'Promise.then': {
21
+ en: `
22
+ Calls \`onFulfilled\` with the value once there is one; the promise it
23
+ returns settles with what that returns. A rejection passes through to
24
+ it untouched, or to \`onRejected\` when there is one.
25
+ `,
26
+ ru: `
27
+ Вызывает \`onFulfilled\` со значением, когда оно появится; возвращённый
28
+ промис завершается тем, что вернёт \`onFulfilled\`. Отклонение переходит
29
+ в него как есть — или в \`onRejected\`, если он передан.
30
+ `,
31
+ },
32
+ 'Promise.catch': {
33
+ en: `
34
+ Calls \`onRejected\` with the reason if this is rejected. What it returns
35
+ is the value instead: \`readFile(path).catch(() => "")\` - or nothing, when
36
+ it only logs.
37
+ `,
38
+ ru: `
39
+ Вызывает \`onRejected\` с причиной, если промис отклонён. То, что он
40
+ вернёт, становится значением взамен — \`readFile(path).catch(() => "")\`, —
41
+ или ничего, если он только пишет в лог.
42
+ `,
43
+ },
44
+ 'Promise.finally': {
45
+ en: `Calls \`onFinally\` once this settles, either way, and passes the outcome on.`,
46
+ ru: `Вызывает \`onFinally\`, когда промис завершится, как бы ни завершился, и передаёт результат дальше.`,
47
+ },
48
+ 'Promise.resolve': {
49
+ en: `A promise already fulfilled with \`value\`.`,
50
+ ru: `Промис, уже выполненный со значением \`value\`.`,
51
+ },
52
+ 'Promise.reject': {
53
+ en: `A promise already rejected with \`reason\`.`,
54
+ ru: `Промис, уже отклонённый с причиной \`reason\`.`,
55
+ },
56
+ 'PromiseSettledResult': {
57
+ en: `A promise's outcome, as Promise.allSettled gives it for each.`,
58
+ ru: `Итог промиса — то, что Promise.allSettled даёт для каждого.`,
59
+ },
60
+ 'PromiseSettledResult.status': {
61
+ en: `The promise's outcome, either \`"fulfilled"\` or \`"rejected"\`.`,
62
+ ru: `Итог промиса, либо \`"fulfilled"\`, либо \`"rejected"\`.`,
63
+ },
64
+ 'PromiseSettledResult.value': {
65
+ en: `The promise's value, when fulfilled.`,
66
+ ru: `Значение промиса, если он выполнен.`,
67
+ },
68
+ 'PromiseSettledResult.reason': {
69
+ en: `The rejection's reason, when rejected.`,
70
+ ru: `Причина отказа, если промис отклонён.`,
71
+ },
72
+ 'AggregateError': {
73
+ en: `The error Promise.any rejects with when every promise is rejected; their reasons are in \`errors\`.`,
74
+ ru: `Ошибка, с которой отклоняется Promise.any, когда отклонены все промисы; их причины лежат в \`errors\`.`,
75
+ },
76
+ 'AggregateError.errors': {
77
+ en: `The reason each promise was rejected, in the order the promises were given.`,
78
+ ru: `Причины отказа каждого промиса, в том порядке, в каком промисы переданы.`,
79
+ },
80
+ 'Event': {
81
+ en: `The event an abort listener gets.`,
82
+ ru: `Событие, которое получает обработчик отмены.`,
83
+ },
84
+ 'Event.type': {
85
+ en: `The event's type; the only one here is \`"abort"\`.`,
86
+ ru: `Тип события; здесь он всегда \`"abort"\`.`,
87
+ },
88
+ 'AbortSignal': {
89
+ en: `A signal to give something up: a request, a timer, everything a player started.`,
90
+ ru: `Сигнал бросить начатое: запрос, таймер, всё, что начал игрок.`,
91
+ },
92
+ 'AbortSignal.aborted': {
93
+ en: `\`true\` once the signal has aborted.`,
94
+ ru: `\`true\`, если сигнал уже сработал.`,
95
+ },
96
+ 'AbortSignal.reason': {
97
+ en: `The abort's reason: an Error named \`"AbortError"\` unless \`abort()\` was given one.`,
98
+ ru: `Причина отмены: Error с именем \`"AbortError"\`, если в \`abort()\` не передали свою.`,
99
+ },
100
+ 'AbortSignal.addEventListener': {
101
+ en: `Calls \`listener\` when the signal aborts.`,
102
+ ru: `Вызывает \`listener\`, когда сигнал срабатывает.`,
103
+ },
104
+ 'AbortSignal.removeEventListener': {
105
+ en: `Takes back a \`listener\` given to \`addEventListener\`: it is not called any more.`,
106
+ ru: `Убирает \`listener\`, переданный в \`addEventListener\`: он больше не вызывается.`,
107
+ },
108
+ 'AbortSignal.timeout': {
109
+ en: `A signal that aborts by itself after \`ms\`, with an Error named \`"TimeoutError"\`.`,
110
+ ru: `Сигнал, который сам срабатывает через \`ms\` с Error с именем \`"TimeoutError"\`.`,
111
+ },
112
+ 'AbortSignal.abort': {
113
+ en: `A signal that has aborted already.`,
114
+ ru: `Сигнал, который уже сработал.`,
115
+ },
116
+ 'AbortSignal.any': {
117
+ en: `A signal that aborts when any of \`signals\` does.`,
118
+ ru: `Сигнал, который срабатывает, как только сработает любой из \`signals\`.`,
119
+ },
120
+ 'AbortController': {
121
+ en: `A controller that aborts its \`signal\` on demand: \`controller.abort()\`.`,
122
+ ru: `Контроллер, который отменяет свой \`signal\` по команде: \`controller.abort()\`.`,
123
+ },
124
+ 'AbortController.signal': {
125
+ en: `The controller's signal: hand it to fetch, sleep or anything else that takes one.`,
126
+ ru: `Сигнал контроллера: передайте его в fetch, sleep или куда угодно ещё, где принимают сигнал.`,
127
+ },
128
+ 'AbortController.abort': {
129
+ en: `Aborts the signal, with \`reason\` or an Error named \`"AbortError"\`.`,
130
+ ru: `Отменяет сигнал с причиной \`reason\` или с Error с именем \`"AbortError"\`.`,
131
+ },
132
+ };
@@ -0,0 +1,63 @@
1
+ // The tooltips of as/promise.types.d.ts, in both languages: scripts/apply-docs.ts writes the
2
+ // one AMXTS_DOCS_LANG picks into the JSDoc above each element.
3
+ export default {
4
+ 'Awaited': {
5
+ en: `The value \`await\` gives of a promise or of a plain value - TypeScript's own name for it, which \`await 5\` and \`for await\` look up.`,
6
+ ru: `Значение, которое \`await\` даёт от промиса или обычного значения, — собственное имя TypeScript, которое ищут \`await 5\` и \`for await\`.`,
7
+ },
8
+ 'Promise': {
9
+ en: `The statics that take a list of promises: \`all\`, \`allSettled\`, \`race\` and \`any\`.`,
10
+ ru: `Статические методы, которые принимают список промисов: \`all\`, \`allSettled\`, \`race\` и \`any\`.`,
11
+ },
12
+ 'Promise.all': {
13
+ en: `
14
+ Waits for every promise and gives their values in order; rejects with the
15
+ first rejection. Promises of different types give a tuple:
16
+
17
+ \`\`\`ts
18
+ const [response, count] = await Promise.all([fetch(url), countAsync()]);
19
+ \`\`\`
20
+ `,
21
+ ru: `
22
+ Ждёт все промисы и отдаёт их значения по порядку; отклоняется с первой
23
+ же ошибкой. Промисы разных типов дают кортеж:
24
+
25
+ \`\`\`ts
26
+ const [response, count] = await Promise.all([fetch(url), countAsync()]);
27
+ \`\`\`
28
+ `,
29
+ },
30
+ 'Promise.allSettled': {
31
+ en: `
32
+ Waits for every promise to settle, either way, and tells how each did:
33
+ \`status\` is \`"fulfilled"\` with \`value\`, or \`"rejected"\` with \`reason\`.
34
+ `,
35
+ ru: `
36
+ Ждёт, пока завершатся все промисы, как бы ни завершились, и сообщает,
37
+ как завершился каждый: \`status\` — \`"fulfilled"\` с \`value\` или
38
+ \`"rejected"\` с \`reason\`.
39
+ `,
40
+ },
41
+ 'Promise.race': {
42
+ en: `
43
+ Settles like the first promise to settle. Promises of different types
44
+ need a common base class; a Promise<void> among them makes the value
45
+ nullable.
46
+ `,
47
+ ru: `
48
+ Завершается так же, как первый завершившийся промис. Промисам разных
49
+ типов нужен общий базовый класс; с Promise<void> среди них значение
50
+ может быть \`null\`.
51
+ `,
52
+ },
53
+ 'Promise.any': {
54
+ en: `
55
+ Gives the first value to arrive; once all promises are rejected, rejects
56
+ with an AggregateError whose \`errors\` hold every reason.
57
+ `,
58
+ ru: `
59
+ Отдаёт первое полученное значение; если отклонены все промисы —
60
+ отклоняется с AggregateError, в \`errors\` которого все причины.
61
+ `,
62
+ },
63
+ };
@@ -0,0 +1,48 @@
1
+ // The tooltips of as/vector.ts, in both languages: scripts/apply-docs.ts writes the
2
+ // one AMXTS_DOCS_LANG picks into the JSDoc above each element.
3
+ export default {
4
+ 'Vector': {
5
+ en: `Three numbers, x y z, with the math a plugin needs on them.`,
6
+ ru: `Три числа, x y z, и вся математика над ними, которая нужна плагину.`,
7
+ },
8
+ 'Vector.x': {
9
+ en: `The x coordinate, \`vector[0]\`.`,
10
+ ru: `Координата x, \`vector[0]\`.`,
11
+ },
12
+ 'Vector.y': {
13
+ en: `The y coordinate, \`vector[1]\`.`,
14
+ ru: `Координата y, \`vector[1]\`.`,
15
+ },
16
+ 'Vector.z': {
17
+ en: `The z coordinate, \`vector[2]\`.`,
18
+ ru: `Координата z, \`vector[2]\`.`,
19
+ },
20
+ 'Vector.add': {
21
+ en: `A new vector: this one plus \`other\`, number by number.`,
22
+ ru: `Новый вектор: этот плюс \`other\`, число к числу.`,
23
+ },
24
+ 'Vector.subtract': {
25
+ en: `A new vector: this one minus \`other\`, the way from \`other\` to this point.`,
26
+ ru: `Новый вектор: этот минус \`other\` — путь от \`other\` до этой точки.`,
27
+ },
28
+ 'Vector.scale': {
29
+ en: `A new vector with every number multiplied by \`factor\`.`,
30
+ ru: `Новый вектор, где каждое число умножено на \`factor\`.`,
31
+ },
32
+ 'Vector.dot': {
33
+ en: `The dot product with \`other\`; zero when the two are at right angles.`,
34
+ ru: `Скалярное произведение с \`other\`; ноль, если векторы перпендикулярны.`,
35
+ },
36
+ 'Vector.magnitude': {
37
+ en: `The vector's length: the distance from the map's origin to this point.`,
38
+ ru: `Длина вектора: расстояние от начала координат карты до этой точки.`,
39
+ },
40
+ 'Vector.distanceTo': {
41
+ en: `The distance from this point to \`other\`, in game units.`,
42
+ ru: `Расстояние от этой точки до \`other\`, в игровых единицах.`,
43
+ },
44
+ 'Vector.normalize': {
45
+ en: `A new vector in the same direction, one unit long; a zero vector stays zero.`,
46
+ ru: `Новый вектор того же направления, длиной в единицу; нулевой вектор так и остаётся нулевым.`,
47
+ },
48
+ };