diff --git a/.eslintrc.json b/.eslintrc.json index 067f47e1f..c317f7a67 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -1,249 +1,187 @@ { - "env": { - "browser": true, - "node": true - }, - "extends": [ - "eslint:recommended", - "plugin:jest/style", - "plugin:@typescript-eslint/eslint-recommended", - "plugin:@typescript-eslint/recommended", - "plugin:import/errors", - "plugin:import/typescript" + "env": { + "browser": true, + "node": true + }, + "extends": [ + "eslint:recommended", + "plugin:@typescript-eslint/eslint-recommended", + "plugin:@typescript-eslint/recommended", + "plugin:import/errors", + "plugin:import/typescript", + "plugin:jest/style", + "plugin:jsdoc/recommended" + ], + "ignorePatterns": [ + "target/**/*", + // Typescript plugins typing check cause eslint issues, takes too much time for few files + "cli/build/plugins/**/*" + ], + "parser": "@typescript-eslint/parser", + "plugins": ["@typescript-eslint", "jest", "import", "sort-keys-fix"], + "rules": { + "@typescript-eslint/no-misused-new": "off", + "@typescript-eslint/ban-ts-comment": "off", + "@typescript-eslint/ban-ts-ignore": "off", + "@typescript-eslint/explicit-function-return-type": "off", + "@typescript-eslint/explicit-member-accessibility": ["error"], + "@typescript-eslint/explicit-module-boundary-types": "off", + "@typescript-eslint/no-empty-function": "off", + "@typescript-eslint/no-empty-interface": "off", + "@typescript-eslint/no-explicit-any": "off", + "@typescript-eslint/no-inferrable-types": "off", + "@typescript-eslint/no-non-null-assertion": "off", + "@typescript-eslint/no-unused-vars": "off", + "jsdoc/require-param-type": "off", + "jsdoc/require-returns-type": "off", + "jsdoc/tag-lines": ["error", "any", { "startLines": 1, "endLines": 0 }], + "jsdoc/check-tag-names": "off", + "jsdoc/require-param": "off", + "jsdoc/require-returns": "off", + "jsdoc/require-param-description": "off", + "jsdoc/require-jsdoc": "off", + "array-element-newline": ["error", "consistent"], + "arrow-parens": ["error", "always"], + "arrow-spacing": "error", + "brace-style": "error", + "camelcase": "off", + "sort-vars": "error", + "sort-imports": [ + "error", + { + "ignoreCase": true, + "ignoreDeclarationSort": true, + "ignoreMemberSort": false, + "allowSeparatedGroups": false + } ], - "ignorePatterns": [ - "target/**/*", - // Typescript plugins typing check cause eslint issues, takes too much time for few files - "cli/build/plugins/**/*" + "comma-dangle": [ + "error", + { + "arrays": "always-multiline", + "objects": "always-multiline", + "imports": "always-multiline", + "exports": "never", + "functions": "never" + } ], - "parser": "@typescript-eslint/parser", - "plugins": [ - "@typescript-eslint", - "jest", - "import", - "sort-keys-fix" + "eqeqeq": "error", + "eol-last": ["error", "always"], + "func-call-spacing": ["error", "never"], + "function-paren-newline": ["error", "multiline-arguments"], + "import/default": "off", + "import/no-relative-parent-imports": "error", + "import/no-unresolved": "off", + "import/order": [ + "error", + { + "alphabetize": { + "caseInsensitive": true, + "order": "asc" + }, + "groups": ["builtin", "external", "parent", "sibling", "index"], + "newlines-between": "always", + "pathGroups": [ + { + "group": "external", + "pattern": "#/**", + "position": "after" + }, + { + "group": "external", + "pattern": "@/**", + "position": "after" + } + ], + "pathGroupsExcludedImportTypes": ["builtin"] + } ], - "rules": { - "@typescript-eslint/no-misused-new": "off", - "@typescript-eslint/ban-ts-comment": "off", - "@typescript-eslint/ban-ts-ignore": "off", - "@typescript-eslint/explicit-function-return-type": "off", - "@typescript-eslint/explicit-member-accessibility": [ - "error" - ], - "@typescript-eslint/explicit-module-boundary-types": "off", - "@typescript-eslint/no-empty-function": "off", - "@typescript-eslint/no-empty-interface": "off", - "@typescript-eslint/no-explicit-any": "off", - "@typescript-eslint/no-inferrable-types": "off", - "@typescript-eslint/no-non-null-assertion": "off", - "@typescript-eslint/no-unused-vars": "off", - "array-element-newline": [ - "error", - "consistent" - ], - "arrow-parens": [ - "error", - "always" - ], - "arrow-spacing": "error", - "brace-style": "error", - "camelcase": "off", - "sort-vars": "error", - "sort-imports": ["error", { - "ignoreCase": true, - "ignoreDeclarationSort": true, - "ignoreMemberSort": false, - "allowSeparatedGroups": false - }], - "comma-dangle": [ - "error", - { - "arrays": "always-multiline", - "objects": "always-multiline", - "imports": "always-multiline", - "exports": "never", - "functions": "never" - } - ], - "eqeqeq": "error", - "eol-last": [ - "error", - "always" - ], - "func-call-spacing": [ - "error", - "never" - ], - "function-paren-newline": [ - "error", - "multiline-arguments" - ], - "import/default": "off", - "import/no-relative-parent-imports": "error", - "import/no-unresolved": "off", - "import/order": [ - "error", - { - "alphabetize": { - "caseInsensitive": true, - "order": "asc" - }, - "groups": [ - "builtin", - "external", - "parent", - "sibling", - "index" - ], - "newlines-between": "always", - "pathGroups": [ - { - "group": "external", - "pattern": "#/**", - "position": "after" - }, - { - "group": "external", - "pattern": "@/**", - "position": "after" - } - ], - "pathGroupsExcludedImportTypes": [ - "builtin" - ] - } - ], - "indent": [ - "error", - 2, - { - "SwitchCase": 1 - } - ], - "key-spacing": [ - "error", - { - "afterColon": true, - "beforeColon": false - } - ], - "keyword-spacing": "error", - "max-len": [ - "error", - { - "code": 120, - "ignorePattern": "^import\\W.*" - } - ], - "no-constructor-return": "error", - "no-duplicate-imports": "error", - "no-multi-spaces": "error", - "no-multiple-empty-lines": [ - "error", - { - "max": 1, - "maxBOF": 1 - } - ], - "no-trailing-spaces": "error", - "object-curly-newline": [ - "error", - { - "consistent": true, - "multiline": true - } - ], - "object-curly-spacing": [ - "error", - "always" - ], - "object-property-newline": [ - "error", - { - "allowAllPropertiesOnSameLine": true - } - ], - "padding-line-between-statements": [ - "error", - { - "blankLine": "always", - "next": "return", - "prev": "*" - }, - { - "blankLine": "always", - "next": [ - "const", - "let", - "var" - ], - "prev": "expression" - }, - { - "blankLine": "always", - "next": "*", - "prev": [ - "const", - "let", - "var" - ] - }, - { - "blankLine": "always", - "next": "*", - "prev": [ - "for", - "if", - "while", - "do", - "with" - ] - }, - { - "blankLine": "always", - "next": [ - "function", - "class" - ], - "prev": [ - "function", - "class" - ] - }, - { - "blankLine": "any", - "next": [ - "const", - "let", - "var" - ], - "prev": [ - "const", - "let", - "var" - ] - } - ], - "quotes": [ - "error", - "double" - ], - "semi": "error", - "space-in-parens": [ - "error", - "never" - ], - "spaced-comment": [ - "error", - "always" - ], - "template-tag-spacing": [ - "error", - "never" - ], - "yoda": "error" - }, - "settings": { - } + "indent": [ + "error", + 2, + { + "SwitchCase": 1 + } + ], + "key-spacing": [ + "error", + { + "afterColon": true, + "beforeColon": false + } + ], + "keyword-spacing": "error", + "max-len": [ + "error", + { + "code": 120, + "ignorePattern": "^import\\W.*" + } + ], + "no-constructor-return": "error", + "no-duplicate-imports": "error", + "no-multi-spaces": "error", + "no-multiple-empty-lines": [ + "error", + { + "max": 1, + "maxBOF": 1 + } + ], + "no-trailing-spaces": "error", + "object-curly-newline": [ + "error", + { + "consistent": true, + "multiline": true + } + ], + "object-curly-spacing": ["error", "always"], + "object-property-newline": [ + "error", + { + "allowAllPropertiesOnSameLine": true + } + ], + "padding-line-between-statements": [ + "error", + { + "blankLine": "always", + "next": "return", + "prev": "*" + }, + { + "blankLine": "always", + "next": ["const", "let", "var"], + "prev": "expression" + }, + { + "blankLine": "always", + "next": "*", + "prev": ["const", "let", "var"] + }, + { + "blankLine": "always", + "next": "*", + "prev": ["for", "if", "while", "do", "with"] + }, + { + "blankLine": "always", + "next": ["function", "class"], + "prev": ["function", "class"] + }, + { + "blankLine": "any", + "next": ["const", "let", "var"], + "prev": ["const", "let", "var"] + } + ], + "quotes": ["error", "double"], + "semi": "error", + "space-in-parens": ["error", "never"], + "spaced-comment": ["error", "always"], + "template-tag-spacing": ["error", "never"], + "yoda": "error" + }, + "settings": {} } diff --git a/cli/build/steps/configs_dynamic.ts b/cli/build/steps/configs_dynamic.ts index 7c63f30b1..b4bd617ac 100644 --- a/cli/build/steps/configs_dynamic.ts +++ b/cli/build/steps/configs_dynamic.ts @@ -67,6 +67,9 @@ export async function buildDynamicConfigs(parameters: IBuildCommandParameters): * Get list of LTX transformable descriptors. */ async function getLtxConfigs(filters: Array = []): Promise> { + /** + * todo; + */ function collectLtxConfigs( acc: Array, it: TFolderFiles diff --git a/cli/build/steps/configs_statics.ts b/cli/build/steps/configs_statics.ts index cab6109e7..0114d69bf 100644 --- a/cli/build/steps/configs_statics.ts +++ b/cli/build/steps/configs_statics.ts @@ -53,6 +53,9 @@ export async function buildStaticConfigs(parameters: IBuildCommandParameters): P * Get list of static configs. */ async function getStaticConfigs(filters: Array = []): Promise> { + /** + * todo; + */ function collectConfigs( acc: Array, it: TFolderFiles diff --git a/cli/build/steps/meta.ts b/cli/build/steps/meta.ts index 879a328da..646a83bd3 100644 --- a/cli/build/steps/meta.ts +++ b/cli/build/steps/meta.ts @@ -17,9 +17,6 @@ interface IBuildMetaParams { /** * Step to collect metadata in a single file with timing metrics. - * - * @param meta - build meta information to save - * @param timeTracker - build time tracker with performance metrics */ export async function buildMeta({ meta, timeTracker }: IBuildMetaParams): Promise { log.info(blueBright("Build metadata")); diff --git a/cli/build/steps/translations_dynamic.ts b/cli/build/steps/translations_dynamic.ts index e090ed939..a59713dfe 100644 --- a/cli/build/steps/translations_dynamic.ts +++ b/cli/build/steps/translations_dynamic.ts @@ -35,6 +35,9 @@ export async function buildDynamicTranslations(): Promise { return log.warn("No languages to translate found in config.json file, skip"); } + /** + * todo; + */ function collectTranslations( acc: Array, it: TFolderFiles diff --git a/cli/build/steps/ui_dynamic.ts b/cli/build/steps/ui_dynamic.ts index c0647d76a..ea461d0ad 100644 --- a/cli/build/steps/ui_dynamic.ts +++ b/cli/build/steps/ui_dynamic.ts @@ -63,6 +63,9 @@ export async function buildDynamicUi(parameters: IBuildCommandParameters): Promi * Get list of UI config files in engine source files. */ async function getUiConfigs(filters: Array = []): Promise> { + /** + * todo; + */ function collectXmlConfigs( acc: Array, it: TFolderFiles diff --git a/cli/build/steps/ui_statics.ts b/cli/build/steps/ui_statics.ts index 5d18a06a1..0060b3695 100644 --- a/cli/build/steps/ui_statics.ts +++ b/cli/build/steps/ui_statics.ts @@ -51,6 +51,9 @@ export async function buildStaticUi(parameters: IBuildCommandParameters): Promis * Get UI configuration files list. */ async function getUiConfigs(filters: Array = []): Promise> { + /** + * todo; + */ function collectXmlConfigs( acc: Array, it: Array | string diff --git a/cli/format/format_ltx.ts b/cli/format/format_ltx.ts index 35ca7b22f..33436ccee 100644 --- a/cli/format/format_ltx.ts +++ b/cli/format/format_ltx.ts @@ -49,6 +49,9 @@ async function formatLtxFile(file: string): Promise { * Get list of static configs. */ async function getLtxConfigs(filters: Array = []): Promise> { + /** + * todo; + */ function collectConfigs(acc: Array, it: TFolderFiles): Array { if (Array.isArray(it)) { it.forEach((nested) => collectConfigs(acc, nested)); diff --git a/cli/parse/parse_externals.ts b/cli/parse/parse_externals.ts index 799ec5d93..a3a1c4985 100644 --- a/cli/parse/parse_externals.ts +++ b/cli/parse/parse_externals.ts @@ -47,6 +47,9 @@ export async function parseExternals(): Promise { * Get list of LTX transformable descriptors. */ async function getSourcesList(source: string): Promise> { + /** + * todo; + */ function collectList(acc: Array, it: TFolderFiles): Array { if (Array.isArray(it)) { it.forEach((nested) => collectList(acc, nested)); diff --git a/cli/parse/utils/__test__/declaration.ts b/cli/parse/utils/__test__/declaration.ts index 423659eca..e024a92cb 100644 --- a/cli/parse/utils/__test__/declaration.ts +++ b/cli/parse/utils/__test__/declaration.ts @@ -10,8 +10,14 @@ interface IAbstractInterface { b: string; } +/** + * todo; + */ function extern(name: string, cb: (...args: Array) => void): void {} +/** + * todo; + */ function another(name: string, cb: (...args: Array) => void): void {} extern("module.callback_name_one", (a: number, b: string, c: boolean, d: SomeAlias): boolean => true); diff --git a/cli/preview/preview.ts b/cli/preview/preview.ts index 3072633e3..8267a8a55 100644 --- a/cli/preview/preview.ts +++ b/cli/preview/preview.ts @@ -98,7 +98,13 @@ function createFoldersForConfigs(xmlConfigs: Array }); } +/** + * todo; + */ async function getUiConfigs(filters: Array = []): Promise> { + /** + * todo; + */ function collectXmlConfigs( acc: Array, it: TFolderFiles diff --git a/cli/preview/utils/generate_preview.ts b/cli/preview/utils/generate_preview.ts index fa032a3cf..f103e2136 100644 --- a/cli/preview/utils/generate_preview.ts +++ b/cli/preview/utils/generate_preview.ts @@ -2,6 +2,9 @@ import { default as jsdom } from "jsdom"; const { style, STATIC_ASSET, GRADIENT_BG_, GENERIC } = generateDomClasses(); +/** + * + */ export function generateHTMLPreviewFromXMLString(content: string): string { const dom = new jsdom.JSDOM(content); @@ -58,10 +61,16 @@ export function generateHTMLPreviewFromXMLString(content: string): string { return dom.serialize(); } +/** + * + */ function prepareOther(node: HTMLElement): void { node.style.border = "solid black 1px"; } +/** + * + */ function prepareText(node: HTMLElement): void { node.style.overflow = "hidden"; node.style.width = "100%"; @@ -74,6 +83,9 @@ function prepareText(node: HTMLElement): void { } } +/** + * + */ function prepareTexture(node: HTMLElement): void { node.setAttribute("texture_resource", node.textContent); @@ -84,15 +96,24 @@ function prepareTexture(node: HTMLElement): void { node.style.height = "100%"; } +/** + * + */ function prepareWindow(node: HTMLElement): void { node.style.position = "absolute"; node.style.background = "rgba(50, 50, 50, 0.05)"; } +/** + * + */ function prepareStaticAsset(node: HTMLElement): void { node.className = STATIC_ASSET + " " + GRADIENT_BG_ + Math.floor(Math.random() * 10); } +/** + * + */ function generateDomClasses() { const GENERIC: string = "generic"; const STATIC_ASSET: string = "static-asset"; @@ -144,6 +165,9 @@ function generateDomClasses() { }; } +/** + * todo; + */ function getRandomColor(): string { return "#" + (((1 << 24) * Math.random()) | 0).toString(16).padStart(6, "0"); } diff --git a/cli/utils/fs/get_diffs.ts b/cli/utils/fs/get_diffs.ts index 62aa4bab1..9500a11d4 100644 --- a/cli/utils/fs/get_diffs.ts +++ b/cli/utils/fs/get_diffs.ts @@ -31,10 +31,16 @@ export interface IDiffs { deletions: IDiff; } +/** + * todo; + */ function getTime(dateOrDateStr: Date | string): number { return typeof dateOrDateStr === "string" ? Date.parse(dateOrDateStr) : dateOrDateStr.getTime(); } +/** + * todo; + */ async function ensureDirAccess(directory: string): Promise { try { await fsp.access(directory); @@ -43,6 +49,11 @@ async function ensureDirAccess(directory: string): Promise { } } +/** + * todo; + * + * @yields - files from directory in a recursive way + */ async function* getFiles(directory: string): AsyncGenerator { const dirents = await fsp.readdir(directory, { withFileTypes: true }); @@ -54,6 +65,9 @@ async function* getFiles(directory: string): AsyncGenerator { } } +/** + * todo; + */ async function getFileStats(directory: string, options): Promise { const dir = path.resolve(directory); @@ -85,6 +99,9 @@ async function getFileStats(directory: string, options): Promise { return fileStats; } +/** + * todo; + */ export async function getDiffs(base: FilePathMap, target: FilePathMap, options?: DiffOptions): Promise { const { exclusions = [], compareSizes = true } = options || {}; const statsOptions = { exclusions }; diff --git a/cli/utils/fs/open_folder_in_explorer.ts b/cli/utils/fs/open_folder_in_explorer.ts index 8eb4ab1e9..740e0f8aa 100644 --- a/cli/utils/fs/open_folder_in_explorer.ts +++ b/cli/utils/fs/open_folder_in_explorer.ts @@ -1,6 +1,9 @@ import * as cp from "child_process"; import * as os from "os"; +/** + * todo; + */ export function openFolderInExplorer(path: string): Promise { return new Promise((resolve, reject) => { const osType: string = os.type(); diff --git a/cli/utils/fs/read_dir_content_flat_gen.ts b/cli/utils/fs/read_dir_content_flat_gen.ts index d59012cca..e6ff145cd 100644 --- a/cli/utils/fs/read_dir_content_flat_gen.ts +++ b/cli/utils/fs/read_dir_content_flat_gen.ts @@ -1,6 +1,12 @@ -import fsp from "fs/promises"; -import path from "path"; +import * as fsp from "fs/promises"; +import * as path from "path"; +/** + * Read folder content with generator. + * + * @param directory - target folder to traverse + * @yields next item in directory + */ export async function* readFolderGen(directory: string) { const dirents = await fsp.readdir(directory, { withFileTypes: true }); diff --git a/cli/utils/fs/read_last_lines_of_file.ts b/cli/utils/fs/read_last_lines_of_file.ts index 8fa6f2c9c..e2a7d7f52 100644 --- a/cli/utils/fs/read_last_lines_of_file.ts +++ b/cli/utils/fs/read_last_lines_of_file.ts @@ -6,6 +6,9 @@ import { Optional } from "#/utils/types"; const NEW_LINE_CHARACTERS: Array = ["\n"]; +/** + * todo; + */ export async function readLastLinesOfFile( filePath: string, maxLineCount: number, diff --git a/package-lock.json b/package-lock.json index e4ab870d1..bd1213d86 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,10 +22,11 @@ "@typescript-to-lua/language-extensions": "1.0.0", "chalk": "4.1.2", "commander": "^10.0.1", - "eslint": "^8.43.0", - "eslint-config-standard-with-typescript": "^35.0.0", + "eslint": "^8.44.0", + "eslint-config-standard-with-typescript": "^36.0.0", "eslint-plugin-import": "^2.27.5", - "eslint-plugin-jest": "^27.2.1", + "eslint-plugin-jest": "^27.2.2", + "eslint-plugin-jsdoc": "^46.4.3", "eslint-plugin-sort-keys-fix": "^1.1.2", "fast-xml-parser": "^4.2.4", "fengari": "0.1.4", @@ -43,6 +44,15 @@ "typescript-to-lua": "^1.16.2" } }, + "node_modules/@aashutoshrathi/word-wrap": { + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/@aashutoshrathi/word-wrap/-/word-wrap-1.2.6.tgz", + "integrity": "sha512-1Yjs2SvM8TflER/OD3cOjhWWOZb58A2t7wpE2S9XfBYTiIl+XFhQG2bjy4Pu1I+EAlCNUzRDYDdFwFYUKvXcIA==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/@ampproject/remapping": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.0.tgz", @@ -693,6 +703,20 @@ "node": ">=12" } }, + "node_modules/@es-joy/jsdoccomment": { + "version": "0.39.4", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.39.4.tgz", + "integrity": "sha512-Jvw915fjqQct445+yron7Dufix9A+m9j1fCJYlCo1FWlRvTxa3pjJelxdSTdaLWcTwRU6vbL+NYjO4YuNIS5Qg==", + "dev": true, + "dependencies": { + "comment-parser": "1.3.1", + "esquery": "^1.5.0", + "jsdoc-type-pratt-parser": "~4.0.0" + }, + "engines": { + "node": ">=16" + } + }, "node_modules/@eslint-community/eslint-utils": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.3.0.tgz", @@ -718,14 +742,14 @@ } }, "node_modules/@eslint/eslintrc": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.0.3.tgz", - "integrity": "sha512-+5gy6OQfk+xx3q0d6jGZZC3f3KzAkXc/IanVxd1is/VIIziRqqt3ongQz0FiTUXqTk0c7aDB3OaFuKnuSoJicQ==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.0.tgz", + "integrity": "sha512-Lj7DECXqIVCqnqjjHMPna4vn6GJcMgul/wuS0je9OZ9gsL0zzDpKPVtcG1HaDVc+9y+qgXneTeUMbCqXJNpH1A==", "dev": true, "dependencies": { "ajv": "^6.12.4", "debug": "^4.3.2", - "espree": "^9.5.2", + "espree": "^9.6.0", "globals": "^13.19.0", "ignore": "^5.2.0", "import-fresh": "^3.2.1", @@ -741,9 +765,9 @@ } }, "node_modules/@eslint/js": { - "version": "8.43.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.43.0.tgz", - "integrity": "sha512-s2UHCoiXfxMvmfzqoN+vrQ84ahUSYde9qNO1MdxmoEhyHWsfmwOpFlwYV+ePJEVc7gFnATGUi376WowX1N7tFg==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.44.0.tgz", + "integrity": "sha512-Ag+9YM4ocKQx9AarydN0KY2j0ErMHNIocPDrVo8zAE44xLTjEtz81OdR68/cydGtk6m6jDb5Za3r2useMzYmSw==", "dev": true, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" @@ -1711,9 +1735,9 @@ "dev": true }, "node_modules/acorn": { - "version": "8.8.2", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.2.tgz", - "integrity": "sha512-xjIYgE8HBrkpd/sJqOGNspf8uHG+NOHGOw6a/Urj8taM2EXfdNAH2oFcPeIFfsv3+kz/mJrS5VuMqbNLjCa2vw==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.10.0.tgz", + "integrity": "sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw==", "dev": true, "bin": { "acorn": "bin/acorn" @@ -1838,6 +1862,15 @@ "node": ">= 8" } }, + "node_modules/are-docs-informative": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/are-docs-informative/-/are-docs-informative-0.0.2.tgz", + "integrity": "sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig==", + "dev": true, + "engines": { + "node": ">=14" + } + }, "node_modules/arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", @@ -2094,6 +2127,18 @@ "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", "dev": true }, + "node_modules/builtin-modules": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz", + "integrity": "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==", + "dev": true, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/builtins": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz", @@ -2266,6 +2311,15 @@ "node": ">=14" } }, + "node_modules/comment-parser": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.3.1.tgz", + "integrity": "sha512-B52sN2VNghyq5ofvUsqZjmk6YkihBX5vMSChmSK9v4ShjKf3Vk5Xcmgpw4o+iIgtrnM/u5FiMpz9VKb8lpBveA==", + "dev": true, + "engines": { + "node": ">= 12.0.0" + } + }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", @@ -2607,15 +2661,15 @@ } }, "node_modules/eslint": { - "version": "8.43.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.43.0.tgz", - "integrity": "sha512-aaCpf2JqqKesMFGgmRPessmVKjcGXqdlAYLLC3THM8t5nBRZRQ+st5WM/hoJXkdioEXLLbXgclUpM0TXo5HX5Q==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.44.0.tgz", + "integrity": "sha512-0wpHoUbDUHgNCyvFB5aXLiQVfK9B0at6gUvzy83k4kAsQ/u769TQDX6iKC+aO4upIHO9WSaA3QoXYQDHbNwf1A==", "dev": true, "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.4.0", - "@eslint/eslintrc": "^2.0.3", - "@eslint/js": "8.43.0", + "@eslint/eslintrc": "^2.1.0", + "@eslint/js": "8.44.0", "@humanwhocodes/config-array": "^0.11.10", "@humanwhocodes/module-importer": "^1.0.1", "@nodelib/fs.walk": "^1.2.8", @@ -2627,7 +2681,7 @@ "escape-string-regexp": "^4.0.0", "eslint-scope": "^7.2.0", "eslint-visitor-keys": "^3.4.1", - "espree": "^9.5.2", + "espree": "^9.6.0", "esquery": "^1.4.2", "esutils": "^2.0.2", "fast-deep-equal": "^3.1.3", @@ -2647,7 +2701,7 @@ "lodash.merge": "^4.6.2", "minimatch": "^3.1.2", "natural-compare": "^1.4.0", - "optionator": "^0.9.1", + "optionator": "^0.9.3", "strip-ansi": "^6.0.1", "strip-json-comments": "^3.1.0", "text-table": "^0.2.0" @@ -2689,9 +2743,9 @@ } }, "node_modules/eslint-config-standard-with-typescript": { - "version": "35.0.0", - "resolved": "https://registry.npmjs.org/eslint-config-standard-with-typescript/-/eslint-config-standard-with-typescript-35.0.0.tgz", - "integrity": "sha512-Xa7DY9GgduZyp0qmXxBF0/dB+Vm4/DgWu1lGpNLJV2d46aCaUxTKDEnkzjUWX/1O9S0a+Dhnw7A4oI0JpYzwtw==", + "version": "36.0.0", + "resolved": "https://registry.npmjs.org/eslint-config-standard-with-typescript/-/eslint-config-standard-with-typescript-36.0.0.tgz", + "integrity": "sha512-8ZSEskfrDAkUF2lTQLMT0CBzgRNlx1uIM7l2I7L683dKAXUdHuEL2x+GxuGAsdsoWbx7W7Zv0xF67VCEZXIk0Q==", "dev": true, "dependencies": { "@typescript-eslint/parser": "^5.50.0", @@ -2882,9 +2936,9 @@ } }, "node_modules/eslint-plugin-jest": { - "version": "27.2.1", - "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-27.2.1.tgz", - "integrity": "sha512-l067Uxx7ZT8cO9NJuf+eJHvt6bqJyz2Z29wykyEdz/OtmcELQl2MQGQLX8J94O1cSJWAwUSEvCjwjA7KEK3Hmg==", + "version": "27.2.2", + "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-27.2.2.tgz", + "integrity": "sha512-euzbp06F934Z7UDl5ZUaRPLAc9MKjh0rMPERrHT7UhlCEwgb25kBj37TvMgWeHZVkR5I9CayswrpoaqZU1RImw==", "dev": true, "dependencies": { "@typescript-eslint/utils": "^5.10.0" @@ -2894,7 +2948,8 @@ }, "peerDependencies": { "@typescript-eslint/eslint-plugin": "^5.0.0", - "eslint": "^7.0.0 || ^8.0.0" + "eslint": "^7.0.0 || ^8.0.0", + "jest": "*" }, "peerDependenciesMeta": { "@typescript-eslint/eslint-plugin": { @@ -2905,6 +2960,29 @@ } } }, + "node_modules/eslint-plugin-jsdoc": { + "version": "46.4.3", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-46.4.3.tgz", + "integrity": "sha512-Prc7ol+vCIghPeECpwZq5+P+VZfoi87suywvbYCiCnkI1kTmVSdcOC2M8mioglWxBbd28wbb1OVjg/8OzGzatA==", + "dev": true, + "dependencies": { + "@es-joy/jsdoccomment": "~0.39.4", + "are-docs-informative": "^0.0.2", + "comment-parser": "1.3.1", + "debug": "^4.3.4", + "escape-string-regexp": "^4.0.0", + "esquery": "^1.5.0", + "is-builtin-module": "^3.2.1", + "semver": "^7.5.1", + "spdx-expression-parse": "^3.0.1" + }, + "engines": { + "node": ">=16" + }, + "peerDependencies": { + "eslint": "^7.0.0 || ^8.0.0" + } + }, "node_modules/eslint-plugin-n": { "version": "15.6.0", "resolved": "https://registry.npmjs.org/eslint-plugin-n/-/eslint-plugin-n-15.6.0.tgz", @@ -3052,12 +3130,12 @@ } }, "node_modules/espree": { - "version": "9.5.2", - "resolved": "https://registry.npmjs.org/espree/-/espree-9.5.2.tgz", - "integrity": "sha512-7OASN1Wma5fum5SrNhFMAMJxOUAbhyfQ8dQ//PJaJbNw0URTPWqIghHWt1MmAANKhHZIYOHruW4Kw4ruUWOdGw==", + "version": "9.6.0", + "resolved": "https://registry.npmjs.org/espree/-/espree-9.6.0.tgz", + "integrity": "sha512-1FH/IiruXZ84tpUlm0aCUEwMl2Ho5ilqVh0VvQXw+byAz/4SAciyHLlfmL5WYqsvD38oymdUwBss0LtK8m4s/A==", "dev": true, "dependencies": { - "acorn": "^8.8.0", + "acorn": "^8.9.0", "acorn-jsx": "^5.3.2", "eslint-visitor-keys": "^3.4.1" }, @@ -3824,6 +3902,21 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-builtin-module": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.1.tgz", + "integrity": "sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A==", + "dev": true, + "dependencies": { + "builtin-modules": "^3.3.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-callable": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", @@ -4716,6 +4809,15 @@ "js-yaml": "bin/js-yaml.js" } }, + "node_modules/jsdoc-type-pratt-parser": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz", + "integrity": "sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ==", + "dev": true, + "engines": { + "node": ">=12.0.0" + } + }, "node_modules/jsdom": { "version": "22.1.0", "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-22.1.0.tgz", @@ -5175,17 +5277,17 @@ } }, "node_modules/optionator": { - "version": "0.9.1", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", - "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", + "version": "0.9.3", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.3.tgz", + "integrity": "sha512-JjCoypp+jKn1ttEFExxhetCKeJt9zhAgAve5FXHixTvFDW/5aEktX9bufBKLRRMdU7bNtpLfcGu94B3cdEJgjg==", "dev": true, "dependencies": { + "@aashutoshrathi/word-wrap": "^1.2.3", "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", "levn": "^0.4.1", "prelude-ls": "^1.2.1", - "type-check": "^0.4.0", - "word-wrap": "^1.2.3" + "type-check": "^0.4.0" }, "engines": { "node": ">= 0.8.0" @@ -5770,9 +5872,9 @@ } }, "node_modules/semver": { - "version": "7.3.8", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", - "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", "dev": true, "dependencies": { "lru-cache": "^6.0.0" @@ -5880,6 +5982,28 @@ "node": ">=0.10.0" } }, + "node_modules/spdx-exceptions": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", + "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==", + "dev": true + }, + "node_modules/spdx-expression-parse": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", + "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", + "dev": true, + "dependencies": { + "spdx-exceptions": "^2.1.0", + "spdx-license-ids": "^3.0.0" + } + }, + "node_modules/spdx-license-ids": { + "version": "3.0.13", + "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.13.tgz", + "integrity": "sha512-XkD+zwiqXHikFZm4AX/7JSCXA98U5Db4AFd5XUg/+9UNtnH75+Z9KxtpYiJZx36mUDVOwH83pl7yvCer6ewM3w==", + "dev": true + }, "node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", @@ -6567,15 +6691,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/word-wrap": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", - "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/wrap-ansi": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", @@ -6828,6 +6943,12 @@ } }, "dependencies": { + "@aashutoshrathi/word-wrap": { + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/@aashutoshrathi/word-wrap/-/word-wrap-1.2.6.tgz", + "integrity": "sha512-1Yjs2SvM8TflER/OD3cOjhWWOZb58A2t7wpE2S9XfBYTiIl+XFhQG2bjy4Pu1I+EAlCNUzRDYDdFwFYUKvXcIA==", + "dev": true + }, "@ampproject/remapping": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.0.tgz", @@ -7328,6 +7449,17 @@ "@jridgewell/trace-mapping": "0.3.9" } }, + "@es-joy/jsdoccomment": { + "version": "0.39.4", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.39.4.tgz", + "integrity": "sha512-Jvw915fjqQct445+yron7Dufix9A+m9j1fCJYlCo1FWlRvTxa3pjJelxdSTdaLWcTwRU6vbL+NYjO4YuNIS5Qg==", + "dev": true, + "requires": { + "comment-parser": "1.3.1", + "esquery": "^1.5.0", + "jsdoc-type-pratt-parser": "~4.0.0" + } + }, "@eslint-community/eslint-utils": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.3.0.tgz", @@ -7344,14 +7476,14 @@ "dev": true }, "@eslint/eslintrc": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.0.3.tgz", - "integrity": "sha512-+5gy6OQfk+xx3q0d6jGZZC3f3KzAkXc/IanVxd1is/VIIziRqqt3ongQz0FiTUXqTk0c7aDB3OaFuKnuSoJicQ==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.0.tgz", + "integrity": "sha512-Lj7DECXqIVCqnqjjHMPna4vn6GJcMgul/wuS0je9OZ9gsL0zzDpKPVtcG1HaDVc+9y+qgXneTeUMbCqXJNpH1A==", "dev": true, "requires": { "ajv": "^6.12.4", "debug": "^4.3.2", - "espree": "^9.5.2", + "espree": "^9.6.0", "globals": "^13.19.0", "ignore": "^5.2.0", "import-fresh": "^3.2.1", @@ -7361,9 +7493,9 @@ } }, "@eslint/js": { - "version": "8.43.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.43.0.tgz", - "integrity": "sha512-s2UHCoiXfxMvmfzqoN+vrQ84ahUSYde9qNO1MdxmoEhyHWsfmwOpFlwYV+ePJEVc7gFnATGUi376WowX1N7tFg==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.44.0.tgz", + "integrity": "sha512-Ag+9YM4ocKQx9AarydN0KY2j0ErMHNIocPDrVo8zAE44xLTjEtz81OdR68/cydGtk6m6jDb5Za3r2useMzYmSw==", "dev": true }, "@humanwhocodes/config-array": { @@ -8124,9 +8256,9 @@ "dev": true }, "acorn": { - "version": "8.8.2", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.2.tgz", - "integrity": "sha512-xjIYgE8HBrkpd/sJqOGNspf8uHG+NOHGOw6a/Urj8taM2EXfdNAH2oFcPeIFfsv3+kz/mJrS5VuMqbNLjCa2vw==", + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.10.0.tgz", + "integrity": "sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw==", "dev": true }, "acorn-jsx": { @@ -8211,6 +8343,12 @@ "picomatch": "^2.0.4" } }, + "are-docs-informative": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/are-docs-informative/-/are-docs-informative-0.0.2.tgz", + "integrity": "sha512-ixiS0nLNNG5jNQzgZJNoUpBKdo9yTYZMGJ+QgT2jmjR7G7+QHRCc4v6LQ3NgE7EBJq+o0ams3waJwkrlBom8Ig==", + "dev": true + }, "arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", @@ -8403,6 +8541,12 @@ "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", "dev": true }, + "builtin-modules": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz", + "integrity": "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==", + "dev": true + }, "builtins": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz", @@ -8522,6 +8666,12 @@ "integrity": "sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==", "dev": true }, + "comment-parser": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.3.1.tgz", + "integrity": "sha512-B52sN2VNghyq5ofvUsqZjmk6YkihBX5vMSChmSK9v4ShjKf3Vk5Xcmgpw4o+iIgtrnM/u5FiMpz9VKb8lpBveA==", + "dev": true + }, "concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", @@ -8780,15 +8930,15 @@ "dev": true }, "eslint": { - "version": "8.43.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.43.0.tgz", - "integrity": "sha512-aaCpf2JqqKesMFGgmRPessmVKjcGXqdlAYLLC3THM8t5nBRZRQ+st5WM/hoJXkdioEXLLbXgclUpM0TXo5HX5Q==", + "version": "8.44.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.44.0.tgz", + "integrity": "sha512-0wpHoUbDUHgNCyvFB5aXLiQVfK9B0at6gUvzy83k4kAsQ/u769TQDX6iKC+aO4upIHO9WSaA3QoXYQDHbNwf1A==", "dev": true, "requires": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.4.0", - "@eslint/eslintrc": "^2.0.3", - "@eslint/js": "8.43.0", + "@eslint/eslintrc": "^2.1.0", + "@eslint/js": "8.44.0", "@humanwhocodes/config-array": "^0.11.10", "@humanwhocodes/module-importer": "^1.0.1", "@nodelib/fs.walk": "^1.2.8", @@ -8800,7 +8950,7 @@ "escape-string-regexp": "^4.0.0", "eslint-scope": "^7.2.0", "eslint-visitor-keys": "^3.4.1", - "espree": "^9.5.2", + "espree": "^9.6.0", "esquery": "^1.4.2", "esutils": "^2.0.2", "fast-deep-equal": "^3.1.3", @@ -8820,7 +8970,7 @@ "lodash.merge": "^4.6.2", "minimatch": "^3.1.2", "natural-compare": "^1.4.0", - "optionator": "^0.9.1", + "optionator": "^0.9.3", "strip-ansi": "^6.0.1", "strip-json-comments": "^3.1.0", "text-table": "^0.2.0" @@ -8834,9 +8984,9 @@ "requires": {} }, "eslint-config-standard-with-typescript": { - "version": "35.0.0", - "resolved": "https://registry.npmjs.org/eslint-config-standard-with-typescript/-/eslint-config-standard-with-typescript-35.0.0.tgz", - "integrity": "sha512-Xa7DY9GgduZyp0qmXxBF0/dB+Vm4/DgWu1lGpNLJV2d46aCaUxTKDEnkzjUWX/1O9S0a+Dhnw7A4oI0JpYzwtw==", + "version": "36.0.0", + "resolved": "https://registry.npmjs.org/eslint-config-standard-with-typescript/-/eslint-config-standard-with-typescript-36.0.0.tgz", + "integrity": "sha512-8ZSEskfrDAkUF2lTQLMT0CBzgRNlx1uIM7l2I7L683dKAXUdHuEL2x+GxuGAsdsoWbx7W7Zv0xF67VCEZXIk0Q==", "dev": true, "requires": { "@typescript-eslint/parser": "^5.50.0", @@ -8986,14 +9136,31 @@ } }, "eslint-plugin-jest": { - "version": "27.2.1", - "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-27.2.1.tgz", - "integrity": "sha512-l067Uxx7ZT8cO9NJuf+eJHvt6bqJyz2Z29wykyEdz/OtmcELQl2MQGQLX8J94O1cSJWAwUSEvCjwjA7KEK3Hmg==", + "version": "27.2.2", + "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-27.2.2.tgz", + "integrity": "sha512-euzbp06F934Z7UDl5ZUaRPLAc9MKjh0rMPERrHT7UhlCEwgb25kBj37TvMgWeHZVkR5I9CayswrpoaqZU1RImw==", "dev": true, "requires": { "@typescript-eslint/utils": "^5.10.0" } }, + "eslint-plugin-jsdoc": { + "version": "46.4.3", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-46.4.3.tgz", + "integrity": "sha512-Prc7ol+vCIghPeECpwZq5+P+VZfoi87suywvbYCiCnkI1kTmVSdcOC2M8mioglWxBbd28wbb1OVjg/8OzGzatA==", + "dev": true, + "requires": { + "@es-joy/jsdoccomment": "~0.39.4", + "are-docs-informative": "^0.0.2", + "comment-parser": "1.3.1", + "debug": "^4.3.4", + "escape-string-regexp": "^4.0.0", + "esquery": "^1.5.0", + "is-builtin-module": "^3.2.1", + "semver": "^7.5.1", + "spdx-expression-parse": "^3.0.1" + } + }, "eslint-plugin-n": { "version": "15.6.0", "resolved": "https://registry.npmjs.org/eslint-plugin-n/-/eslint-plugin-n-15.6.0.tgz", @@ -9092,12 +9259,12 @@ "dev": true }, "espree": { - "version": "9.5.2", - "resolved": "https://registry.npmjs.org/espree/-/espree-9.5.2.tgz", - "integrity": "sha512-7OASN1Wma5fum5SrNhFMAMJxOUAbhyfQ8dQ//PJaJbNw0URTPWqIghHWt1MmAANKhHZIYOHruW4Kw4ruUWOdGw==", + "version": "9.6.0", + "resolved": "https://registry.npmjs.org/espree/-/espree-9.6.0.tgz", + "integrity": "sha512-1FH/IiruXZ84tpUlm0aCUEwMl2Ho5ilqVh0VvQXw+byAz/4SAciyHLlfmL5WYqsvD38oymdUwBss0LtK8m4s/A==", "dev": true, "requires": { - "acorn": "^8.8.0", + "acorn": "^8.9.0", "acorn-jsx": "^5.3.2", "eslint-visitor-keys": "^3.4.1" } @@ -9658,6 +9825,15 @@ "has-tostringtag": "^1.0.0" } }, + "is-builtin-module": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.1.tgz", + "integrity": "sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A==", + "dev": true, + "requires": { + "builtin-modules": "^3.3.0" + } + }, "is-callable": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", @@ -10325,6 +10501,12 @@ "argparse": "^2.0.1" } }, + "jsdoc-type-pratt-parser": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz", + "integrity": "sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ==", + "dev": true + }, "jsdom": { "version": "22.1.0", "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-22.1.0.tgz", @@ -10679,17 +10861,17 @@ } }, "optionator": { - "version": "0.9.1", - "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", - "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", + "version": "0.9.3", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.3.tgz", + "integrity": "sha512-JjCoypp+jKn1ttEFExxhetCKeJt9zhAgAve5FXHixTvFDW/5aEktX9bufBKLRRMdU7bNtpLfcGu94B3cdEJgjg==", "dev": true, "requires": { + "@aashutoshrathi/word-wrap": "^1.2.3", "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", "levn": "^0.4.1", "prelude-ls": "^1.2.1", - "type-check": "^0.4.0", - "word-wrap": "^1.2.3" + "type-check": "^0.4.0" } }, "os-tmpdir": { @@ -11088,9 +11270,9 @@ } }, "semver": { - "version": "7.3.8", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", - "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", "dev": true, "requires": { "lru-cache": "^6.0.0" @@ -11176,6 +11358,28 @@ } } }, + "spdx-exceptions": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", + "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==", + "dev": true + }, + "spdx-expression-parse": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", + "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", + "dev": true, + "requires": { + "spdx-exceptions": "^2.1.0", + "spdx-license-ids": "^3.0.0" + } + }, + "spdx-license-ids": { + "version": "3.0.13", + "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.13.tgz", + "integrity": "sha512-XkD+zwiqXHikFZm4AX/7JSCXA98U5Db4AFd5XUg/+9UNtnH75+Z9KxtpYiJZx36mUDVOwH83pl7yvCer6ewM3w==", + "dev": true + }, "sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", @@ -11669,12 +11873,6 @@ "is-symbol": "^1.0.3" } }, - "word-wrap": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz", - "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==", - "dev": true - }, "wrap-ansi": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", diff --git a/package.json b/package.json index 6f80de6cf..c59910721 100644 --- a/package.json +++ b/package.json @@ -30,10 +30,11 @@ "@typescript-to-lua/language-extensions": "1.0.0", "chalk": "4.1.2", "commander": "^10.0.1", - "eslint": "^8.43.0", - "eslint-config-standard-with-typescript": "^35.0.0", + "eslint": "^8.44.0", + "eslint-config-standard-with-typescript": "^36.0.0", "eslint-plugin-import": "^2.27.5", - "eslint-plugin-jest": "^27.2.1", + "eslint-plugin-jest": "^27.2.2", + "eslint-plugin-jsdoc": "^46.4.3", "eslint-plugin-sort-keys-fix": "^1.1.2", "fast-xml-parser": "^4.2.4", "fengari": "0.1.4", diff --git a/src/engine/core/database/offline.ts b/src/engine/core/database/offline.ts index 16a60006a..f22d884b0 100644 --- a/src/engine/core/database/offline.ts +++ b/src/engine/core/database/offline.ts @@ -30,10 +30,6 @@ export function registerOfflineObject( /** * Hard reset offline object state. * Create new representation entry if it was not initialize before. - * - * @param objectId - game object ID to register offline representation - * @param state - base offline state to register - * @returns stored offline object state representation */ export function hardResetOfflineObject( objectId: TNumberId, @@ -48,10 +44,6 @@ export function hardResetOfflineObject( /** * Soft reset offline object state. * Do not create new representation entry if it was not initialize before. - * - * @param objectId - game object ID to register offline representation - * @param state - base offline state to register - * @returns stored offline object state representation */ export function softResetOfflineObject( objectId: TNumberId, diff --git a/src/engine/core/managers/world/DropManager.ts b/src/engine/core/managers/world/DropManager.ts index 476dea526..d56aa86cf 100644 --- a/src/engine/core/managers/world/DropManager.ts +++ b/src/engine/core/managers/world/DropManager.ts @@ -171,6 +171,7 @@ export class DropManager extends AbstractCoreManager { /** * todo; + * * @param object - target object to create release items. */ public createCorpseReleaseItems(object: ClientObject): void { diff --git a/src/engine/core/managers/world/WeatherManager.ts b/src/engine/core/managers/world/WeatherManager.ts index 28f9ace14..984a97e83 100644 --- a/src/engine/core/managers/world/WeatherManager.ts +++ b/src/engine/core/managers/world/WeatherManager.ts @@ -244,6 +244,7 @@ export class WeatherManager extends AbstractCoreManager { /** * Transform current state into string. + * * @returns string containing level states, example: `dynamic_default=clear,cloudy;another=cloudy,rainy` */ public getStateAsString(): string { diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_anim_pri_a22.ts b/src/engine/core/objects/server/smart_cover/smart_covers_anim_pri_a22.ts index 41cd6a164..ea5aa4413 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_anim_pri_a22.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_anim_pri_a22.ts @@ -4,6 +4,9 @@ import { ISmartCoverDescriptor } from "@/engine/core/objects/server/smart_cover/ import { getAnimPriA22Loophole } from "@/engine/core/objects/server/smart_cover/smart_covers_loophole_anim_pri_a22"; import { createEmptyVector, createVector } from "@/engine/core/utils/vector"; +/** + * todo; + */ export function getSmartCoverAnimPriA22(): ISmartCoverDescriptor { return { need_weapon: false, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_pri_a15.ts b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_pri_a15.ts index 98fd10769..ab7d0c299 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_pri_a15.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_pri_a15.ts @@ -4,6 +4,9 @@ import { ISmartCoverDescriptor } from "@/engine/core/objects/server/smart_cover/ import { getAnimpointPriA15Loophole } from "@/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_pri_a15"; import { createVector } from "@/engine/core/utils/vector"; +/** + * todo; + */ export function getSmartCoverAnimpointPriA15(): ISmartCoverDescriptor { return { need_weapon: false, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_high.ts b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_high.ts index 2a40dc492..3d24dc830 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_high.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_high.ts @@ -4,6 +4,9 @@ import { ISmartCoverDescriptor } from "@/engine/core/objects/server/smart_cover/ import { getAnimpointSitHighLoophole } from "@/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_high"; import { createVector } from "@/engine/core/utils/vector"; +/** + * todo; + */ export function getSmartCoverAnimpointSitHigh(): ISmartCoverDescriptor { return { need_weapon: false, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_low.ts b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_low.ts index 5e6dd6cb3..8cd1550b8 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_low.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_low.ts @@ -4,6 +4,9 @@ import { ISmartCoverDescriptor } from "@/engine/core/objects/server/smart_cover/ import { getAnimpointSitLowLoophole } from "@/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_low"; import { createVector } from "@/engine/core/utils/vector"; +/** + * todo; + */ export function getSmartCoverAnimpointSitLow(): ISmartCoverDescriptor { return { need_weapon: false, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_normal.ts b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_normal.ts index 49c5694fb..0c3428c96 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_normal.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_sit_normal.ts @@ -5,6 +5,9 @@ import { ISmartCoverDescriptor } from "@/engine/core/objects/server/smart_cover/ import { getAnimpointSitNormalLoophole } from "@/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_normal"; import { createVector } from "@/engine/core/utils/vector"; +/** + * todo; + */ export function getSmartCoverAnimpointSitNormal(): ISmartCoverDescriptor { return { need_weapon: false, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_stay_table.ts b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_stay_table.ts index ff43a07b9..44cd2b656 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_stay_table.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_stay_table.ts @@ -5,6 +5,9 @@ import { ISmartCoverDescriptor } from "@/engine/core/objects/server/smart_cover/ import { getAnimpointStayTableLoophole } from "@/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_table"; import { createVector } from "@/engine/core/utils/vector"; +/** + * todo; + */ export function getSmartCoverAnimpointStayTable(): ISmartCoverDescriptor { return { need_weapon: false, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_stay_wall.ts b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_stay_wall.ts index 4088c5a56..4f5db4ceb 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_stay_wall.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_animpoint_stay_wall.ts @@ -4,6 +4,9 @@ import { ISmartCoverDescriptor } from "@/engine/core/objects/server/smart_cover/ import { getAnimpointStayWallLoophole } from "@/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_wall"; import { createVector } from "@/engine/core/utils/vector"; +/** + * todo; + */ export function getSmartCoverAnimpointStayWall(): ISmartCoverDescriptor { return { need_weapon: false, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_combat.ts b/src/engine/core/objects/server/smart_cover/smart_covers_combat.ts index 64c754363..99e59889b 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_combat.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_combat.ts @@ -13,6 +13,9 @@ import { getStandLeftLoophole } from "@/engine/core/objects/server/smart_cover/s import { getStandRightLoophole } from "@/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_right"; import { createVector } from "@/engine/core/utils/vector"; +/** + * todo; + */ function getSmartCoverCombat(): ISmartCoverDescriptor { return { need_weapon: true, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_combat_front.ts b/src/engine/core/objects/server/smart_cover/smart_covers_combat_front.ts index 6dfe341b5..48a60e3b7 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_combat_front.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_combat_front.ts @@ -8,6 +8,9 @@ import { getStandFrontLeftLoophole } from "@/engine/core/objects/server/smart_co import { getStandFrontRightLoophole } from "@/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_front_right"; import { createVector } from "@/engine/core/utils/vector"; +/** + * + */ export function getSmartCoverCombatFront(): ISmartCoverDescriptor { return { need_weapon: true, @@ -500,7 +503,7 @@ export function getSmartCoverCombatFront(): ISmartCoverDescriptor { vertex1: "", weight: 1.1, actions: [ - /** ### { + /* ### { precondition_functor: "xr_conditions.always", precondition_params: "", @@ -531,7 +534,8 @@ export function getSmartCoverCombatFront(): ISmartCoverDescriptor { vertex1: "", weight: 1.1, actions: [ - /** ### { + /** + ### { precondition_functor: "xr_conditions.always", precondition_params: "", actions = { @@ -541,7 +545,8 @@ export function getSmartCoverCombatFront(): ISmartCoverDescriptor { body_state: move.crouch, movement_type: move.run, }, }, - },*/ + }, + */ { precondition_functor: "xr_conditions.always", precondition_params: "", @@ -561,7 +566,8 @@ export function getSmartCoverCombatFront(): ISmartCoverDescriptor { vertex1: "", weight: 1.1, actions: [ - /** ### { + /* + ### { precondition_functor: "xr_conditions.always", precondition_params: "", actions = { @@ -571,7 +577,8 @@ export function getSmartCoverCombatFront(): ISmartCoverDescriptor { body_state: move.crouch, movement_type: move.run, }, }, - },*/ + }, + */ { precondition_functor: "xr_conditions.always", precondition_params: "", diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_combat_prone.ts b/src/engine/core/objects/server/smart_cover/smart_covers_combat_prone.ts index 5823e31eb..cc2aeaafe 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_combat_prone.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_combat_prone.ts @@ -5,6 +5,9 @@ import { createVector } from "@/engine/core/utils/vector"; import { getProneLoophole } from "./smart_covers_loophole_prone"; +/** + * todo; + */ export function getSmartCoverCombatProne(): ISmartCoverDescriptor { return { loopholes: [getProneLoophole("prone", createVector(-1, 0, 0))] as any, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_anim_pri_a22.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_anim_pri_a22.ts index 8d3fa1b69..ad12472fc 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_anim_pri_a22.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_anim_pri_a22.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getAnimPriA22Loophole( id: TStringId, position: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_pri_a15.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_pri_a15.ts index 3c87b2377..60dae4535 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_pri_a15.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_pri_a15.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getAnimpointPriA15Loophole( id: string, position: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_high.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_high.ts index 87ba63333..16ba396b4 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_high.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_high.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getAnimpointSitHighLoophole( id: string, position: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_low.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_low.ts index e17fa8b4f..c874bddb1 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_low.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_low.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getAnimpointSitLowLoophole( id: TStringId, position: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_normal.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_normal.ts index 5d180b1f0..9f318eb1a 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_normal.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_sit_normal.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getAnimpointSitNormalLoophole( id: TStringId, position: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_table.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_table.ts index 7480fbc2c..3152df35f 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_table.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_table.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getAnimpointStayTableLoophole( id: TStringId, position: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_wall.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_wall.ts index 5bfc57021..e25391023 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_wall.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_animpoint_stay_wall.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getAnimpointStayWallLoophole( id: TStringId, position: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_back.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_back.ts index a6ff48284..604439d3f 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_back.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_back.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createEmptyVector, createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getCrouchBackLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front.ts index 7767b62ab..cb2ce17c0 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getCrouchFrontLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front_left.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front_left.ts index f4588d86e..f263306a2 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front_left.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front_left.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getCrouchFrontLeftLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front_right.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front_right.ts index aca09d0f1..11859e54f 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front_right.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_front_right.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getCrouchFrontRightLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_left.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_left.ts index 37dda8a85..8fe800b6b 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_left.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_left.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createEmptyVector, createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getCrouchLeftLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_right.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_right.ts index 46ec2b62c..c19a31db9 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_right.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_crouch_right.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createEmptyVector, createVector } from "@/engine/core/utils/vector"; import { TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getCrouchRightLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_prone.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_prone.ts index e57dee14e..d6f946c19 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_prone.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_prone.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getProneLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_back.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_back.ts index 60d41952c..41f3f2146 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_back.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_back.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getStandBackLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_front_left.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_front_left.ts index aa902c3d1..a46fca60e 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_front_left.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_front_left.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getStandFrontLeftLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_front_right.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_front_right.ts index 110c9dbfc..4a1e86a61 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_front_right.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_front_right.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getStandFrontRightLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_left.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_left.ts index dbbe968bf..6f658702c 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_left.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_left.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getStandLeftLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_right.ts b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_right.ts index f654c8e31..2c58004c8 100644 --- a/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_right.ts +++ b/src/engine/core/objects/server/smart_cover/smart_covers_loophole_stand_right.ts @@ -2,6 +2,9 @@ import { ISmartCoverLoopholeDescriptor } from "@/engine/core/objects/server/smar import { createVector } from "@/engine/core/utils/vector"; import { Optional, TStringId, Vector } from "@/engine/lib/types"; +/** + * todo; + */ export function getStandRightLoophole( id: TStringId, fovDirection: Vector, diff --git a/src/engine/core/objects/state/add_state_manager.ts b/src/engine/core/objects/state/add_state_manager.ts index 01541740b..c3acfd056 100644 --- a/src/engine/core/objects/state/add_state_manager.ts +++ b/src/engine/core/objects/state/add_state_manager.ts @@ -27,6 +27,7 @@ const logger: LuaLogger = new LuaLogger($filename); /** * Add state manager instance to Stalker object. + * * @param object */ export function addStateManager(object: ClientObject): StalkerStateManager { diff --git a/src/engine/core/objects/state_lib/state_manager_scenario.ts b/src/engine/core/objects/state_lib/state_manager_scenario.ts index 5f4ee236d..f9d7aedbd 100644 --- a/src/engine/core/objects/state_lib/state_manager_scenario.ts +++ b/src/engine/core/objects/state_lib/state_manager_scenario.ts @@ -798,6 +798,9 @@ export function getStateLibScenarios(): LuaTable { } as any; } +/** + * todo; + */ export function getAnimationListScenario(): LuaTable { return { zat_b14_give_artefact_idle: { diff --git a/src/engine/core/objects/state_lib/state_mgr_animation_list_animpoint.ts b/src/engine/core/objects/state_lib/state_mgr_animation_list_animpoint.ts index afbb3ddda..6b04e210b 100644 --- a/src/engine/core/objects/state_lib/state_mgr_animation_list_animpoint.ts +++ b/src/engine/core/objects/state_lib/state_mgr_animation_list_animpoint.ts @@ -1,6 +1,9 @@ import { IAnimationDescriptor } from "@/engine/core/objects/state/types"; import { ClientObject } from "@/engine/lib/types"; +/** + * todo; + */ export function getAnimpointAnimationList(): LuaTable { return { animpoint_stay_wall: { diff --git a/src/engine/core/objects/state_lib/state_mgr_animstate_list_animpoint.ts b/src/engine/core/objects/state_lib/state_mgr_animstate_list_animpoint.ts index c42962644..d85345011 100644 --- a/src/engine/core/objects/state_lib/state_mgr_animstate_list_animpoint.ts +++ b/src/engine/core/objects/state_lib/state_mgr_animstate_list_animpoint.ts @@ -2,6 +2,9 @@ import { IAnimationStateDescriptor } from "@/engine/core/objects/state/types"; import { getExtern } from "@/engine/core/utils/binding"; import { AnyArgs, AnyCallablesModule } from "@/engine/lib/types"; +/** + * todo; + */ export function addAnimstateAnimationList(): LuaTable { return { animpoint_stay_wall: { diff --git a/src/engine/core/objects/state_lib/state_mgr_pri_a15.ts b/src/engine/core/objects/state_lib/state_mgr_pri_a15.ts index bc8c2ee38..0387b52eb 100644 --- a/src/engine/core/objects/state_lib/state_mgr_pri_a15.ts +++ b/src/engine/core/objects/state_lib/state_mgr_pri_a15.ts @@ -23,6 +23,9 @@ const WEAP_TABLE_UNSTRAPPED: LuaArray = [ "pri_a15_wpn_ak74_unstrapped", ] as any; +/** + * todo; + */ function unstrapWeapon(object: ClientObject): void { let item: Optional = null; let index: TIndex = 0; @@ -42,6 +45,9 @@ function unstrapWeapon(object: ClientObject): void { item.attachable_item_load_attach(WEAP_TABLE_UNSTRAPPED.get(index as number)); } +/** + * todo; + */ function strapWeapon(object: ClientObject): void { let item: Optional = null; let index: TIndex = 0; @@ -61,18 +67,30 @@ function strapWeapon(object: ClientObject): void { item.attachable_item_load_attach(WEAP_TABLE.get(index)); } +/** + * todo; + */ function breakFence(): void { registry.doors.get(storyNames.pri_a15_door).forwardAnimation(); } +/** + * todo; + */ function lightsOff(): void { registry.actor.give_info_portion(infoPortions.pri_a15_lights_off); } +/** + * todo; + */ function lightsOn(): void { registry.actor.disable_info_portion(infoPortions.pri_a15_lights_off); } +/** + * todo; + */ function endScene(): void { registry.actor.give_info_portion(infoPortions.pri_a15_cutscene_end); } @@ -616,6 +634,9 @@ const cutscene: Record< }, }; +/** + * + */ function check_availability(precondition: LuaArray, existing_npc: string): boolean { const check_names = parseStringsList(existing_npc); @@ -703,6 +724,9 @@ function get_sequence_for_npc(objectName: TName, existing_npc: string): TNpcSequ return result; } +/** + * + */ export function addStateLibPriA15(): LuaTable { return { pri_a15_idle_none: { @@ -1850,6 +1874,9 @@ export function addStateLibPriA15(): LuaTable { } as any; } +/** + * todo; + */ export function addAnimationListPriA15(): LuaTable> { return { pri_a15_idle_none: { diff --git a/src/engine/core/schemes/heli_move/HeliCombat.ts b/src/engine/core/schemes/heli_move/HeliCombat.ts index 528a4aa29..c4d79a1b8 100644 --- a/src/engine/core/schemes/heli_move/HeliCombat.ts +++ b/src/engine/core/schemes/heli_move/HeliCombat.ts @@ -769,6 +769,9 @@ export class HeliCombat { } } +/** + * todo; + */ export function crossRayCircle(p: Vector, v: Vector, o: Vector, r: number): Vector { const po: Vector = copyVector(o).sub(p); const vperp: Vector = createVector(-v.z, 0, v.x); diff --git a/src/engine/core/schemes/heli_move/HeliFire.ts b/src/engine/core/schemes/heli_move/HeliFire.ts index 9424d4288..e2bbfd18e 100644 --- a/src/engine/core/schemes/heli_move/HeliFire.ts +++ b/src/engine/core/schemes/heli_move/HeliFire.ts @@ -241,6 +241,9 @@ export class HeliFire { } } +/** + * todo; + */ export function getHeliFirer(object: ClientObject): HeliFire { if (heliFirer.get(object.id()) === null) { heliFirer.set(object.id(), new HeliFire(object)); diff --git a/src/engine/core/schemes/heli_move/HeliFly.ts b/src/engine/core/schemes/heli_move/HeliFly.ts index 86b1de329..46c04ddfb 100644 --- a/src/engine/core/schemes/heli_move/HeliFly.ts +++ b/src/engine/core/schemes/heli_move/HeliFly.ts @@ -190,7 +190,9 @@ export class HeliFly { this.pointByLook = lPoint; } } - +/** + * todo; + */ export function getHeliFlyer(object: ClientObject): HeliFly { if (heliFlyer.get(object.id()) === null) { heliFlyer.set(object.id(), new HeliFly(object)); diff --git a/src/engine/core/schemes/heli_move/HeliLook.ts b/src/engine/core/schemes/heli_move/HeliLook.ts index cebf54937..03020fc37 100644 --- a/src/engine/core/schemes/heli_move/HeliLook.ts +++ b/src/engine/core/schemes/heli_move/HeliLook.ts @@ -55,6 +55,9 @@ export class HeliLook { } } +/** + * todo; + */ export function getHeliLooker(object: ClientObject): HeliLook { if (heliLooker.get(object.id()) === null) { heliLooker.set(object.id(), new HeliLook(object)); diff --git a/src/engine/core/schemes/remark/actions/ActionRemarkActivity.ts b/src/engine/core/schemes/remark/actions/ActionRemarkActivity.ts index bd6e8313b..aebb01f33 100644 --- a/src/engine/core/schemes/remark/actions/ActionRemarkActivity.ts +++ b/src/engine/core/schemes/remark/actions/ActionRemarkActivity.ts @@ -189,6 +189,10 @@ export function initTarget( targetString: string ): LuaMultiReturn<[Optional, Optional, Optional]> { // todo: Simplify. + + /** + * todo; + */ function parseTarget(targetStr: string): LuaMultiReturn<[Optional, Optional]> { const [pos] = string.find(targetStr, ","); @@ -200,6 +204,10 @@ export function initTarget( } // todo: Simplify. + + /** + * todo; + */ function parseType(targetStr: string): LuaMultiReturn<[string, string]> { const [pos] = string.find(targetStr, "|"); diff --git a/src/engine/core/ui/game/FreeplayDialog.ts b/src/engine/core/ui/game/FreeplayDialog.ts index 6a5cabc05..034e899a7 100644 --- a/src/engine/core/ui/game/FreeplayDialog.ts +++ b/src/engine/core/ui/game/FreeplayDialog.ts @@ -47,6 +47,9 @@ export class FreeplayDialog extends CUIScriptWnd { let freeplayControl: Optional = null; +/** + * todo; + */ export function showFreeplayDialog(selector: string, text: string): void { if (freeplayControl === null) { freeplayControl = new FreeplayDialog(); diff --git a/src/engine/core/ui/menu/options/OptionsVideoAdvanced.ts b/src/engine/core/ui/menu/options/OptionsVideoAdvanced.ts index fe8541604..6a200b84f 100644 --- a/src/engine/core/ui/menu/options/OptionsVideoAdvanced.ts +++ b/src/engine/core/ui/menu/options/OptionsVideoAdvanced.ts @@ -86,8 +86,7 @@ export class OptionsVideoAdvanced extends CUIWindow { owner.preconditions.set(particlesDistanceTrackBar, only2aAndMoreMode); - /** - * + /* * _st = xml:InitStatic("video_adv:templ_item", nil) * xml:InitStatic("video_adv:cap_r2_smap_size", _st) * ctl = xml:InitComboBox("video_adv:list_r2_smap_size", _st) @@ -200,7 +199,7 @@ export class OptionsVideoAdvanced extends CUIWindow { owner.preconditions.set(wetSurfacesCheck, only3andMoreMode); - /** + /* * * _st = xml:InitStatic("video_adv:templ_item", nil) * xml:InitStatic("video_adv:cap_r3_dynamic_wet_surfaces_opt", _st) @@ -224,14 +223,14 @@ export class OptionsVideoAdvanced extends CUIWindow { owner.preconditions.set(volumetricSmokeCheck, only3andMoreMode); - /** + /* * _st = xml:InitStatic("video_adv:templ_item", nil) * xml:InitStatic("video_adv:cap_r3_msaa_opt", _st) * ctl = xml:InitCheck("video_adv:check_r3_msaa_opt", _st) * table.insert(handler.m_preconditions, {func=mode_ge_3, control=_st}) */ - /** + /* * -- r4_enable_tessellation only r4 * _st = xml:InitStatic("video_adv:templ_item", nil) * xml:InitStatic("video_adv:cap_r4_tessellation", _st) @@ -250,7 +249,7 @@ export class OptionsVideoAdvanced extends CUIWindow { xml.InitStatic("video_adv:cap_60hz", only60HZSetting); xml.InitCheck("video_adv:check_60hz", only60HZSetting); - /** + /* * _st = xml:InitStatic("video_adv:templ_item", nil) * xml:InitStatic("video_adv:cap_always_active", _st) * xml:InitCheck("video_adv:check_always_active", _st) @@ -261,30 +260,48 @@ export class OptionsVideoAdvanced extends CUIWindow { } } +/** + * todo; + */ function only1mode(control: CUIWindow, id: EGameRenderer): void { control.Enable(id === EGameRenderer.R1); } // -- >=R2a +/** + * todo; + */ function only2aAndMoreMode(control: CUIWindow, id: EGameRenderer): void { control.Enable(id >= EGameRenderer.R2A); } // -- >=R2 +/** + * todo; + */ function only2andMoreMode(control: CUIWindow, id: EGameRenderer): void { control.Enable(id >= EGameRenderer.R2); } // -- >=R2.5 +/** + * todo; + */ function only25andMoreMode(control: CUIWindow, id: EGameRenderer): void { control.Enable(id >= EGameRenderer.R25); } // -- >=R3 +/** + * todo; + */ function only3andMoreMode(control: CUIWindow, id: EGameRenderer): void { control.Enable(id >= EGameRenderer.R3); } +/** + * todo; + */ function only3andMoreModeVisible(control: CUIWindow, id: EGameRenderer): void { const isEnabled: boolean = id >= EGameRenderer.R3; @@ -292,6 +309,9 @@ function only3andMoreModeVisible(control: CUIWindow, id: EGameRenderer): void { control.Show(isEnabled); } +/** + * todo; + */ function only3andMoreModeInvisible(control: CUIWindow, id: EGameRenderer): void { const isEnabled: boolean = id < EGameRenderer.R3; @@ -299,10 +319,16 @@ function only3andMoreModeInvisible(control: CUIWindow, id: EGameRenderer): void control.Show(isEnabled); } +/** + * todo; + */ function only4(control: CUIWindow, id: EGameRenderer) { return id === EGameRenderer.R4; } +/** + * todo; + */ function only4andMore(control: CUIWindow, id: EGameRenderer) { return id >= EGameRenderer.R4; } diff --git a/src/engine/core/utils/ini/ini_config.ts b/src/engine/core/utils/ini/ini_config.ts index a32e66840..00a82ad4c 100644 --- a/src/engine/core/utils/ini/ini_config.ts +++ b/src/engine/core/utils/ini/ini_config.ts @@ -285,6 +285,9 @@ export function getConfigSwitchConditions(ini: IniFile, section: TSection): Opti const linesCount: TCount = ini.line_count(section); let index: TIndex = 1; + /** + * todo; + */ function addConditions( func: (ini: IniFile, section: TSection, id: TStringId) => Optional, cond: ESchemeCondition diff --git a/src/engine/core/utils/object/object_danger.ts b/src/engine/core/utils/object/object_danger.ts index ded65502c..bd27f6061 100644 --- a/src/engine/core/utils/object/object_danger.ts +++ b/src/engine/core/utils/object/object_danger.ts @@ -113,6 +113,7 @@ export function isObjectFacingDanger(object: ClientObject): boolean { /** * todo; + * * @returns whether object os enemy of provided client entity */ export function isObjectEnemy(object: ClientObject, enemy: ClientObject, state: ISchemeCombatIgnoreState): boolean { diff --git a/src/engine/core/utils/scheme/scheme_logic.test.ts b/src/engine/core/utils/scheme/scheme_logic.test.ts index 644dc480e..f79707ae9 100644 --- a/src/engine/core/utils/scheme/scheme_logic.test.ts +++ b/src/engine/core/utils/scheme/scheme_logic.test.ts @@ -50,6 +50,9 @@ import { MockAlifeSimulator, mockClientGameObject, mockIniFile, mockServerAlifeH import { MockCTime } from "@/fixtures/xray/mocks/CTime.mock"; describe("'scheme logic' utils", () => { + /** + * todo; + */ function loadGenericSchemes(): Array { const schemes: Array = [ SchemeMeet, diff --git a/src/engine/core/utils/transform/decamelize.ts b/src/engine/core/utils/transform/decamelize.ts index 3daacdb2c..debfb43e7 100644 --- a/src/engine/core/utils/transform/decamelize.ts +++ b/src/engine/core/utils/transform/decamelize.ts @@ -16,10 +16,6 @@ function handlePreserveConsecutiveUppercase(decamelized: string, separator: stri /** * Fork of NPM 'decamelize' package utility. * Decamelize provided string. - * - * @param text - string value to decamelize - * @param config - decamelize process parameters - * @returns decamelized string */ export function decamelize(text: string, { separator = "_", preserveConsecutiveUppercase = false } = {}) { if (text.length < 2) { diff --git a/src/engine/forms/actor_menu.tsx b/src/engine/forms/actor_menu.tsx index 12d6ce8ec..6e7d73f88 100644 --- a/src/engine/forms/actor_menu.tsx +++ b/src/engine/forms/actor_menu.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { captions } from "@/engine/lib/constants/captions"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/actor_menu_16.tsx b/src/engine/forms/actor_menu_16.tsx index 7dd119967..291e1f3ca 100644 --- a/src/engine/forms/actor_menu_16.tsx +++ b/src/engine/forms/actor_menu_16.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { captions } from "@/engine/lib/constants/captions"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/actor_menu_item.tsx b/src/engine/forms/actor_menu_item.tsx index 96d3a6a70..ce69c460f 100644 --- a/src/engine/forms/actor_menu_item.tsx +++ b/src/engine/forms/actor_menu_item.tsx @@ -3,6 +3,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { ArtefactParams } from "@/engine/forms/af_params"; import { BoosterParams } from "@/engine/forms/booster_params"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/actor_menu_item_16.tsx b/src/engine/forms/actor_menu_item_16.tsx index f08e768d0..b8cd9283d 100644 --- a/src/engine/forms/actor_menu_item_16.tsx +++ b/src/engine/forms/actor_menu_item_16.tsx @@ -3,6 +3,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { ArtefactParams } from "@/engine/forms/af_params_16"; import { BoosterParams } from "@/engine/forms/booster_params_16"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/af_params.tsx b/src/engine/forms/af_params.tsx index 294cdee13..f0a5454f6 100644 --- a/src/engine/forms/af_params.tsx +++ b/src/engine/forms/af_params.tsx @@ -1,9 +1,15 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ; } +/** + * todo; + */ export function ArtefactParams(): JSXNode { return ( diff --git a/src/engine/forms/af_params_16.tsx b/src/engine/forms/af_params_16.tsx index 30e74882b..9d113ca62 100644 --- a/src/engine/forms/af_params_16.tsx +++ b/src/engine/forms/af_params_16.tsx @@ -1,9 +1,15 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ; } +/** + * todo; + */ export function ArtefactParams(): JSXNode { return ( diff --git a/src/engine/forms/booster_params.tsx b/src/engine/forms/booster_params.tsx index c1db4655f..73a834c03 100644 --- a/src/engine/forms/booster_params.tsx +++ b/src/engine/forms/booster_params.tsx @@ -4,10 +4,16 @@ import { XrComponent, XrText } from "@/engine/forms/components/base"; import { XrTexture } from "@/engine/forms/components/base/XrTexture.component"; import { fonts } from "@/engine/lib/constants/fonts"; +/** + * todo; + */ export function create(): JSXNode { return ; } +/** + * todo; + */ export function BoosterParams(): JSXNode { return ( @@ -41,6 +47,9 @@ export function BoosterParams(): JSXNode { ); } +/** + * todo; + */ function BoosterParam({ name, texture, diff --git a/src/engine/forms/booster_params_16.tsx b/src/engine/forms/booster_params_16.tsx index e33279cce..8073edea7 100644 --- a/src/engine/forms/booster_params_16.tsx +++ b/src/engine/forms/booster_params_16.tsx @@ -4,10 +4,16 @@ import { XrComponent, XrText } from "@/engine/forms/components/base"; import { XrTexture } from "@/engine/forms/components/base/XrTexture.component"; import { fonts } from "@/engine/lib/constants/fonts"; +/** + * todo; + */ export function create(): JSXNode { return ; } +/** + * todo; + */ export function BoosterParams(): JSXNode { return ( @@ -41,6 +47,9 @@ export function BoosterParams(): JSXNode { ); } +/** + * + */ function BoosterParam({ name, texture, diff --git a/src/engine/forms/buy_menu_item.tsx b/src/engine/forms/buy_menu_item.tsx index bfe2ed691..9af08e21a 100644 --- a/src/engine/forms/buy_menu_item.tsx +++ b/src/engine/forms/buy_menu_item.tsx @@ -3,6 +3,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { ArtefactParams } from "@/engine/forms/af_params"; import { BoosterParams } from "@/engine/forms/booster_params"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/buy_menu_item_16.tsx b/src/engine/forms/buy_menu_item_16.tsx index f1c89c659..3fa2f507e 100644 --- a/src/engine/forms/buy_menu_item_16.tsx +++ b/src/engine/forms/buy_menu_item_16.tsx @@ -3,6 +3,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { ArtefactParams } from "@/engine/forms/af_params_16"; import { BoosterParams } from "@/engine/forms/booster_params_16"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/chat_mp.tsx b/src/engine/forms/chat_mp.tsx index c6874b04b..4c921a394 100644 --- a/src/engine/forms/chat_mp.tsx +++ b/src/engine/forms/chat_mp.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/color_defs.tsx b/src/engine/forms/color_defs.tsx index f61907f39..92da34557 100644 --- a/src/engine/forms/color_defs.tsx +++ b/src/engine/forms/color_defs.tsx @@ -1,6 +1,10 @@ import { JSXNode, JSXXML } from "jsx-xml"; // todo: Use enum with defined colors. + +/** + * todo; + */ export function create(): JSXNode { // // diff --git a/src/engine/forms/components/base/XrBackground.component.tsx b/src/engine/forms/components/base/XrBackground.component.tsx index afd9efc68..6ee21194d 100644 --- a/src/engine/forms/components/base/XrBackground.component.tsx +++ b/src/engine/forms/components/base/XrBackground.component.tsx @@ -8,6 +8,9 @@ export interface IXrBackgroundProps extends IBaseXmlNode { stretch?: boolean; } +/** + * todo; + */ export function XrBackground(props: IXrBackgroundProps): JSXNode { const { x, y, width, height, stretch } = normalizeBaseNodeProps(props); diff --git a/src/engine/forms/components/base/XrCheckBox.component.tsx b/src/engine/forms/components/base/XrCheckBox.component.tsx index 26d34d36d..138f5cbc3 100644 --- a/src/engine/forms/components/base/XrCheckBox.component.tsx +++ b/src/engine/forms/components/base/XrCheckBox.component.tsx @@ -16,6 +16,9 @@ export interface IXrCheckBoxProps extends IBaseXmlNode { group?: string; } +/** + * todo; + */ export function XrCheckBox(props: IXrCheckBoxProps): JSXNode { const { tag = "check", diff --git a/src/engine/forms/components/base/XrComponent.component.tsx b/src/engine/forms/components/base/XrComponent.component.tsx index 168e0ba8f..a06a9ec33 100644 --- a/src/engine/forms/components/base/XrComponent.component.tsx +++ b/src/engine/forms/components/base/XrComponent.component.tsx @@ -6,6 +6,9 @@ import { IBaseXmlNode } from "@/engine/lib/types"; export interface IXrContainerProps extends IBaseXmlNode {} +/** + * todo; + */ export function XrComponent(props: IXrContainerProps): JSXNode { const { x, y, width, height, stretch } = normalizeBaseNodeProps(props); diff --git a/src/engine/forms/components/base/XrEditBox.component.tsx b/src/engine/forms/components/base/XrEditBox.component.tsx index d58c03a2a..7f8845bbc 100644 --- a/src/engine/forms/components/base/XrEditBox.component.tsx +++ b/src/engine/forms/components/base/XrEditBox.component.tsx @@ -17,6 +17,9 @@ export interface IXrEditBoxProps extends IBaseXmlNode { maxSymbolsCount?: number; } +/** + * todo; + */ export function XrEditBox(props: IXrEditBoxProps): JSXNode { const { tag = "edit_box", diff --git a/src/engine/forms/components/base/XrList.component.tsx b/src/engine/forms/components/base/XrList.component.tsx index 80e75f494..e6a68fdb2 100644 --- a/src/engine/forms/components/base/XrList.component.tsx +++ b/src/engine/forms/components/base/XrList.component.tsx @@ -10,7 +10,9 @@ export interface IXrListComponentProps extends IBaseXmlNode { itemHeight: number; canSelect?: boolean; } - +/** + * todo; + */ export function XrList(props: IXrListComponentProps): JSXNode { const { tag = "list", diff --git a/src/engine/forms/components/base/XrListRenderer.component.tsx b/src/engine/forms/components/base/XrListRenderer.component.tsx index 479164304..29e01fb28 100644 --- a/src/engine/forms/components/base/XrListRenderer.component.tsx +++ b/src/engine/forms/components/base/XrListRenderer.component.tsx @@ -7,6 +7,9 @@ import { IBaseXmlNode } from "@/engine/lib/types"; export interface IXrComboBoxProps extends IBaseXmlNode {} +/** + * todo; + */ export function XrComboBox(props: IXrComboBoxProps): JSXNode { const { tag = "list_renderer", x, y, width, height, children = null } = normalizeBaseNodeProps(props); diff --git a/src/engine/forms/components/base/XrRoot.component.tsx b/src/engine/forms/components/base/XrRoot.component.tsx index e6bb1dcd8..b612d1983 100644 --- a/src/engine/forms/components/base/XrRoot.component.tsx +++ b/src/engine/forms/components/base/XrRoot.component.tsx @@ -6,6 +6,9 @@ import { IBaseXmlNode } from "@/engine/lib/types"; export interface IXrRootProps extends IBaseXmlNode {} +/** + * todo; + */ export function XrRoot(props: IXrRootProps): JSXNode { const { width, height, x, y } = normalizeBaseNodeProps(props); diff --git a/src/engine/forms/components/base/XrScrollView.component.tsx b/src/engine/forms/components/base/XrScrollView.component.tsx index f337b1994..5a759a528 100644 --- a/src/engine/forms/components/base/XrScrollView.component.tsx +++ b/src/engine/forms/components/base/XrScrollView.component.tsx @@ -17,6 +17,9 @@ export interface IXrScrollViewProps extends IBaseXmlNode { scrollProfile?: string; } +/** + * todo; + */ export function XrScrollView(props: IXrScrollViewProps): JSXNode { const { tag = "scroll_view", diff --git a/src/engine/forms/components/base/XrTabButton.component.tsx b/src/engine/forms/components/base/XrTabButton.component.tsx index 6d897ce43..01073a529 100644 --- a/src/engine/forms/components/base/XrTabButton.component.tsx +++ b/src/engine/forms/components/base/XrTabButton.component.tsx @@ -12,6 +12,9 @@ export interface IXrTabButtonProps extends IBaseXmlNode { stretch?: boolean; } +/** + * todo; + */ export function XrTabButton(props: IXrTabButtonProps): JSXNode { const { x, y, width, height, children, texture, id, stretch } = normalizeBaseNodeProps(props); diff --git a/src/engine/forms/demo_play_control.tsx b/src/engine/forms/demo_play_control.tsx index 4e0bfc3ab..d9f74dd9c 100644 --- a/src/engine/forms/demo_play_control.tsx +++ b/src/engine/forms/demo_play_control.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/game/GameUi.component.16.tsx b/src/engine/forms/game/GameUi.component.16.tsx index f562f25f0..be1501da2 100644 --- a/src/engine/forms/game/GameUi.component.16.tsx +++ b/src/engine/forms/game/GameUi.component.16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function GameUi(): JSXNode { return ( diff --git a/src/engine/forms/game/GameUi.component.tsx b/src/engine/forms/game/GameUi.component.tsx index 9498c77ed..b0229bc92 100644 --- a/src/engine/forms/game/GameUi.component.tsx +++ b/src/engine/forms/game/GameUi.component.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { captions } from "@/engine/lib/constants/captions"; +/** + * todo; + */ export function GameUi(): JSXNode { return ( diff --git a/src/engine/forms/game/heli/heli_progress.tsx b/src/engine/forms/game/heli/heli_progress.tsx index 50edeba03..a2aa9cdc4 100644 --- a/src/engine/forms/game/heli/heli_progress.tsx +++ b/src/engine/forms/game/heli/heli_progress.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/game/map/MapDescription.component.16.tsx b/src/engine/forms/game/map/MapDescription.component.16.tsx index e8b883294..f4c3696bf 100644 --- a/src/engine/forms/game/map/MapDescription.component.16.tsx +++ b/src/engine/forms/game/map/MapDescription.component.16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function MapDescription(): JSXNode { return ( diff --git a/src/engine/forms/game/map/MapDescription.component.tsx b/src/engine/forms/game/map/MapDescription.component.tsx index 662a141f9..ca94c1b48 100644 --- a/src/engine/forms/game/map/MapDescription.component.tsx +++ b/src/engine/forms/game/map/MapDescription.component.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function MapDescription(): JSXNode { return ( diff --git a/src/engine/forms/game/map/MapSpots.component.16.tsx b/src/engine/forms/game/map/MapSpots.component.16.tsx index 9d5f7bc10..1aac8948a 100644 --- a/src/engine/forms/game/map/MapSpots.component.16.tsx +++ b/src/engine/forms/game/map/MapSpots.component.16.tsx @@ -6,6 +6,9 @@ import { SmartTerrainSpots } from "@/engine/forms/game/map/spots/SmartTerrainSpo import { SquadSpots } from "@/engine/forms/game/map/spots/SquadSpots"; import { TaskSpots } from "@/engine/forms/game/map/spots/TaskSpots"; +/** + * todo; + */ export function MapSpots(): JSXNode { return ( @@ -349,8 +352,10 @@ export function MapSpots(): JSXNode { - {/** */} + {/** + + */} ui_inGame2_PDA_icon_secret @@ -848,7 +853,7 @@ export function MapSpots(): JSXNode { > ui_inGame2_PDA_icon_location - {/** */} + {/** + + */} ui_inGame2_PDA_icon_secret @@ -848,11 +853,13 @@ export function MapSpots(): JSXNode { > ui_inGame2_PDA_icon_location - {/** */} + --> + */} diff --git a/src/engine/forms/game/map/Pda.component.16.tsx b/src/engine/forms/game/map/Pda.component.16.tsx index 94642994c..fdb0c86dd 100644 --- a/src/engine/forms/game/map/Pda.component.16.tsx +++ b/src/engine/forms/game/map/Pda.component.16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function Pda(): JSXNode { return ( diff --git a/src/engine/forms/game/map/Pda.component.tsx b/src/engine/forms/game/map/Pda.component.tsx index 4854e2ae4..aac3908a4 100644 --- a/src/engine/forms/game/map/Pda.component.tsx +++ b/src/engine/forms/game/map/Pda.component.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function Pda(): JSXNode { return ( diff --git a/src/engine/forms/game/map/spots/MapMultiplayerSpots.tsx b/src/engine/forms/game/map/spots/MapMultiplayerSpots.tsx index 34fc0ee85..e3782bc6b 100644 --- a/src/engine/forms/game/map/spots/MapMultiplayerSpots.tsx +++ b/src/engine/forms/game/map/spots/MapMultiplayerSpots.tsx @@ -1,5 +1,8 @@ import { Fragment, JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function MapMultiplayerSpots(): JSXNode { return ( diff --git a/src/engine/forms/game/map/spots/MapRelationSpots.tsx b/src/engine/forms/game/map/spots/MapRelationSpots.tsx index d3df11a44..f5340a024 100644 --- a/src/engine/forms/game/map/spots/MapRelationSpots.tsx +++ b/src/engine/forms/game/map/spots/MapRelationSpots.tsx @@ -1,5 +1,8 @@ import { Fragment, JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function MapRelationSpots(): JSXNode { return ( diff --git a/src/engine/forms/game/map/spots/SmartTerrainSpots.tsx b/src/engine/forms/game/map/spots/SmartTerrainSpots.tsx index 0b5127da3..e8c1b4b25 100644 --- a/src/engine/forms/game/map/spots/SmartTerrainSpots.tsx +++ b/src/engine/forms/game/map/spots/SmartTerrainSpots.tsx @@ -1,5 +1,8 @@ import { Fragment, JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function SmartTerrainSpots(): JSXNode { return ( diff --git a/src/engine/forms/game/map/spots/SquadSpots.tsx b/src/engine/forms/game/map/spots/SquadSpots.tsx index 162361537..81bc346ea 100644 --- a/src/engine/forms/game/map/spots/SquadSpots.tsx +++ b/src/engine/forms/game/map/spots/SquadSpots.tsx @@ -1,5 +1,8 @@ import { Fragment, JSXNode, JSXXML } from "jsx-xml"; +/** + * + */ export function SquadSpots(): JSXNode { return ( @@ -171,7 +174,7 @@ export function SquadSpots(): JSXNode { - {/** - */} + */} @@ -461,13 +464,16 @@ export function TaskSpots(): JSXNode { - {/** */} + --> + */} - {/** */} + --> + */} @@ -708,7 +715,8 @@ export function TaskSpots(): JSXNode { - {/** */} + --> + */} ); } diff --git a/src/engine/forms/game_tutorials.tsx b/src/engine/forms/game_tutorials.tsx index 19814930f..e11791d05 100644 --- a/src/engine/forms/game_tutorials.tsx +++ b/src/engine/forms/game_tutorials.tsx @@ -10,6 +10,9 @@ import { GameVendorsIntro, } from "@/engine/forms/tutorials"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/grenade.tsx b/src/engine/forms/grenade.tsx index b516f8a38..1967b3eb5 100644 --- a/src/engine/forms/grenade.tsx +++ b/src/engine/forms/grenade.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/hint_item.tsx b/src/engine/forms/hint_item.tsx index 1f156afa6..971518466 100644 --- a/src/engine/forms/hint_item.tsx +++ b/src/engine/forms/hint_item.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ingame_msglog_mp.tsx b/src/engine/forms/ingame_msglog_mp.tsx index f04b4d560..0bca27e43 100644 --- a/src/engine/forms/ingame_msglog_mp.tsx +++ b/src/engine/forms/ingame_msglog_mp.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ingame_msglog_sp.tsx b/src/engine/forms/ingame_msglog_sp.tsx index d13c33bc7..207ea1c0a 100644 --- a/src/engine/forms/ingame_msglog_sp.tsx +++ b/src/engine/forms/ingame_msglog_sp.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/interaction/SleepDialog.component.16.tsx b/src/engine/forms/interaction/SleepDialog.component.16.tsx index 4a47a8beb..996357bee 100644 --- a/src/engine/forms/interaction/SleepDialog.component.16.tsx +++ b/src/engine/forms/interaction/SleepDialog.component.16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/interaction/SleepDialog.component.tsx b/src/engine/forms/interaction/SleepDialog.component.tsx index 204f463ff..dc319b9ec 100644 --- a/src/engine/forms/interaction/SleepDialog.component.tsx +++ b/src/engine/forms/interaction/SleepDialog.component.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/inventory_new.tsx b/src/engine/forms/inventory_new.tsx index fa8426401..e76ed1bb1 100644 --- a/src/engine/forms/inventory_new.tsx +++ b/src/engine/forms/inventory_new.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/inventory_new_16.tsx b/src/engine/forms/inventory_new_16.tsx index fa8426401..e76ed1bb1 100644 --- a/src/engine/forms/inventory_new_16.tsx +++ b/src/engine/forms/inventory_new_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/inventory_upgrade.tsx b/src/engine/forms/inventory_upgrade.tsx index 31a998650..464b1e7b6 100644 --- a/src/engine/forms/inventory_upgrade.tsx +++ b/src/engine/forms/inventory_upgrade.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/inventory_upgrade_16.tsx b/src/engine/forms/inventory_upgrade_16.tsx index 89cad9704..d9d92fdd6 100644 --- a/src/engine/forms/inventory_upgrade_16.tsx +++ b/src/engine/forms/inventory_upgrade_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/inventory_upgrade_info.tsx b/src/engine/forms/inventory_upgrade_info.tsx index fa8426401..e76ed1bb1 100644 --- a/src/engine/forms/inventory_upgrade_info.tsx +++ b/src/engine/forms/inventory_upgrade_info.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/inventory_upgrade_info_16.tsx b/src/engine/forms/inventory_upgrade_info_16.tsx index fa8426401..e76ed1bb1 100644 --- a/src/engine/forms/inventory_upgrade_info_16.tsx +++ b/src/engine/forms/inventory_upgrade_info_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/maingame.tsx b/src/engine/forms/maingame.tsx index 2a6b727e2..ca10bc1ff 100644 --- a/src/engine/forms/maingame.tsx +++ b/src/engine/forms/maingame.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { GameUi } from "@/engine/forms/game/GameUi.component"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/maingame_16.tsx b/src/engine/forms/maingame_16.tsx index 62b01d4a5..84e24276c 100644 --- a/src/engine/forms/maingame_16.tsx +++ b/src/engine/forms/maingame_16.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { GameUi } from "@/engine/forms/game/GameUi.component.16"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/maingame_pda_msg.tsx b/src/engine/forms/maingame_pda_msg.tsx index eb67157ea..fe94f2402 100644 --- a/src/engine/forms/maingame_pda_msg.tsx +++ b/src/engine/forms/maingame_pda_msg.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/maingame_pda_msg_16.tsx b/src/engine/forms/maingame_pda_msg_16.tsx index 2c65b90a7..a4be57051 100644 --- a/src/engine/forms/maingame_pda_msg_16.tsx +++ b/src/engine/forms/maingame_pda_msg_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/map_desc.tsx b/src/engine/forms/map_desc.tsx index 6f9b3f526..d686585a0 100644 --- a/src/engine/forms/map_desc.tsx +++ b/src/engine/forms/map_desc.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { MapDescription } from "@/engine/forms/game/map/MapDescription.component"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/map_desc_16.tsx b/src/engine/forms/map_desc_16.tsx index da3e20d81..680acbc85 100644 --- a/src/engine/forms/map_desc_16.tsx +++ b/src/engine/forms/map_desc_16.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { MapDescription } from "@/engine/forms/game/map/MapDescription.component.16"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/map_spots.tsx b/src/engine/forms/map_spots.tsx index 3662d3bd5..95a25d82e 100644 --- a/src/engine/forms/map_spots.tsx +++ b/src/engine/forms/map_spots.tsx @@ -2,6 +2,9 @@ import { MapSpots } from "@/engine/forms/game/map/MapSpots.component"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/map_spots_16.tsx b/src/engine/forms/map_spots_16.tsx index 113a1558b..49a8b7f42 100644 --- a/src/engine/forms/map_spots_16.tsx +++ b/src/engine/forms/map_spots_16.tsx @@ -2,6 +2,9 @@ import { MapSpots } from "@/engine/forms/game/map/MapSpots.component.16"; +/** + * todo; + */ export function create(): JSXNode { return ; } diff --git a/src/engine/forms/menu/LoadDialog.component.tsx b/src/engine/forms/menu/LoadDialog.component.tsx index 902ce424b..8b8d6edb8 100644 --- a/src/engine/forms/menu/LoadDialog.component.tsx +++ b/src/engine/forms/menu/LoadDialog.component.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/MainMenu.component.tsx b/src/engine/forms/menu/MainMenu.component.tsx index 235d63a1c..544ee08b7 100644 --- a/src/engine/forms/menu/MainMenu.component.tsx +++ b/src/engine/forms/menu/MainMenu.component.tsx @@ -4,6 +4,9 @@ import { captions } from "@/engine/lib/constants/captions/captions"; import { fonts } from "@/engine/lib/constants/fonts"; import { textures } from "@/engine/lib/constants/textures"; +/** + * todo; + */ export function create(): JSXNode { return ( @@ -105,6 +108,9 @@ export function create(): JSXNode { ); } +/** + * todo; + */ function MainMenuBackground(): JSXNode { return ( diff --git a/src/engine/forms/menu/MenuCredits.tsx b/src/engine/forms/menu/MenuCredits.tsx index c2d1cf0e2..5d4f615db 100644 --- a/src/engine/forms/menu/MenuCredits.tsx +++ b/src/engine/forms/menu/MenuCredits.tsx @@ -1,5 +1,8 @@ import { Fragment, JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function MenuCredits(): JSXNode { return ( diff --git a/src/engine/forms/menu/OptionsDialog.component.tsx b/src/engine/forms/menu/OptionsDialog.component.tsx index cdcda72d3..497dcd76d 100644 --- a/src/engine/forms/menu/OptionsDialog.component.tsx +++ b/src/engine/forms/menu/OptionsDialog.component.tsx @@ -6,6 +6,9 @@ import { OptionsSounds } from "@/engine/forms/menu/options/OptionsSounds.part"; import { OptionsVideo } from "@/engine/forms/menu/options/OptionsVideo.part"; import { OptionsVideoAdvanced } from "@/engine/forms/menu/options/OptionsVideoAdvanced.part"; +/** + * todo; + */ export function create(): JSXNode { return ( @@ -30,6 +33,9 @@ export function create(): JSXNode { ); } +/** + * todo; + */ function OptionsBody(): JSXNode { return ( @@ -105,6 +111,9 @@ function OptionsBody(): JSXNode { ); } +/** + * todo; + */ function OptionsBackground(): JSXNode { return ( @@ -126,6 +135,9 @@ function OptionsBackground(): JSXNode { ); } +/** + * + */ function OptionsPatchDownload(): JSXNode { return ( diff --git a/src/engine/forms/menu/SaveDialog.component.tsx b/src/engine/forms/menu/SaveDialog.component.tsx index e7af637f4..9fceff10f 100644 --- a/src/engine/forms/menu/SaveDialog.component.tsx +++ b/src/engine/forms/menu/SaveDialog.component.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugCommandsSection.component.tsx b/src/engine/forms/menu/debug/DebugCommandsSection.component.tsx index 4642aa8b4..24f0b3816 100644 --- a/src/engine/forms/menu/debug/DebugCommandsSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugCommandsSection.component.tsx @@ -4,6 +4,9 @@ import { XrCheckBox, XrComponent, XrRoot, XrText } from "@/engine/forms/componen import { XrScrollView } from "@/engine/forms/components/base/XrScrollView.component"; import { SECTION_HEIGHT, SECTION_WIDTH } from "@/engine/forms/menu/debug/DebugDialog.component"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugDialog.component.tsx b/src/engine/forms/menu/debug/DebugDialog.component.tsx index 65cea106b..bbf628d47 100644 --- a/src/engine/forms/menu/debug/DebugDialog.component.tsx +++ b/src/engine/forms/menu/debug/DebugDialog.component.tsx @@ -19,6 +19,9 @@ export const SECTION_HEIGHT: number = BASE_HEIGHT - 16; const TEXT_COLOR_DARKER: IRgbColor = { r: 170, g: 170, b: 170 }; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugGeneralSection.component.tsx b/src/engine/forms/menu/debug/DebugGeneralSection.component.tsx index 680a6a5d8..61fe5d38f 100644 --- a/src/engine/forms/menu/debug/DebugGeneralSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugGeneralSection.component.tsx @@ -9,6 +9,9 @@ import { textures } from "@/engine/lib/constants/textures"; const BASE_WIDTH: number = SECTION_WIDTH; const BASE_HEIGHT: number = SECTION_HEIGHT; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugItemsSection.component.tsx b/src/engine/forms/menu/debug/DebugItemsSection.component.tsx index c8facd963..29d518b3d 100644 --- a/src/engine/forms/menu/debug/DebugItemsSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugItemsSection.component.tsx @@ -7,6 +7,9 @@ import { SECTION_HEIGHT, SECTION_WIDTH } from "@/engine/forms/menu/debug/DebugDi import { WHITE } from "@/engine/lib/constants/colors"; import { textures } from "@/engine/lib/constants/textures"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugObjectSection.component.tsx b/src/engine/forms/menu/debug/DebugObjectSection.component.tsx index 06ffc3541..27c4a5177 100644 --- a/src/engine/forms/menu/debug/DebugObjectSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugObjectSection.component.tsx @@ -4,6 +4,9 @@ import { Xr3tButton, XrCheckBox, XrRoot, XrStatic, XrText } from "@/engine/forms import { WHITE } from "@/engine/lib/constants/colors"; import { fonts } from "@/engine/lib/constants/fonts"; +/** + * todo; + */ export function create(): JSXNode { return ( @@ -24,6 +27,9 @@ export function create(): JSXNode { ); } +/** + * todo; + */ function renderLoggingButtons(): JSXNode { return ( @@ -85,6 +91,9 @@ function renderLoggingButtons(): JSXNode { ); } +/** + * todo; + */ function renderRelationButtons(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugPlayerSection.component.tsx b/src/engine/forms/menu/debug/DebugPlayerSection.component.tsx index 9ff7810b3..c93426ce5 100644 --- a/src/engine/forms/menu/debug/DebugPlayerSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugPlayerSection.component.tsx @@ -6,6 +6,9 @@ import { textures } from "@/engine/lib/constants/textures"; const BASE_WIDTH: number = SECTION_WIDTH; const BASE_HEIGHT: number = SECTION_HEIGHT; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugPositionSection.component.tsx b/src/engine/forms/menu/debug/DebugPositionSection.component.tsx index 9ff7810b3..c93426ce5 100644 --- a/src/engine/forms/menu/debug/DebugPositionSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugPositionSection.component.tsx @@ -6,6 +6,9 @@ import { textures } from "@/engine/lib/constants/textures"; const BASE_WIDTH: number = SECTION_WIDTH; const BASE_HEIGHT: number = SECTION_HEIGHT; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugRegistrySection.component.tsx b/src/engine/forms/menu/debug/DebugRegistrySection.component.tsx index 7e679b62c..e66ebe164 100644 --- a/src/engine/forms/menu/debug/DebugRegistrySection.component.tsx +++ b/src/engine/forms/menu/debug/DebugRegistrySection.component.tsx @@ -4,6 +4,9 @@ import { Xr3tButton } from "@/engine/forms/components/base"; import { WHITE } from "@/engine/lib/constants/colors"; import { fonts } from "@/engine/lib/constants/fonts"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugSoundSection.component.tsx b/src/engine/forms/menu/debug/DebugSoundSection.component.tsx index 9ff7810b3..c93426ce5 100644 --- a/src/engine/forms/menu/debug/DebugSoundSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugSoundSection.component.tsx @@ -6,6 +6,9 @@ import { textures } from "@/engine/lib/constants/textures"; const BASE_WIDTH: number = SECTION_WIDTH; const BASE_HEIGHT: number = SECTION_HEIGHT; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugSpawnSection.component.tsx b/src/engine/forms/menu/debug/DebugSpawnSection.component.tsx index b99c4f026..74b2209c6 100644 --- a/src/engine/forms/menu/debug/DebugSpawnSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugSpawnSection.component.tsx @@ -7,6 +7,9 @@ import { SECTION_HEIGHT, SECTION_WIDTH } from "@/engine/forms/menu/debug/DebugDi import { WHITE } from "@/engine/lib/constants/colors"; import { textures } from "@/engine/lib/constants/textures"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugTeleportSection.component.tsx b/src/engine/forms/menu/debug/DebugTeleportSection.component.tsx index f8076555a..a482666dd 100644 --- a/src/engine/forms/menu/debug/DebugTeleportSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugTeleportSection.component.tsx @@ -7,6 +7,9 @@ import { SECTION_HEIGHT, SECTION_WIDTH } from "@/engine/forms/menu/debug/DebugDi import { WHITE } from "@/engine/lib/constants/colors"; import { textures } from "@/engine/lib/constants/textures"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/debug/DebugUiSection.component.tsx b/src/engine/forms/menu/debug/DebugUiSection.component.tsx index 6ae0050ea..1b873f1a9 100644 --- a/src/engine/forms/menu/debug/DebugUiSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugUiSection.component.tsx @@ -10,6 +10,9 @@ import { IRgbColor } from "@/engine/lib/types"; const BASE_WIDTH: number = SECTION_WIDTH; const BASE_HEIGHT: number = SECTION_HEIGHT; +/** + * todo; + */ export function create(): JSXNode { const DEFAULT_SPACING: number = 12; diff --git a/src/engine/forms/menu/debug/DebugWeatherSection.component.tsx b/src/engine/forms/menu/debug/DebugWeatherSection.component.tsx index 06a0f4299..f21fd47fe 100644 --- a/src/engine/forms/menu/debug/DebugWeatherSection.component.tsx +++ b/src/engine/forms/menu/debug/DebugWeatherSection.component.tsx @@ -7,6 +7,9 @@ import { WHITE } from "@/engine/lib/constants/colors"; import { fonts } from "@/engine/lib/constants/fonts"; import { textures } from "@/engine/lib/constants/textures"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/multiplayer/MultiplayerAwards.component.tsx b/src/engine/forms/menu/multiplayer/MultiplayerAwards.component.tsx index 0e24c9395..115202390 100644 --- a/src/engine/forms/menu/multiplayer/MultiplayerAwards.component.tsx +++ b/src/engine/forms/menu/multiplayer/MultiplayerAwards.component.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/multiplayer/MultiplayerBuyButtons.16.tsx b/src/engine/forms/menu/multiplayer/MultiplayerBuyButtons.16.tsx index 6333317a4..eec9795e4 100644 --- a/src/engine/forms/menu/multiplayer/MultiplayerBuyButtons.16.tsx +++ b/src/engine/forms/menu/multiplayer/MultiplayerBuyButtons.16.tsx @@ -1,5 +1,8 @@ import { Fragment, JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function MultiplayerBuyButtons16(): JSXNode { return ( diff --git a/src/engine/forms/menu/multiplayer/MultiplayerBuyButtons.tsx b/src/engine/forms/menu/multiplayer/MultiplayerBuyButtons.tsx index d2cd88c02..988980d79 100644 --- a/src/engine/forms/menu/multiplayer/MultiplayerBuyButtons.tsx +++ b/src/engine/forms/menu/multiplayer/MultiplayerBuyButtons.tsx @@ -1,5 +1,8 @@ import { Fragment, JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function MultiplayerBuyButtons(): JSXNode { return ( diff --git a/src/engine/forms/menu/multiplayer/MultiplayerGamespy.component.tsx b/src/engine/forms/menu/multiplayer/MultiplayerGamespy.component.tsx index 8592ae636..32bb92618 100644 --- a/src/engine/forms/menu/multiplayer/MultiplayerGamespy.component.tsx +++ b/src/engine/forms/menu/multiplayer/MultiplayerGamespy.component.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/multiplayer/MultiplayerLocalnet.component.tsx b/src/engine/forms/menu/multiplayer/MultiplayerLocalnet.component.tsx index 9943d433a..fc77914a4 100644 --- a/src/engine/forms/menu/multiplayer/MultiplayerLocalnet.component.tsx +++ b/src/engine/forms/menu/multiplayer/MultiplayerLocalnet.component.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/menu/multiplayer/MultiplayerOffline.component.tsx b/src/engine/forms/menu/multiplayer/MultiplayerOffline.component.tsx index f4a5cc661..5193fbef0 100644 --- a/src/engine/forms/menu/multiplayer/MultiplayerOffline.component.tsx +++ b/src/engine/forms/menu/multiplayer/MultiplayerOffline.component.tsx @@ -5,6 +5,9 @@ import { MultiplayerTabDemo } from "@/engine/forms/menu/multiplayer/tabs/Multipl import { MultiplayerTabOptions } from "@/engine/forms/menu/multiplayer/tabs/MultiplayerTabOptions.part"; import { MultiplayerTabServer } from "@/engine/forms/menu/multiplayer/tabs/MultiplayerTabServer.part"; +/** + * + */ export function create(): JSXNode { return ( @@ -138,7 +141,7 @@ export function create(): JSXNode { - {/** + {/* * --> + +/** + * todo; + */ export function create(): JSXNode { - /** + /* * * <_rank_caption x="23" y="150" width="153" height="15"> * diff --git a/src/engine/forms/tutorials/GameVendorsIntro.component.tsx b/src/engine/forms/tutorials/GameVendorsIntro.component.tsx index 91e32e3cc..3731493c1 100644 --- a/src/engine/forms/tutorials/GameVendorsIntro.component.tsx +++ b/src/engine/forms/tutorials/GameVendorsIntro.component.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { gameConfig } from "@/engine/lib/configs/GameConfig"; +/** + * todo; + */ export function GameVendorsIntro(): JSXNode { if (gameConfig.UI.ARE_INTRO_VIDEOS_ENABLED) { return ( diff --git a/src/engine/forms/ui_credits.tsx b/src/engine/forms/ui_credits.tsx index 155bcfd3f..d69206b40 100644 --- a/src/engine/forms/ui_credits.tsx +++ b/src/engine/forms/ui_credits.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { MenuCredits } from "@/engine/forms/menu/MenuCredits"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_credits_16.tsx b/src/engine/forms/ui_credits_16.tsx index 80e342487..c2c7e446c 100644 --- a/src/engine/forms/ui_credits_16.tsx +++ b/src/engine/forms/ui_credits_16.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { MenuCredits } from "@/engine/forms/menu/MenuCredits"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_custom_msgs.tsx b/src/engine/forms/ui_custom_msgs.tsx index 605877602..24fa53c24 100644 --- a/src/engine/forms/ui_custom_msgs.tsx +++ b/src/engine/forms/ui_custom_msgs.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return (
diff --git a/src/engine/forms/ui_detector_artefact.tsx b/src/engine/forms/ui_detector_artefact.tsx index 2a79096f6..2f6267c28 100644 --- a/src/engine/forms/ui_detector_artefact.tsx +++ b/src/engine/forms/ui_detector_artefact.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_game_ahunt.tsx b/src/engine/forms/ui_game_ahunt.tsx index a6b1eeac4..5bb0f4575 100644 --- a/src/engine/forms/ui_game_ahunt.tsx +++ b/src/engine/forms/ui_game_ahunt.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_game_ahunt_16.tsx b/src/engine/forms/ui_game_ahunt_16.tsx index f8b3cc7ef..707204da2 100644 --- a/src/engine/forms/ui_game_ahunt_16.tsx +++ b/src/engine/forms/ui_game_ahunt_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_game_cta.tsx b/src/engine/forms/ui_game_cta.tsx index a6b1eeac4..5bb0f4575 100644 --- a/src/engine/forms/ui_game_cta.tsx +++ b/src/engine/forms/ui_game_cta.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_game_cta_16.tsx b/src/engine/forms/ui_game_cta_16.tsx index f8b3cc7ef..707204da2 100644 --- a/src/engine/forms/ui_game_cta_16.tsx +++ b/src/engine/forms/ui_game_cta_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_game_dm.tsx b/src/engine/forms/ui_game_dm.tsx index 6390599ca..399ba3b40 100644 --- a/src/engine/forms/ui_game_dm.tsx +++ b/src/engine/forms/ui_game_dm.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_game_dm_16.tsx b/src/engine/forms/ui_game_dm_16.tsx index ddc3d1369..311678268 100644 --- a/src/engine/forms/ui_game_dm_16.tsx +++ b/src/engine/forms/ui_game_dm_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_game_over.tsx b/src/engine/forms/ui_game_over.tsx index 667102e62..193426d3c 100644 --- a/src/engine/forms/ui_game_over.tsx +++ b/src/engine/forms/ui_game_over.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_game_tdm.tsx b/src/engine/forms/ui_game_tdm.tsx index 996539c60..b87b201d9 100644 --- a/src/engine/forms/ui_game_tdm.tsx +++ b/src/engine/forms/ui_game_tdm.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_game_tdm_16.tsx b/src/engine/forms/ui_game_tdm_16.tsx index a89c78571..8f61b38ee 100644 --- a/src/engine/forms/ui_game_tdm_16.tsx +++ b/src/engine/forms/ui_game_tdm_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_keybinding.tsx b/src/engine/forms/ui_keybinding.tsx index b2e067533..f2efab169 100644 --- a/src/engine/forms/ui_keybinding.tsx +++ b/src/engine/forms/ui_keybinding.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_keybinding_gamepad.tsx b/src/engine/forms/ui_keybinding_gamepad.tsx index 88f35c3b2..31bade789 100644 --- a/src/engine/forms/ui_keybinding_gamepad.tsx +++ b/src/engine/forms/ui_keybinding_gamepad.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_mapinfo.tsx b/src/engine/forms/ui_mapinfo.tsx index f84be6925..a82bb610d 100644 --- a/src/engine/forms/ui_mapinfo.tsx +++ b/src/engine/forms/ui_mapinfo.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_mm_loading_screen.tsx b/src/engine/forms/ui_mm_loading_screen.tsx index f3b60f210..60da6f98f 100644 --- a/src/engine/forms/ui_mm_loading_screen.tsx +++ b/src/engine/forms/ui_mm_loading_screen.tsx @@ -2,6 +2,9 @@ import { JSXNode, JSXXML } from "jsx-xml"; import { textures } from "@/engine/lib/constants/textures"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_mm_loading_screen_16.tsx b/src/engine/forms/ui_mm_loading_screen_16.tsx index 5f11f14ec..015a093d2 100644 --- a/src/engine/forms/ui_mm_loading_screen_16.tsx +++ b/src/engine/forms/ui_mm_loading_screen_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_mm_versions_dlg.tsx b/src/engine/forms/ui_mm_versions_dlg.tsx index d36da1559..82563c99d 100644 --- a/src/engine/forms/ui_mm_versions_dlg.tsx +++ b/src/engine/forms/ui_mm_versions_dlg.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_mm_versions_dlg_16.tsx b/src/engine/forms/ui_mm_versions_dlg_16.tsx index c09ff5be0..4d2759bad 100644 --- a/src/engine/forms/ui_mm_versions_dlg_16.tsx +++ b/src/engine/forms/ui_mm_versions_dlg_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_numpad_wnd.tsx b/src/engine/forms/ui_numpad_wnd.tsx index cf20316c9..46e3f9802 100644 --- a/src/engine/forms/ui_numpad_wnd.tsx +++ b/src/engine/forms/ui_numpad_wnd.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_spawn_dlg.tsx b/src/engine/forms/ui_spawn_dlg.tsx index 55aba6787..90bbd9106 100644 --- a/src/engine/forms/ui_spawn_dlg.tsx +++ b/src/engine/forms/ui_spawn_dlg.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_team_panels_ahunt.tsx b/src/engine/forms/ui_team_panels_ahunt.tsx index 1152ac263..f55dab304 100644 --- a/src/engine/forms/ui_team_panels_ahunt.tsx +++ b/src/engine/forms/ui_team_panels_ahunt.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_team_panels_ahunt_16.tsx b/src/engine/forms/ui_team_panels_ahunt_16.tsx index 26119790e..a292046a1 100644 --- a/src/engine/forms/ui_team_panels_ahunt_16.tsx +++ b/src/engine/forms/ui_team_panels_ahunt_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_team_panels_cta.tsx b/src/engine/forms/ui_team_panels_cta.tsx index 1152ac263..f55dab304 100644 --- a/src/engine/forms/ui_team_panels_cta.tsx +++ b/src/engine/forms/ui_team_panels_cta.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_team_panels_cta_16.tsx b/src/engine/forms/ui_team_panels_cta_16.tsx index 26119790e..a292046a1 100644 --- a/src/engine/forms/ui_team_panels_cta_16.tsx +++ b/src/engine/forms/ui_team_panels_cta_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_team_panels_dm.tsx b/src/engine/forms/ui_team_panels_dm.tsx index 0e559aef2..315c8d025 100644 --- a/src/engine/forms/ui_team_panels_dm.tsx +++ b/src/engine/forms/ui_team_panels_dm.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_team_panels_dm_16.tsx b/src/engine/forms/ui_team_panels_dm_16.tsx index 012d9aa50..a40799c82 100644 --- a/src/engine/forms/ui_team_panels_dm_16.tsx +++ b/src/engine/forms/ui_team_panels_dm_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_team_panels_tdm.tsx b/src/engine/forms/ui_team_panels_tdm.tsx index b9876a8fb..aab688635 100644 --- a/src/engine/forms/ui_team_panels_tdm.tsx +++ b/src/engine/forms/ui_team_panels_tdm.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/ui_team_panels_tdm_16.tsx b/src/engine/forms/ui_team_panels_tdm_16.tsx index d48b664c5..3303fd170 100644 --- a/src/engine/forms/ui_team_panels_tdm_16.tsx +++ b/src/engine/forms/ui_team_panels_tdm_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/video_templ.tsx b/src/engine/forms/video_templ.tsx index a2212118d..475d34312 100644 --- a/src/engine/forms/video_templ.tsx +++ b/src/engine/forms/video_templ.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/voting_category.tsx b/src/engine/forms/voting_category.tsx index aae3b3d80..36f32df60 100644 --- a/src/engine/forms/voting_category.tsx +++ b/src/engine/forms/voting_category.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/voting_category_16.tsx b/src/engine/forms/voting_category_16.tsx index 14069d454..63d06ff62 100644 --- a/src/engine/forms/voting_category_16.tsx +++ b/src/engine/forms/voting_category_16.tsx @@ -1,5 +1,8 @@ import { JSXNode, JSXXML } from "jsx-xml"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/zone_map.tsx b/src/engine/forms/zone_map.tsx index 61e7bc21d..b96d004e1 100644 --- a/src/engine/forms/zone_map.tsx +++ b/src/engine/forms/zone_map.tsx @@ -4,6 +4,9 @@ import { XrText } from "@/engine/forms/components/base"; import { XrTexture } from "@/engine/forms/components/base/XrTexture.component"; import { fonts } from "@/engine/lib/constants/fonts"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/engine/forms/zone_map_16.tsx b/src/engine/forms/zone_map_16.tsx index 6eac346eb..24b0af190 100644 --- a/src/engine/forms/zone_map_16.tsx +++ b/src/engine/forms/zone_map_16.tsx @@ -4,6 +4,9 @@ import { XrText } from "@/engine/forms/components/base"; import { XrTexture } from "@/engine/forms/components/base/XrTexture.component"; import { fonts } from "@/engine/lib/constants/fonts"; +/** + * todo; + */ export function create(): JSXNode { return ( diff --git a/src/fixtures/lua/mocks/lua_globals.mocks.ts b/src/fixtures/lua/mocks/lua_globals.mocks.ts index 360b2370f..c384188fd 100644 --- a/src/fixtures/lua/mocks/lua_globals.mocks.ts +++ b/src/fixtures/lua/mocks/lua_globals.mocks.ts @@ -10,6 +10,9 @@ import { mockToString } from "@/fixtures/lua/mocks/lua_tostring.mock"; import { mockType } from "@/fixtures/lua/mocks/lua_type.mock"; import { MockLuaTable } from "@/fixtures/lua/mocks/LuaTable.mock"; +/** + * Mock lua globals in node testing environment. + */ export function mockLuaGlobals(): void { // @ts-ignore global._G = global; diff --git a/src/fixtures/xray/mocks/actions/action_base.mock.ts b/src/fixtures/xray/mocks/actions/action_base.mock.ts index eb66a53fb..f237e2e68 100644 --- a/src/fixtures/xray/mocks/actions/action_base.mock.ts +++ b/src/fixtures/xray/mocks/actions/action_base.mock.ts @@ -44,6 +44,9 @@ export class MockActionBase extends MockLuabindClass { } } +/** + * Mock action base method. + */ export function mockActionBase(object: Optional = null, name: string = "generic"): ActionBase { return new MockActionBase(object, name) as unknown as ActionBase; } diff --git a/src/typedefs/xray16 b/src/typedefs/xray16 index 47d6923c4..7a8856eb0 160000 --- a/src/typedefs/xray16 +++ b/src/typedefs/xray16 @@ -1 +1 @@ -Subproject commit 47d6923c42953d64ed6699f4921dcc43cd8d591c +Subproject commit 7a8856eb0db35854464009ac2640a7318e9f3173