diff --git a/src/.decls/cn/base/tools.d.ts b/src/.decls/cn/base/tools.d.ts index 7d49eba..7406ce3 100644 --- a/src/.decls/cn/base/tools.d.ts +++ b/src/.decls/cn/base/tools.d.ts @@ -211,8 +211,8 @@ type common_event_sstp_content_t = { [key: string]: string | undefined }; /** + * SSTP的已记录于文档的命令名称的枚举类型 * @enum {string} documented_sstp_command_name_t - * @description SSTP的已记录于文档的命令名称的枚举类型 */ declare enum documented_sstp_command_name_t { /** diff --git a/src/.decls/cn/types/fmo_info_t.d.ts b/src/.decls/cn/types/fmo_info_t.d.ts index f7f1676..bd5b3f7 100644 --- a/src/.decls/cn/types/fmo_info_t.d.ts +++ b/src/.decls/cn/types/fmo_info_t.d.ts @@ -22,57 +22,57 @@ import type { info_object } from "./info_object.d.ts"; */ declare interface single_fmo_info_t extends info_object { /** - * @description 正在运行的基础软件根文件夹的完整路径 + * 正在运行的基础软件根文件夹的完整路径 * @example E:\ssp\ */ path: string; /** - * @description 主窗口的窗口句柄 + * 主窗口的窗口句柄 * @example 918820 */ hwnd: string; /** - * @description descript.txt的sakura.name + * descript.txt的sakura.name * @example 橘花 */ name: string; /** - * @description descript.txt的kero.name + * descript.txt的kero.name * @example 斗和 */ keroname: string; /** - * @description \0侧当前显示的surface ID + * \0侧当前显示的surface ID * @example 0 */ "sakura.surface": string; /** - * @description \1侧当前显示的surface ID + * \1侧当前显示的surface ID * @example 10 */ "kero.surface": string; /** - * @description \1侧窗口的窗口句柄 + * \1侧窗口的窗口句柄 * @example 67008 */ kerohwnd: string; /** - * @description 当前使用的窗口句柄的逗号分隔列表 + * 当前使用的窗口句柄的逗号分隔列表 * @example 918820,67008 */ hwndlist: string; /** - * @description 正在运行的ghost的完整路径 + * 正在运行的ghost的完整路径 * @example E:\ssp\ghost\Taromati2\ */ ghostpath: string; /** - * @description 正在运行的ghost的descript.txt的name + * 正在运行的ghost的descript.txt的name * @example Taromati2 */ fullname: string; /** - * @description 正在运行的ghost的模块状态 + * 正在运行的ghost的模块状态 * @example shiori:running,makoto-ghost:running */ modulestate: string; @@ -96,30 +96,30 @@ declare class fmo_info_t extends base_sstp_info_t { */ /*@__PURE__*/constructor(fmo_text: String); /** + * 获取具有指定属性且属性值为指定值的fmo的uuid * @param {String} name 要检查的属性名 * @param {String} value 期望的属性值 * @returns {String|undefined} 对应的uuid(如果有的话) - * @description 获取具有指定属性且属性值为指定值的fmo的uuid * @example * let kikka_uuid = fmo_info.get_uuid_by("name", "橘花"); * @description 等价于`this.uuids.find(uuid => this[uuid][name] == value)` */ /*@__PURE__*/get_uuid_by(name: String, value: String): String | undefined; /** + * 获取所有指定属性的值 * @param {String} name * @returns {Array} - * @description 获取所有指定属性的值 * @example * let ghost_list = fmo_info.get_list_of("name"); * @description 等价于`this.uuids.map(uuid => this[uuid][name])` */ /*@__PURE__*/get_list_of(name: String): Array; /** - * @description 获取所有uuid + * 获取所有uuid */ /*@__PURE__*/get uuids(): Array; /** - * @description 判断fmo是否有效 + * 判断fmo是否有效 */ /*@__PURE__*/get available(): Boolean; /** diff --git a/src/.decls/cn/types/info_object.d.ts b/src/.decls/cn/types/info_object.d.ts index e633450..6145a2d 100644 --- a/src/.decls/cn/types/info_object.d.ts +++ b/src/.decls/cn/types/info_object.d.ts @@ -3,43 +3,43 @@ */ declare class info_object { /** - * @description 获取所有key的数组 + * 获取所有key的数组 */ /*@__PURE__*/get keys(): key_T[]; /** - * @description 获取所有value的数组 + * 获取所有value的数组 */ /*@__PURE__*/get values(): value_T[]; /** - * @description 获取所有key-value对的数组 + * 获取所有key-value对的数组 */ /*@__PURE__*/get entries(): [key_T, value_T][]; /** - * @description 获取成员数量 + * 获取成员数量 */ /*@__PURE__*/get length(): number; /** - * @description 对每个key-value对执行某个函数 + * 对每个key-value对执行某个函数 * @param {(value,key?)} func 要执行的函数,若返回值不为undefined,则会替换原value */ /*@__PURE__*/forEach(func: (value: value_T, key?: key_T) => value_T | undefined): void; /** - * @description 复制一个新的对象 + * 复制一个新的对象 * @returns {info_object} 复制的对象 */ /*@__PURE__*/get trivial_clone(): info_object; /** - * @description 遍历自身和子对象并返回一个由遍历结果构成的一维数组 + * 遍历自身和子对象并返回一个由遍历结果构成的一维数组 * @param {(dimensions[...],value):any} func 要执行的函数,返回值将被添加到数组中 */ /*@__PURE__*/flat_map(func: (...dimensions_with_value_in_last: [...key_T[], value_T]) => T): T[]; /** - * @description 遍历自身并返回一个由遍历结果构成的一维数组 + * 遍历自身并返回一个由遍历结果构成的一维数组 * @param {(value,key?):any} func 要执行的函数,返回值将被添加到数组中 */ /*@__PURE__*/map(func: (value: value_T, key?: key_T) => T): T[]; /** - * @description 对自身按照数组追加元素 + * 对自身按照数组追加元素 * @param {[undefined|[key_T,value_T]]} array 要追加的数组 */ /*@__PURE__*/push(array: [undefined | [key_T, value_T]]): void; diff --git a/src/.decls/en/base/tools.d.ts b/src/.decls/en/base/tools.d.ts index 7b5f4df..bc407e4 100644 --- a/src/.decls/en/base/tools.d.ts +++ b/src/.decls/en/base/tools.d.ts @@ -211,8 +211,8 @@ type common_event_sstp_content_t = { [key: string]: string | undefined }; /** + * An enumeration of the documented SSTP commands. * @enum {string} documented_sstp_command_name_t - * @description An enumeration of the documented SSTP commands. */ declare enum documented_sstp_command_name_t { /** diff --git a/src/.decls/en/types/fmo_info_t.d.ts b/src/.decls/en/types/fmo_info_t.d.ts index c10498c..90ca78c 100644 --- a/src/.decls/en/types/fmo_info_t.d.ts +++ b/src/.decls/en/types/fmo_info_t.d.ts @@ -22,57 +22,57 @@ import type { info_object } from "./info_object.d.ts"; */ declare interface single_fmo_info_t extends info_object { /** - * @description Full path to the root folder of the running baseware + * Full path to the root folder of the running baseware * @example E:\ssp\ */ path: string; /** - * @description Window handle of the main window + * Window handle of the main window * @example 918820 */ hwnd: string; /** - * @description sakura.name in descript.txt + * sakura.name in descript.txt * @example 橘花 */ name: string; /** - * @description kero.name in descript.txt + * kero.name in descript.txt * @example 斗和 */ keroname: string; /** - * @description Surface ID currently displayed on the \0 side + * Surface ID currently displayed on the \0 side * @example 0 */ "sakura.surface": string; /** - * @description Surface ID currently displayed on the \1 side + * Surface ID currently displayed on the \1 side * @example 10 */ "kero.surface": string; /** - * @description Window handle of the \1 side window + * Window handle of the \1 side window * @example 67008 */ kerohwnd: string; /** - * @description Comma-separated list of currently used window handles + * Comma-separated list of currently used window handles * @example 918820,67008 */ hwndlist: string; /** - * @description Full path to the running ghost + * Full path to the running ghost * @example E:\ssp\ghost\Taromati2\ */ ghostpath: string; /** - * @description Name in the running ghost's descript.txt + * Name in the running ghost's descript.txt * @example Taromati2 */ fullname: string; /** - * @description Module status of the running ghost + * Module status of the running ghost * @example shiori:running,makoto-ghost:running */ modulestate: string; @@ -96,30 +96,30 @@ declare class fmo_info_t extends base_sstp_info_t { */ /*@__PURE__*/constructor(fmo_text: String); /** + * Get the uuid of the fmo with the specified attribute and the value of the attribute is the specified value * @param {String} name The name of the property to be checked. * @param {String} value The value of the property to be checked. * @returns {String|undefined} corresponding uuid (if any) - * @description Get the uuid of the fmo with the specified attribute and the value of the attribute is the specified value * @example * let kikka_uuid = fmo_info.get_uuid_by("name", "橘花"); * @description Equivalent to `this.uuids.find(uuid => this[uuid][name] == value)` */ /*@__PURE__*/get_uuid_by(name: String, value: String): String | undefined; /** + * Gets the values of all the specified properties * @param {String} name * @returns {Array} - * @description Gets the values of all the specified properties * @example * let ghost_list = fmo_info.get_list_of("name"); * @description Equivalent to `this.uuids.map(uuid => this[uuid][name])` */ /*@__PURE__*/get_list_of(name: String): Array; /** - * @description Get all uuids + * Get all uuids */ /*@__PURE__*/get uuids(): Array; /** - * @description Determining whether fmo is valid + * Determining whether fmo is valid */ /*@__PURE__*/get available(): Boolean; /** diff --git a/src/.decls/en/types/info_object.d.ts b/src/.decls/en/types/info_object.d.ts index c1384b6..b36dedf 100644 --- a/src/.decls/en/types/info_object.d.ts +++ b/src/.decls/en/types/info_object.d.ts @@ -3,43 +3,43 @@ */ declare class info_object { /** - * @description Get an array of all keys + * Get an array of all keys */ /*@__PURE__*/get keys(): key_T[]; /** - * @description Get an array of all values + * Get an array of all values */ /*@__PURE__*/get values(): value_T[]; /** - * @description Get an array of all key-value pairs. + * Get an array of all key-value pairs. */ /*@__PURE__*/get entries(): [key_T, value_T][]; /** - * @description Get the number of members + * Get the number of members */ /*@__PURE__*/get length(): number; /** - * @description Execute a function for each key-value pair. + * Execute a function for each key-value pair. * @param {(value,key?)} func A function to be executed that replaces value if the return value is not undefined. */ /*@__PURE__*/forEach(func: (value: value_T, key?: key_T) => value_T | undefined): void; /** - * @description Copy a new object + * Copy a new object * @returns {info_object} Copied object */ /*@__PURE__*/get trivial_clone(): info_object; /** - * @description Traverses itself and its children and returns a one-dimensional array of traversal results. + * Traverses itself and its children and returns a one-dimensional array of traversal results. * @param {(dimensions[...] ,value):any} func Function to execute, the return value will be added to the array. */ /*@__PURE__*/flat_map(func: (...dimensions_with_value_in_last: [...key_T[], value_T]) => T): T[]; /** - * @description Traverses itself and returns a one-dimensional array of traversal results. + * Traverses itself and returns a one-dimensional array of traversal results. * @param {(value,key?):any} func Function to execute, the return value will be added to the array. */ /*@__PURE__*/map(func: (value: value_T, key?: key_T) => T): T[]; /** - * @description Append elements to itself as an array. + * Append elements to itself as an array. * @param {[undefined|[key_T,value_T]]} array Array to append to. */ /*@__PURE__*/push(array: [undefined | [key_T, value_T]]): void; diff --git a/src/.decls/jp/base/tools.d.ts b/src/.decls/jp/base/tools.d.ts index 5dfb816..d31e70c 100644 --- a/src/.decls/jp/base/tools.d.ts +++ b/src/.decls/jp/base/tools.d.ts @@ -211,8 +211,8 @@ type common_event_sstp_content_t = { [key: string]: string | undefined }; /** + * SSTPの文書化されたコマンドの列挙型 * @enum {string} documented_sstp_command_name_t - * @description SSTPの文書化されたコマンドの列挙型 */ declare enum documented_sstp_command_name_t { /** diff --git a/src/.decls/jp/types/fmo_info_t.d.ts b/src/.decls/jp/types/fmo_info_t.d.ts index ac87fd5..ffc297b 100644 --- a/src/.decls/jp/types/fmo_info_t.d.ts +++ b/src/.decls/jp/types/fmo_info_t.d.ts @@ -22,57 +22,57 @@ import type { info_object } from "./info_object.d.ts"; */ declare interface single_fmo_info_t extends info_object { /** - * @description 実行中のベースウェアのルートフォルダへのフルパス + * 実行中のベースウェアのルートフォルダへのフルパス * @example E:\ssp\ */ path: string; /** - * @description \0側のウィンドウハンドル + * \0側のウィンドウハンドル * @example 918820 */ hwnd: string; /** - * @description descript.txtのsakura.name + * descript.txtのsakura.name * @example 橘花 */ name: string; /** - * @description descript.txtのkero.name + * descript.txtのkero.name * @example 斗和 */ keroname: string; /** - * @description \0側に表示されているサーフェスID + * \0側に表示されているサーフェスID * @example 0 */ "sakura.surface": string; /** - * @description \1側に表示されているサーフェスID + * \1側に表示されているサーフェスID * @example 10 */ "kero.surface": string; /** - * @description \1側のウィンドウのハンドル + * \1側のウィンドウのハンドル * @example 67008 */ kerohwnd: string; /** - * @description 現在使用されているウィンドウハンドルのカンマ区切りリスト + * 現在使用されているウィンドウハンドルのカンマ区切りリスト * @example 918820,67008 */ hwndlist: string; /** - * @description 実行中のゴーストへのフルパス + * 実行中のゴーストへのフルパス * @example E:\ssp\ghost\Taromati2\ */ ghostpath: string; /** - * @description 実行中のゴーストのdescript.txtの名前 + * 実行中のゴーストのdescript.txtの名前 * @example Taromati2 */ fullname: string; /** - * @description 実行中のゴーストのモジュール状態 + * 実行中のゴーストのモジュール状態 * @example shiori:running,makoto-ghost:running */ modulestate: string; @@ -96,30 +96,30 @@ declare class fmo_info_t extends base_sstp_info_t { */ /*@__PURE__*/constructor(fmo_text: String); /** + * 指定された属性を持ち、その属性の値が指定された値であるfmoのuuidを取得する。 * @param {String} name チェックするプロパティの名前 * @param {String} value 望ましい属性値 * @returns {String|undefined} 対応するuuid(もしあれば) - * @description 指定された属性を持ち、その属性の値が指定された値であるfmoのuuidを取得する。 * @example * let kikka_uuid = fmo_info.get_uuid_by("name", "橘花"); * @description `this.uuids.find(uuid => this[uuid][name] == value)`に相当する。 */ /*@__PURE__*/get_uuid_by(name: String, value: String): String | undefined; /** + * 指定されたすべてのプロパティの値を取得する * @param {String} name * @returns {Array} - * @description 指定されたすべてのプロパティの値を取得する * @example * let ghost_list = fmo_info.get_list_of("name"); * @description `this.uuids.map(uuid=>this[uuid][name])`に相当する。 */ /*@__PURE__*/get_list_of(name: String): Array; /** - * @description すべてのuuidsを取得する + * すべてのuuidsを取得する */ /*@__PURE__*/get uuids(): Array; /** - * @description fmoが有効かどうかの判断 + * fmoが有効かどうかの判断 */ /*@__PURE__*/get available(): Boolean; /** diff --git a/src/.decls/jp/types/info_object.d.ts b/src/.decls/jp/types/info_object.d.ts index 96fe685..51830d1 100644 --- a/src/.decls/jp/types/info_object.d.ts +++ b/src/.decls/jp/types/info_object.d.ts @@ -3,43 +3,43 @@ */ declare class info_object { /** - * @description すべてのキーの配列を取得する + * すべてのキーの配列を取得する */ /*@__PURE__*/get keys(): key_T[]; /** - * @description すべての値の配列を取得する + * すべての値の配列を取得する */ /*@__PURE__*/get values(): value_T[]; /** - * @description すべてのキーと値のペアの配列を取得します。 + * すべてのキーと値のペアの配列を取得します。 */ /*@__PURE__*/get entries(): [key_T, value_T][]; /** - * @description 会員数の取得 + * 会員数の取得 */ /*@__PURE__*/get length(): number; /** - * @description キーと値のペアごとに関数を実行する。 + * キーと値のペアごとに関数を実行する。 * @param {(value,key?)} func 戻り値が未定義でない場合に、元の値を置き換えるために実行される関数。 */ /*@__PURE__*/forEach(func: (value: value_T, key?: key_T) => value_T | undefined): void; /** - * @description 新しいオブジェクトをコピーします。 + * 新しいオブジェクトをコピーします。 * @returns {info_object} コピーされたオブジェクト */ /*@__PURE__*/get trivial_clone(): info_object; /** - * @description 自分自身とその子をトラバースし、トラバース結果の1次元配列を返す。 + * 自分自身とその子をトラバースし、トラバース結果の1次元配列を返す。 * @param {(dimensions[...] ,value):any} func 関数を実行し、戻り値を配列に追加します。 */ /*@__PURE__*/flat_map(func: (...dimensions_with_value_in_last: [...key_T[], value_T]) => T): T[]; /** - * @description 自分自身をトラバースし、トラバース結果の1次元配列を返す。 + * 自分自身をトラバースし、トラバース結果の1次元配列を返す。 * @param {(value,key?):any} func 関数を実行し、戻り値を配列に追加します。 */ /*@__PURE__*/map(func: (value: value_T, key?: key_T) => T): T[]; /** - * @description 要素を配列として自分自身に追加する。 + * 要素を配列として自分自身に追加する。 * @param {[undefined|[key_T,value_T]]} array 追加する配列。 */ /*@__PURE__*/push(array: [undefined | [key_T, value_T]]): void; diff --git a/src/types/fmo_info_t.mjs b/src/types/fmo_info_t.mjs index e56b938..9676655 100644 --- a/src/types/fmo_info_t.mjs +++ b/src/types/fmo_info_t.mjs @@ -38,10 +38,10 @@ class fmo_info_t extends base_sstp_info_t { } } /** + * 获取具有指定属性且属性值为指定值的fmo的uuid * @param {String} name 要检查的属性名 * @param {String} value 期望的属性值 * @returns {String|undefined} 对应的uuid(如果有的话) - * @description 获取具有指定属性且属性值为指定值的fmo的uuid * @example * let kikka_uuid = fmo_info.get_uuid_by("name", "橘花"); * @description 等价于`this.uuids.find(uuid => this[uuid][name] == value)` @@ -50,9 +50,9 @@ class fmo_info_t extends base_sstp_info_t { return this.uuids.find(uuid => this[uuid][name] == value) } /** + * 获取所有指定属性的值 * @param {String} name * @returns {Array} - * @description 获取所有指定属性的值 * @example * let ghost_list = fmo_info.get_list_of("name"); * @description 等价于`this.uuids.map(uuid => this[uuid][name])` @@ -61,11 +61,11 @@ class fmo_info_t extends base_sstp_info_t { return this.uuids.map(uuid => this[uuid][name]) } /** - * @description 获取所有uuid + * 获取所有uuid */ /*@__PURE__*/get uuids() { return this.keys } /** - * @description 判断fmo是否有效 + * 判断fmo是否有效 */ /*@__PURE__*/get available() { return !!this.length } /** diff --git a/src/types/info_object.mjs b/src/types/info_object.mjs index d80e80b..e32891a 100644 --- a/src/types/info_object.mjs +++ b/src/types/info_object.mjs @@ -10,30 +10,30 @@ import { */ class info_object { /** - * @description 构造函数 + * 构造函数 * @param {Object} base_value */ constructor(base_value) { Object.assign(this, base_value) } /** - * @description 获取所有key的数组 + * 获取所有key的数组 */ /*@__PURE__*/get keys() { return Object.keys(this) } /** - * @description 获取所有value的数组 + * 获取所有value的数组 */ /*@__PURE__*/get values() { return Object.values(this) } /** - * @description 获取所有key-value对的数组 + * 获取所有key-value对的数组 */ /*@__PURE__*/get entries() { return Object.entries(this) } /** - * @description 获取成员数量 + * 获取成员数量 */ /*@__PURE__*/get length() { return this.keys.length } /** - * @description 对每个key-value对执行某个函数 + * 对每个key-value对执行某个函数 * @param {(value,key?)} func 要执行的函数 */ /*@__PURE__*/forEach(func) { @@ -42,14 +42,14 @@ class info_object { }) } /** - * @description 复制一个新的对象 + * 复制一个新的对象 * @returns {info_object} 复制的对象 */ /*@__PURE__*/get trivial_clone() { return assign(new_object(), this) } /** - * @description 遍历自身和子对象并返回一个由遍历结果构成的一维数组 + * 遍历自身和子对象并返回一个由遍历结果构成的一维数组 * @param {(dimensions[...],value):any} func 要执行的函数,返回值将被添加到数组中 */ /*@__PURE__*/flat_map(func) { @@ -64,14 +64,14 @@ class info_object { return result } /** - * @description 遍历自身并返回一个由遍历结果构成的一维数组 + * 遍历自身并返回一个由遍历结果构成的一维数组 * @param {(value,key?):any} func 要执行的函数,返回值将被添加到数组中 */ /*@__PURE__*/map(func) { return this.entries.map(([key, value]) => func(value, key)) } /** - * @description 对自身按照数组追加元素 + * 对自身按照数组追加元素 * @param {[undefined|[PropertyKey,any]]} array 要追加的数组 */ /*@__PURE__*/push(array) { @@ -79,7 +79,7 @@ class info_object { return this } /** - * @description 每一个key-value对都满足条件则返回true + * 每一个key-value对都满足条件则返回true * @param {(value,key?):boolean} func 要执行的函数 */ /*@__PURE__*/every(func) {