Skip to content

Commit

Permalink
format
Browse files Browse the repository at this point in the history
  • Loading branch information
@steve02081504
steve02081504 committed Feb 29, 2024
1 parent ecae169 commit f0fc267
Show file tree
Hide file tree
Showing 11 changed files with 163 additions and 163 deletions.
96 changes: 48 additions & 48 deletions src/.decls/cn/base/tools.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ type security_level_t = "local" | "external";
/**
* SSTP 返回码
* 和 HTTP 一样，200 系列是正常接受，其他的是错误。
* 200 系列是正常接受，其他的是错误。
* 200 系列是正常接受，其他的是错误。
* @enum {number}
*/
declare enum documented_sstp_return_code_t {
Expand Down Expand Up @@ -106,7 +106,7 @@ declare enum documented_sstp_return_code_t {
/**
* SSTP 返回码
* 和 HTTP 一样，200 系列是正常接受，其他的是错误。
* 200 系列是正常接受，其他的是错误。
* 200 系列是正常接受，其他的是错误。
* @enum {number}
*/
type sstp_return_code_t = documented_sstp_return_code_t | number;
Expand All @@ -117,18 +117,18 @@ type sstp_return_code_t = documented_sstp_return_code_t | number;
type base_sstp_content_t = {
/**
* 请求的字符编码。最好出现在第一行。
* 没有特别的理由的话，推荐使用UTF-8。
* 没有特别的理由的话，推荐使用UTF-8。
*/
CharSet: string | undefined,

/**
* 表示发送者的字符串。例如“SSTP发送工具”。COMMUNICATE方法的情况下，是发送源的ghost\0名。
* 表示发送者的字符串。例如“SSTP发送工具”。COMMUNICATE方法的情况下，是发送源的ghost\0名。
*/
Sender: string | undefined,

/**
* SHIORI和SakuraScript处理时的安全级别的指定。local/external其中之一。
* DirectSSTP，或者明显是从本地来的请求（如127.0.0.1）才有效。
* DirectSSTP，或者明显是从本地来的请求（如127.0.0.1）才有效。
*/
SecurityLevel: security_level_t | undefined,

Expand All @@ -137,40 +137,40 @@ type base_sstp_content_t = {
* 用逗号分隔，可以指定多个。指定的字符串如下。
* nodescript : 禁用气球的SSTP显示（远程的SSTP无效）
* notranslate : 不进行OnTranslate或MAKOTO的翻译处理
* nobreak : 不中断当前执行中的脚本，等待它结束
* nobreak : 不中断当前执行中的脚本，等待它结束
*/
Option: string | undefined,

/**
* 所谓的“Owned SSTP”。用SHIORI uniqueid发送过来的ID或者FMO的识别ID（仅SSP）指定的话，忽略各种安全检查和锁等，把本SSTP当作ghost内部的处理和同样的优先级处理。
* SecurityLevel指定变成local，而且即使是\t等的中断禁止状态也强制地中断播放。
* SecurityLevel指定变成local，而且即使是\t等的中断禁止状态也强制地中断播放。
*/
ID: string | undefined,

/**
* NOTIFY等和ghost的通信时，直接传给SHIORI的头。
* 只进行字符编码转换等最低限的处理，（任意的字符串）的部分和内容原样中继。
* 只进行字符编码转换等最低限的处理，（任意的字符串）的部分和内容原样中继。
*/
[key: `X-SSTP-PassThru-${string}`]: string | undefined,

/**
* DirectSSTP限定，表示应该回复response的窗口句柄。
* 窗口句柄（指针相当）的数据作为无符号十进制整数处理，然后字符串化。
* 省略时是WM_COMMUNICATE的wParam。
* 省略时是WM_COMMUNICATE的wParam。
*/
HWnd: string | undefined,

/**
* (Socket)SSTP限定，表示应该发送request的ghost的\0的窗口句柄。
* 指定这个的话，固定处理的ghost，Socket经由也可以和DirectSSTP一样的处理。
* 找不到的话，用404 Not Found立即错误结束。
* 找不到的话，用404 Not Found立即错误结束。
*/
ReceiverGhostHWnd: string | undefined,

/**
* (Socket)SSTP限定，表示应该发送request的ghost的\0名。
* 指定这个的话，固定处理的ghost，Socket经由也可以和DirectSSTP一样的处理。HWnd的名字版。
* 找不到的话，用404 Not Found立即错误结束。
* 找不到的话，用404 Not Found立即错误结束。
*/
ReceiverGhostName: string | undefined,

Expand All @@ -197,14 +197,14 @@ type common_event_sstp_content_t = {
* 如果省略内容，将为任何 ghost 播放相同的 Script 标头。
* 如果启用了 SSTP ghost激活选项，则此处指定的ghost将被临时激活。
* 由于js的语言限制，这里只能指定一个ghost。
* 需要使用多个 IfGhost 时，考虑使用{@link jsstp_t.row_send}发送SSTP消息
* 需要使用多个 IfGhost 时，考虑使用{@link jsstp_t.row_send}发送SSTP消息
*/
IfGhost: string | undefined
/**
* Sakura脚本
* 如果 Script 标头不紧跟在 IfGhost 之后，则当它与 IfGhost 不对应时，它将是默认的处理脚本。
* 由于js的语言限制，这里只能指定一个脚本。
* 需要使用多个 Script 时，考虑使用{@link jsstp_t.row_send}发送SSTP消息
* 需要使用多个 Script 时，考虑使用{@link jsstp_t.row_send}发送SSTP消息
*/
Script: string | undefined
/**
Expand All @@ -226,10 +226,10 @@ declare enum documented_sstp_command_name_t {
*/
GetNames = "GetNames",
/**
* 返回FMO，即保存正在运行的人格的状态的文件和同等的信息
* 但是，这个命令仅限于通过SSTP通信的应用程序内部的管理部分，与原本的FMO不同，它是同时运行的应用程序群共用的
* 主要用于没有窗口且不能发送Direct SSTP的控制台应用等，通过仅使用Socket SSTP和ReceiverGhostHWnd头实现Direct SSTP相当的功能
* 每行返回一个人格的信息，以空行结束
* 返回FMO，即保存正在运行的人格的状态的文件和同等的信息
* 但是，这个命令仅限于通过SSTP通信的应用程序内部的管理部分，与原本的FMO不同，它是同时运行的应用程序群共用的
* 主要用于没有窗口且不能发送Direct SSTP的控制台应用等，通过仅使用Socket SSTP和ReceiverGhostHWnd头实现Direct SSTP相当的功能
* 每行返回一个人格的信息，以空行结束
* 如果是远程请求的话，各路径信息会被省略，头和hwnd会被替换为虚拟的
*/
GetFMO = "GetFMO",
Expand Down Expand Up @@ -270,7 +270,7 @@ declare enum documented_sstp_command_name_t {
*/
GetPluginNameList = "GetPluginNameList",
/**
* 返回基础软件（运行人格的软件）的版本，以点分隔的版本号的格式
* 返回基础软件（运行人格的软件）的版本，以点分隔的版本号的格式
* 这可以和version.json的ssp.full.version等简单比较，就可以检查是否是最新版
*/
GetShortVersion = "GetShortVersion",
Expand All @@ -283,67 +283,67 @@ declare enum documented_sstp_command_name_t {
*/
Restore = "Restore",
/**
* 将指定文件夹内的文件压缩成压缩文件
* 响应会在处理结束后才返回，注意
* 参数0：压缩文件名
* 参数1：要压缩的文件夹的完整路径
* 将指定文件夹内的文件压缩成压缩文件
* 响应会在处理结束后才返回，注意
* 参数0：压缩文件名
* 参数1：要压缩的文件夹的完整路径
* 没有附加数据（状态码200系列表示成功）
*/
CompressArchive = "CompressArchive",
/**
* 将指定的压缩文件解压
* 响应会在处理结束后才返回，注意
* 参数0：压缩文件名
* 参数1：解压目标文件夹的完整路径
* 将指定的压缩文件解压
* 响应会在处理结束后才返回，注意
* 参数0：压缩文件名
* 参数1：解压目标文件夹的完整路径
* 没有附加数据（状态码200系列表示成功）
*/
ExtractArchive = "ExtractArchive",
/**
* 将合成好的表面图片输出到指定的目录。参数和\![execute,dumpsurface]相同
* 响应会在处理结束后才返回，注意
* 将合成好的表面图片输出到指定的目录。参数和\![execute,dumpsurface]相同
* 响应会在处理结束后才返回，注意
* 没有附加数据（状态码200系列表示成功）
*/
DumpSurface = "DumpSurface",
/**
* 不通过Sakura Script执行和\![moveasync]相同的事情。参数指定方法和Sakura Script版相同
* 因为不能在SSTP的超时时间内返回响应，而且会导致死锁，所以不能执行没有async的move
* 不通过Sakura Script执行和\![moveasync]相同的事情。参数指定方法和Sakura Script版相同
* 因为不能在SSTP的超时时间内返回响应，而且会导致死锁，所以不能执行没有async的move
* 没有附加数据（状态码200系列表示成功）
*/
MoveAsync = "MoveAsync",
/**
* 不通过Sakura Script执行和\![set,tasktrayicon]相同的事情。参数指定方法和Sakura Script版相同
* 不通过Sakura Script执行和\![set,tasktrayicon]相同的事情。参数指定方法和Sakura Script版相同
* 没有附加数据（状态码200系列表示成功）
*/
SetTrayIcon = "SetTrayIcon",
/**
* 不通过Sakura Script执行和\![set,trayballoon]相同的事情。参数指定方法和Sakura Script版相同
* 不通过Sakura Script执行和\![set,trayballoon]相同的事情。参数指定方法和Sakura Script版相同
* 没有附加数据（状态码200系列表示成功）
*/
SetTrayBalloon = "SetTrayBalloon",
/**
* 向属性系统写入值
* 参数0：属性的名字
* 参数1：要设置的值
* 向属性系统写入值
* 参数0：属性的名字
* 参数1：要设置的值
* 没有附加数据（状态码200系列表示成功）
*/
SetProperty = "SetProperty",
/**
* 从属性系统读出值
* 参数0：属性的名字
* 从属性系统读出值
* 参数0：属性的名字
* 附加数据是获取的属性的值
*/
GetProperty = "GetProperty",
/**
* 按Sender指定的客户端名分别保存的，通用数据保存区域写入
* 和浏览器的「Cookie」相同的用法
* 参数0：Cookie的名字
* 参数1：要设置的值
* 按Sender指定的客户端名分别保存的，通用数据保存区域写入
* 和浏览器的「Cookie」相同的用法
* 参数0：Cookie的名字
* 参数1：要设置的值
* 没有附加数据（状态码200系列表示成功）
*/
SetCookie = "SetCookie",
/**
* 按Sender指定的客户端名分别保存的，通用数据保存区域读出
* 参数0：Cookie的名字
* 按Sender指定的客户端名分别保存的，通用数据保存区域读出
* 参数0：Cookie的名字
* 附加数据是获取的Cookie的值
*/
GetCookie = "GetCookie"
Expand Down Expand Up @@ -382,13 +382,13 @@ type common_communicate_sstp_content_t = {
Sentence: string
/**
* 通信的扩展信息。
* SHIORI/3.0中存储在Reference2及以后。SSTP Reference0 = SHIORI Reference2。
* SHIORI/3.0中存储在Reference2及以后。SSTP Reference0 = SHIORI Reference2。
*/
[key: `Reference${number}`]: any
/**
* 发送源ghost的通信发送时点（≒脚本执行结束时点）的\0和\1的表情编号。
* 在OnCommunicate事件中作为Surface头传递。
* @example `5,11` //表示\0为5，\1为11
* 在OnCommunicate事件中作为Surface头传递。
* @example `5,11` //表示\0为5，\1为11
*/
Surface: string
/**
Expand All @@ -402,12 +402,12 @@ type common_communicate_sstp_content_t = {
*/
type common_give_sstp_content_t = {
/**
* 给予的文本
* 给予的文本
* 在 SHIORI/3.0 中，这与用户通信相同，并生成 OnCommunicate 事件。
*/
Document: string
/**
* 给予的歌的名字。
* 给予的歌的名字。
* 在SHIORI/3.0中，发生OnMusicPlay事件并且Reference0成为指定的字符串。
*/
Song: string
Expand Down
2 changes: 1 addition & 1 deletion src/.decls/cn/types/fmo_info_t.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ declare class fmo_info_t extends base_sstp_info_t<string, single_fmo_info_t> {
* @param {String} value 期望的属性值
* @returns {String|undefined} 对应的uuid（如果有的话）
* @description 获取具有指定属性且属性值为指定值的fmo的uuid
* @example
* @example
* let kikka_uuid = fmo_info.get_uuid_by("name", "橘花");
* @description 等价于`this.uuids.find(uuid => this[uuid][name] == value)`
*/
Expand Down
2 changes: 1 addition & 1 deletion src/.decls/cn/types/ghost_events_queryer_t.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ interface ghost_events_queryer_t {
*/
/*@__PURE__*/new(base_jsstp: jsstp_t): ghost_events_queryer_t;
/**
* 调用声明
* 调用声明
* 检查事件是否存在，ghost至少需要`Has_Event`事件的支持，并可以通过提供`Get_Supported_Events`事件来提高效率
* @param {String} event_name
* @param {security_level_t} security_level
Expand Down
8 changes: 4 additions & 4 deletions src/.decls/cn/types/jsstp_t.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -287,15 +287,15 @@ declare class jsstp_t {
/**
* 以文本发送报文并以文本接收返信
* @param {any} info 报文体（文本）
* @returns {Promise<String>} 返回一个promise
* @returns {Promise<String>} 返回一个promise
* @group Basic Send Methods
*/
row_send(info: any): Promise<String>;
/**
* 发送报文，但是不对返回结果进行处理
* @param {String} sstphead 报文头
* @param {Object} info 报文体
* @returns {Promise<String>} 返回一个promise
* @returns {Promise<String>} 返回一个promise
* @group Basic Send Methods
*/
costom_text_send(sstphead: String, info: Object): Promise<String>;
Expand Down Expand Up @@ -368,7 +368,7 @@ declare class jsstp_t {
[command_name: string]: simple_command_caller
}
/**
* 判断是否存在某个事件
* 判断是否存在某个事件
* 若可能频繁调用，使用{@link ghost_events_queryer_t}（通过{@link jsstp_t.new_event_queryer}获取）来查询
* @param {String} event_name 事件名
* @param {security_level_t} security_level 安全等级
Expand Down Expand Up @@ -398,7 +398,7 @@ declare class jsstp_t {
*/
/*@__PURE__*/has_event(event_name: String, security_level?: security_level_t): Promise<Boolean>;
/**
* 以约定好的结构获取支持的事件，需要ghost支持`Get_Supported_Events`事件
* 以约定好的结构获取支持的事件，需要ghost支持`Get_Supported_Events`事件
* 若不确定ghost的支持情况，使用{@link ghost_events_queryer_t}（通过{@link jsstp_t.new_event_queryer}获取）来查询
* @returns {Promise<{local:string[],external:string[]}>} 包含local和external两个数组的Object
* @example
Expand Down
Loading

0 comments on commit f0fc267

Please sign in to comment.