Skip to content

Commit

Permalink
file update~
Browse files Browse the repository at this point in the history
  • Loading branch information
@Taromatibot
Taromatibot committed Jun 16, 2024
1 parent a699d45 commit bd91ccb
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 75 deletions.
50 changes: 25 additions & 25 deletions dist/cn/jsstp.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/**
Expand Down Expand Up @@ -420,43 +420,43 @@ type common_give_sstp_content_t = {
*/
declare class info_object<key_T = PropertyKey, value_T = any> {
/**
* @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<key_T, value_T>;
/**
* @description 遍历自身和子对象并返回一个由遍历结果构成的一维数组
* 遍历自身和子对象并返回一个由遍历结果构成的一维数组
* @param {(dimensions[...],value):any} func 要执行的函数，返回值将被添加到数组中
*/
/*@__PURE__*/flat_map<T>(func: (...dimensions_with_value_in_last: [...key_T[], value_T]) => T): T[];
/**
* @description 遍历自身并返回一个由遍历结果构成的一维数组
* 遍历自身并返回一个由遍历结果构成的一维数组
* @param {(value,key?):any} func 要执行的函数，返回值将被添加到数组中
*/
/*@__PURE__*/map<T>(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;
Expand Down Expand Up @@ -575,57 +575,57 @@ declare class sstp_info_t extends base_sstp_info_t<string, string> {
*/
declare interface single_fmo_info_t extends info_object<string, string> {
/**
* @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;
Expand All @@ -649,30 +649,30 @@ declare class fmo_info_t extends base_sstp_info_t<string, single_fmo_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<String>}
* @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<String>;
/**
* @description 获取所有uuid
* 获取所有uuid
*/
/*@__PURE__*/get uuids(): Array<String>;
/**
* @description 判断fmo是否有效
* 判断fmo是否有效
*/
/*@__PURE__*/get available(): Boolean;
/**
Expand Down
50 changes: 25 additions & 25 deletions dist/en/jsstp.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/**
Expand Down Expand Up @@ -420,43 +420,43 @@ type common_give_sstp_content_t = {
*/
declare class info_object<key_T = PropertyKey, value_T = any> {
/**
* @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<key_T, value_T>;
/**
* @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<T>(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<T>(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;
Expand Down Expand Up @@ -576,57 +576,57 @@ declare class sstp_info_t extends base_sstp_info_t<string, string> {
*/
declare interface single_fmo_info_t extends info_object<string, string> {
/**
* @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;
Expand All @@ -650,30 +650,30 @@ declare class fmo_info_t extends base_sstp_info_t<string, single_fmo_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<String>}
* @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<String>;
/**
* @description Get all uuids
* Get all uuids
*/
/*@__PURE__*/get uuids(): Array<String>;
/**
* @description Determining whether fmo is valid
* Determining whether fmo is valid
*/
/*@__PURE__*/get available(): Boolean;
/**
Expand Down
Loading

0 comments on commit bd91ccb

Please sign in to comment.