接口文件

注意

本章节内容为 NeoBot 脚本开发的接口文件说明，适用于有一定编程基础的用户。如您是初次使用 NeoBot，建议先阅读快速开始。

提示

已注释大部分接口和方法的功能说明，方便开发者理解和使用。如有任何疑问或建议，欢迎加入官方交流群进行交流。

QQ 事件接口

QQEvent

interface

基础 QQ 事件接口，定义了所有 QQ 事件的通用属性和方法

参数

getSelfId() => number必需获取机器人自身 ID

getTime() => number必需获取事件发生时间戳

示例

定义了 QQ 事件的基础接口，包含获取机器人 ID 和事件时间戳的方法

1declare interface QQEvent {

2 getSelfId(): number;

3 getTime(): number;

4}

GroupMessageEvent

interface

群消息事件接口，继承自 QQEvent，用于处理群聊消息

参数

getGroupId() => number必需获取群组 ID

getMessageId() => number必需获取消息 ID

getSenderId() => number必需获取发送者 ID

getRawMessage() => string必需获取原始消息内容

getJsonMessage() => string必需获取 JSON 格式消息内容

示例

注册群消息事件监听器，解析消息内容并输出群号和消息

1qq.register("GroupMessageEvent", (event) => {

2 const jsonMessage = event.getJsonMessage()

3 const newMessage = scriptManager.callJsMethod("util.parseTextJsonMessage", jsonMessage)

4 console.log("群 " + event.getGroupId() + " 收到消息: " + newMessage)

5})

FriendAddEvent

interface

好友添加事件接口，用于处理好友添加请求

参数

getUserId() => number必需获取用户 ID

示例

监听好友添加事件，输出添加好友的用户 ID

1qq.register("FriendAddEvent", (event) => {

2 console.log("收到好友添加请求: " + event.getUserId())

3})

GroupDecreaseEvent

interface

群成员减少事件接口，用于处理成员退群或被踢

参数

getUserId() => number必需获取用户 ID

getOperatorId() => number必需获取操作者 ID

getGroupId() => number必需获取群组 ID

示例

监听群成员减少事件，输出离开群的用户 ID 和群号

1qq.register("GroupDecreaseEvent", (event) => {

2 console.log("用户 " + event.getUserId() + " 离开群 " + event.getGroupId())

3})

GroupIncreaseEvent

interface

群成员增加事件接口，用于处理成员加群

参数

getUserId() => number必需获取用户 ID

getOperatorId() => number必需获取操作者 ID

getGroupId() => number必需获取群组 ID

示例

监听群成员增加事件，输出加入群的用户 ID 和群号

1qq.register("GroupIncreaseEvent", (event) => {

2 console.log("用户 " + event.getUserId() + " 加入群 " + event.getGroupId())

3})

PokeEvent

interface

戳一戳事件接口，用于处理群内戳一戳互动

参数

getUserId() => number必需获取发起戳一戳的用户 ID

getGroupId() => number必需获取群组 ID

getTargetId() => number必需获取被戳的用户 ID

示例

监听戳一戳事件，输出发起者和被戳者的用户 ID

1qq.register("PokeEvent", (event) => {

2 console.log("用户 " + event.getUserId() + " 戳了用户 " + event.getTargetId())

3})

FriendRequestEvent

interface

好友请求事件接口，用于处理好友添加请求

参数

getUserId() => number必需获取请求添加好友的用户 ID

getComment() => string必需获取验证消息

getFlag() => string必需获取请求标识，用于处理请求

示例

监听好友请求事件，输出请求者 ID 和验证消息

1qq.register("FriendRequestEvent", (event) => {

2 console.log("收到好友请求: " + event.getUserId() + ", 验证消息: " + event.getComment())

3})

GroupRequestEvent

interface

群请求事件接口，用于处理加群请求

参数

getUserId() => number必需获取请求加群的用户 ID

getGroupId() => number必需获取群组 ID

getComment() => string必需获取验证消息

getFlag() => string必需获取请求标识，用于处理请求

示例

监听加群请求事件，输出请求者 ID、群号和验证消息

1qq.register("GroupRequestEvent", (event) => {

2 console.log("收到加群请求: " + event.getUserId() + ", 群: " + event.getGroupId() + ", 验证消息: " + event.getComment())

3})

用户信息接口

BasicInfo

interface

基础信息接口，定义用户的基本信息

参数

getUserId() => number必需获取用户 ID

getNickname() => string必需获取用户昵称

示例

创建基础信息对象，获取用户 ID 和昵称

1const userInfo: BasicInfo = {

2 getUserId: () => 123456789,

3 getNickname: () => "测试用户"

4}

5console.log("用户ID: " + userInfo.getUserId() + ", 昵称: " + userInfo.getNickname())

FriendInfo

interface

好友信息接口，继承自 BasicInfo，扩展好友特有信息

参数

getUserId() => number必需获取用户 ID

getNickname() => string必需获取用户昵称

getRemark() => string必需获取好友备注

示例

创建好友信息对象，获取好友备注信息

1const friendInfo: FriendInfo = {

2 getUserId: () => 123456789,

3 getNickname: () => "好友昵称",

4 getRemark: () => "好友备注"

5}

6console.log("好友备注: " + friendInfo.getRemark())

GroupInfo

interface

群组信息接口，提供群组相关信息

参数

getGroupId() => number必需获取群组 ID

getGroupName() => string必需获取群组名称

getGroupMemberCount() => number必需获取群成员数量

getGroupMaxMemberCount() => number必需获取群最大成员数量

示例

获取所有群组列表，并输出群名和成员数量

1qq.getGroupList((groups: GroupInfo[]) => {

2 for (const group of groups) {

3 console.log("群名: " + group.getGroupName() + ", 成员数: " + group.getGroupMemberCount() + "/" + group.getGroupMaxMemberCount())

4 }

5})

GroupMemberInfo

interface

群成员信息接口，提供群成员详细信息

参数

getGroupId() => number必需获取群组 ID

getUserId() => number必需获取用户 ID

getNickname() => string必需获取用户昵称

getCard() => string必需获取群名片

getAge() => number必需获取群龄（天数）

getArea() => string必需获取地区

getJoinTime() => number必需获取加群时间戳

getLastSentTime() => number必需获取最后发言时间戳

getLevel() => string必需获取等级

getTitle() => string必需获取头衔

getTitleExpireTime() => number必需获取头衔过期时间

getCardChangeable() => boolean必需获取是否可修改群名片

getRole() => Enum必需获取群角色

getSex() => Enum必需获取性别

示例

获取群成员信息，优先使用群名片，否则使用昵称，并输出角色信息

1qq.getGroupMemberInfo(groupId, userId, (memberInfo: GroupMemberInfo) => {

2 const name = memberInfo.getCard() || memberInfo.getNickname()

3 const role = memberInfo.getRole().toString()

4 console.log("成员: " + name + ", 角色: " + role)

5})

游戏事件接口

LoginEvent

interface

登录事件接口，用于处理玩家登录事件

参数

getName() => string必需获取玩家名称

disallow(reason: string): void必需拒绝玩家登录并显示原因

示例

监听玩家登录事件，检查白名单并拒绝非白名单玩家登录

1gameEvent.register("LoginEvent", (event: LoginEvent) => {

2 if (!isWhitelisted(event.getName())) {

3 event.disallow("您不在白名单中!")

4 }

5})

JoinEvent

interface

玩家加入事件接口，用于处理玩家加入游戏事件

参数

getName() => string必需获取玩家名称

示例

监听玩家加入事件，向配置的群发送加入通知

1gameEvent.register("JoinEvent", (event: JoinEvent) => {

2 const message = messageConfig.getString("game-notice.on-join")

3 .replaceAll("${playerName}", event.getName())

4 for (const groupId of generalConfig.getNumberArray("bot.options.enable-groups")) {

5 scriptManager.callJsMethod("util.sendGroupTextMessage", groupId, message)

6 }

7})

QuitEvent

interface

玩家退出事件接口，用于处理玩家退出游戏事件

参数

getName() => string必需获取玩家名称

示例

监听玩家退出事件，向配置的群发送退出通知

1gameEvent.register("QuitEvent", (event: QuitEvent) => {

2 const message = messageConfig.getString("game-notice.on-quit")

3 .replaceAll("${playerName}", event.getName())

4 for (const groupId of generalConfig.getNumberArray("bot.options.enable-groups")) {

5 scriptManager.callJsMethod("util.sendGroupTextMessage", groupId, message)

6 }

7})

ChatEvent

interface

聊天事件接口，用于处理游戏内聊天消息

参数

getPlayer() => Player必需获取发送消息的玩家对象

getMessage() => string必需获取消息内容

disallow(): void必需阻止消息发送

示例

监听游戏聊天事件，将游戏内消息转发到 QQ 群

1gameEvent.register("ChatEvent", (event: ChatEvent) => {

2 const name = event.getPlayer().getName()

3 let message = event.getMessage()

4 if (generalConfig.getBoolean("chat-forward.to-qq.format")) {

5 message = scriptManager.callJsMethod("util.gameToQQ", message)

6 }

7 const format = messageConfig.getString("chat-forward.to-qq")

8 .replaceAll("${playerName}", name)

9 .replaceAll("${message}", message)

10 for (const groupId of generalConfig.getNumberArray("bot.options.enable-groups")) {

11 scriptManager.callJsMethod("util.sendGroupTextMessage", groupId, format)

12 }

13})

游戏对象接口

Player

interface

玩家接口，提供玩家相关操作方法

参数

getName() => string必需获取玩家名称

sendMessage(message: string): void必需向玩家发送消息

kick(message: string): void必需踢出玩家

hasPermission(permission: string): boolean必需检查玩家是否有权限

isOnline() => boolean必需检查玩家是否在线

示例

获取在线玩家对象，发送消息并检查权限

1const player = plugin.getOnlinePlayer("Steve")

2if (player) {

3 player.sendMessage("欢迎来到服务器!")

4 if (player.hasPermission("admin.kick")) {

5 console.log("玩家有踢人权限")

6 }

7}

OfflinePlayer

interface

离线玩家接口，提供离线玩家的基本信息

参数

getName() => string必需获取玩家名称

isOnline() => boolean必需检查玩家是否在线

示例

获取离线玩家对象并检查其名称和在线状态

1const offlinePlayer = plugin.getOfflinePlayer("Steve")

2console.log("玩家名称: " + offlinePlayer.getName())

3console.log("是否在线: " + offlinePlayer.isOnline())

CommandSender

interface

命令发送者接口，用于处理命令执行者

参数

getName() => string必需获取发送者名称

sendMessage(message: string): void必需向发送者发送消息

hasPermission(permission: string): boolean必需检查发送者是否有权限

示例

注册命令处理器，检查权限并发送消息

1gameCommand.onCommand((sender: CommandSender, args: string[]) => {

2 if (!sender.hasPermission("neobot.admin")) {

3 sender.sendMessage("您没有权限执行此命令!")

4 return

5 }

6 sender.sendMessage("命令执行成功!")

7})

Game

interface

游戏事件接口，用于注册游戏事件监听器

参数

register(eventName: string, callback: (arg: any[]) => void): void必需注册游戏事件监听器

示例

注册游戏事件监听器，处理玩家加入事件

1gameEvent.register("JoinEvent", (event: JoinEvent) => {

2 console.log("玩家 " + event.getName() + " 加入了游戏")

3})

GameCommand

interface

游戏命令接口，用于注册游戏命令处理器

参数

onCommand(callback: (sender: CommandSender, args: string[]) => void): void必需注册命令处理器

示例

注册游戏命令处理器，处理命令执行

1gameCommand.onCommand((sender: CommandSender, args: string[]) => {

2 sender.sendMessage("执行命令，参数: " + args.join(", "))

3})

网络通信接口

HttpResult

interface

HTTP 请求结果接口，用于处理 HTTP 响应

参数

getStatusCode(): number必需获取 HTTP 状态码

getResponseContent(): string必需获取响应内容

示例

发送 HTTP 请求并处理响应结果

1const request = http.builder("https://api.example.com/data").get()

2const result = request.connect()

3

4if (result.getStatusCode() === 200) {

5 console.log("请求成功:", result.getResponseContent())

6} else {

7 console.log("请求失败，状态码:", result.getStatusCode())

8}

HttpRequest

interface

HTTP 请求接口，用于配置和发送 HTTP 请求

参数

timeout(timeout: number): HttpRequest必需设置超时时间（毫秒）

connectTimeout(timeout: number): HttpRequest必需设置连接超时时间（毫秒）

readTimeout(timeout: number): HttpRequest必需设置读取超时时间（毫秒）

header(name: string, value: string): HttpRequest必需添加请求头

connect(): HttpResult必需发送请求并获取结果

示例

配置 HTTP 请求参数并发送请求

1const request = http.builder("https://api.example.com/data")

2 .get()

3 .timeout(5000)

4 .header("Content-Type", "application/json")

5 .header("Authorization", "Bearer token123")

6

7const result = request.connect()

HttpBuilder

interface

HTTP 构建器接口，用于创建 HTTP 请求

参数

get(): HttpRequest必需创建 GET 请求

post(): HttpRequest必需创建 POST 请求

put(): HttpRequest必需创建 PUT 请求

delete(): HttpRequest必需创建 DELETE 请求

示例

创建不同类型的 HTTP 请求

1// GET 请求

2const getRequest = http.builder("https://api.example.com/data").get()

3

4// POST 请求

5const postRequest = http.builder("https://api.example.com/data").post()

6

7// PUT 请求

8const putRequest = http.builder("https://api.example.com/data/1").put()

9

10// DELETE 请求

11const deleteRequest = http.builder("https://api.example.com/data/1").delete()

Http

interface

HTTP 接口，用于创建 HTTP 请求构建器

参数

builder(url: string): HttpBuilder必需创建指定 URL 的 HTTP 请求构建器

示例

创建 HTTP 请求构建器并发送请求

1const request = http.builder("https://api.example.com/data")

2const getRequest = request.get()

3const result = getRequest.connect()

数据存储接口

DatabaseCreator

interface

数据库创建接口，用于创建数据库表

参数

column(name: string, type: string, extraOptions: string): DatabaseCreator必需添加列定义

execute(): void必需执行表创建操作

示例

创建数据库表，定义列结构并执行创建

1const table = plugin.getStorageProvider().getStorage().table("neobot_whitelist")

2table.create()

3 .column("qq", "BIGINT", "PRIMARY KEY")

4 .column("players", "TEXT", "NOT NULL")

5 .execute()

Row

interface

数据库行接口，用于访问查询结果中的单行数据

参数

getString(column: string): string必需获取字符串类型列值

getInt(column: string): number必需获取整数类型列值

getLong(column: string): number必需获取长整数类型列值

getFloat(column: string): number必需获取浮点数类型列值

getDouble(column: string): number必需获取双精度浮点数类型列值

getBoolean(column: string): boolean必需获取布尔类型列值

getObject(column: string): any必需获取对象类型列值

getObject(column: string, type: T): T必需获取指定类型的列值

示例

遍历查询结果，获取行数据并解析

1const result = table.select(["players", "qq"]).execute()

2for (const row of result.map()) {

3 const qq = row.getLong("qq")

4 const players = JSON.parse(row.getString("players"))

5 console.log("QQ: " + qq + ", 绑定玩家: " + players.join(", "))

6}

Result

interface

数据库查询结果接口，用于处理查询结果

参数

map(): Row[]必需将结果转换为行数组

getFirst(): Row必需获取第一行数据

get(index: number): Row必需获取指定索引的行数据

示例

执行查询并处理结果，获取第一行数据

1const result = table.select(["players"]).where("qq", userId).execute()

2if (result.map().length > 0) {

3 const firstRow = result.getFirst()

4 const players = JSON.parse(firstRow.getString("players"))

5 console.log("绑定的玩家: " + players.join(", "))

6}

DatabaseSelector

interface

数据库查询接口，用于构建和执行查询

参数

all(): DatabaseSelector必需查询所有列

column(column: string): DatabaseSelector必需指定查询列

column(column: string[]): DatabaseSelector必需指定多个查询列

where(column: string, value: any): DatabaseSelector必需添加等值条件

where(column: string, operator: string, value: any): DatabaseSelector必需添加条件

execute(): Result必需执行查询

示例

构建查询条件，执行查询并获取结果

1const result = table.select(["players", "qq"])

2 .where("qq", userId)

3 .execute()

4

5const rows = table.select()

6 .where("time", ">", Date.now() - 86400000)

7 .execute().map()

DatabaseUpdater

interface

数据库更新接口，用于更新数据

参数

set(column: string, value: any): DatabaseUpdater必需设置更新列和值

where(column: string, value: any): DatabaseUpdater必需添加等值条件

where(column: string, operator: string, value: any): DatabaseUpdater必需添加条件

execute(): void必需执行更新

示例

构建更新操作，设置更新值和条件，执行更新

1table.update()

2 .set("players", JSON.stringify(playerData))

3 .where("qq", userId)

4 .execute()

5

6table.update()

7 .set("time", Date.now())

8 .set("note", code)

9 .where("action", "ACQUIRE_VERIFY")

10 .where("player", playerName)

11 .execute()

DatabaseInserter

interface

数据库插入接口，用于插入数据

参数

column(column: string, value: any): DatabaseInserter必需添加列和值

execute(): void必需执行插入

示例

构建插入操作，添加列和值，执行插入

1table.insert()

2 .column("qq", qqId)

3 .column("players", JSON.stringify(playerData))

4 .execute()

5

6logTable.insert()

7 .column("time", Date.now())

8 .column("operator", qqId)

9 .column("target", qqId)

10 .column("player", playerName)

11 .column("action", "BIND")

12 .column("note", "NONE")

13 .execute()

DatabaseModifier

interface

数据库修改接口，用于修改表结构

参数

add(name: string, type: string): DatabaseModifier必需添加列

add(name: string, type: string, extraOptions: string): DatabaseModifier必需添加带选项的列

remove(name: string): DatabaseModifier必需删除列

execute(): void必需执行修改

示例

修改表结构，添加和删除列

1table.alter()

2 .add("new_column", "VARCHAR(255)")

3 .add("another_column", "INT", "NOT NULL DEFAULT 0")

4 .remove("old_column")

5 .execute()

DatabaseDeleter

interface

数据库删除接口，用于删除数据

参数

where(column: string, value: any): DatabaseDeleter必需添加等值条件

where(column: string, operator: string, value: any): DatabaseDeleter必需添加条件

execute(): void必需执行删除

示例

构建删除操作，添加条件，执行删除

1table.delete()

2 .where("qq", userId)

3 .execute()

4

5logTable.delete()

6 .where("time", "<", Date.now() - 604800000)

7 .execute()

DatabaseTable

interface

数据库表接口，提供表操作方法

参数

drop(): void必需删除表

delete(): DatabaseDeleter必需创建删除操作

select(columns: string[]): DatabaseSelector必需创建查询操作

create(): DatabaseCreator必需创建表操作

update(): DatabaseUpdater必需创建更新操作

insert(): DatabaseInserter必需创建插入操作

alter(): DatabaseModifier必需创建修改表结构操作

示例

获取表对象并执行各种表操作

1const table = storage.table("my_table")

2

3// 创建表

4table.create()

5 .column("id", "INT", "PRIMARY KEY AUTO_INCREMENT")

6 .column("name", "VARCHAR(255)", "NOT NULL")

7 .execute()

8

9// 插入数据

10table.insert()

11 .column("name", "测试")

12 .execute()

13

14// 查询数据

15const result = table.select(["id", "name"])

16 .where("name", "测试")

17 .execute()

DatabaseStorage

interface

数据库存储接口，用于获取表对象

参数

table(name: string): DatabaseTable必需获取指定名称的表对象

示例

获取数据库存储对象并访问表

1const storage = plugin.getStorageProvider().getStorage()

2const table = storage.table("neobot_whitelist")

3const logTable = storage.table("neobot_whitelist_logs")

系统工具接口

QQ

interface

QQ 接口，提供 QQ 机器人相关操作方法

参数

register(eventName: string, callback: (arg: QQEvent) => void): void必需注册事件监听器

sendGroupMessage(groupId: number, message: string): void必需发送群消息

sendPrivateMessage(userId: number, message: string): void必需发送私聊消息

renameGroupMember(groupId: number, userId: number, newName: string): void必需修改群成员群名片

muteGroupMember(groupId: number, userId: number, duration: number): void必需禁言群成员

muteAllGroupMember(groupId: number): void必需开启全员禁言

unMuteAllGroupMember(groupId: number): void必需关闭全员禁言

kickGroupMember(groupId: number, userId: number): void必需踢出群成员

approveGroupRequest(flag: string, type: string): void必需同意群请求

rejectGroupRequest(flag: string, type: string): void必需拒绝群请求

rejectFriendRequest(flag: string): void必需拒绝好友请求

approveFriendRequest(flag: string): void必需同意好友请求

setGroupSpecialTitle(groupId: number, userId: number, title: string, duration: number): void必需设置群成员专属头衔

setGroupWholeBan(groupId: number, enable: boolean): void必需设置全员禁言状态

recallMessage(messageId: number): void必需撤回消息

getGroupMemberList(groupId: number, callback: (arg: BasicInfo[]) => void): void必需获取群成员列表

getGroupMemberInfo(groupId: number, userId: number, callback: (arg: GroupMemberInfo) => void): void必需获取群成员信息

getGroupList(callback: (arg: GroupInfo[]) => void): void必需获取群列表

getFriendList(callback: (arg: FriendInfo[]) => void): void必需获取好友列表

getGroupInfo(groupId: number, callback: (arg: GroupInfo) => void): void必需获取群信息

示例

发送群消息并获取群成员信息

1qq.sendGroupMessage(123456789, "Hello NeoBot!")

2

3qq.getGroupMemberInfo(123456789, 987654321, (memberInfo) => {

4 console.log("成员昵称: " + memberInfo.getNickname())

5})

Config

interface

配置接口，用于读取和写入配置文件

参数

getString(node: string): string必需获取字符串配置值

getDouble(node: string): number必需获取双精度浮点数配置值

getInt(node: string): number必需获取整数配置值

getBoolean(node: string): boolean必需获取布尔值配置值

has(node: string): boolean必需检查配置节点是否存在

put(node: string, value: any): void必需设置配置值（不持久化）

getKeys(): string[]必需获取所有配置节点键

getObject(node: string): Config必需获取配置对象

getArray(node: string): Config[]必需获取配置数组

getStringArray(node: string): string[]必需获取字符串数组配置值

getNumberArray(node: string): number[]必需获取数字数组配置值

getMessage(node: string): string必需获取消息配置值

addOption(node: string, defaultValue: any): void必需添加配置选项

示例

添加配置选项并读取各种类型的配置值

1messageConfig.addOption("game-notice.on-join", "[NeoBot] ${playerName} 加入了游戏!")

2

3const enable = generalConfig.getBoolean("whitelist.enable")

4const prefixes = generalConfig.getStringArray("whitelist.prefix.bind")

5const maxBindCount = generalConfig.getInt("whitelist.max-bind-count")

Logger

interface

日志接口，用于记录日志信息

参数

info(message: string): void必需记录信息级别日志

warn(message: string): void必需记录警告级别日志

error(message: string): void必需记录错误级别日志

debug(message: string): void必需记录调试级别日志

trace(message: string): void必需记录跟踪级别日志

示例

获取日志记录器并记录不同级别的日志

1const logger = plugin.getNeoLogger()

2logger.info("插件已加载")

3logger.warn("这是一个警告")

4logger.error("发生错误")

ScriptManager

interface

脚本管理器接口，用于管理脚本和方法

参数

loadParser(parser: (arg: string) => string): void必需加载解析器

parse(content: string): string必需解析内容

addJsMethod(name: string, method: (arg: any[]) => any): void必需添加 JavaScript 方法

hasJsMethod(name: string): boolean必需检查 JavaScript 方法是否存在

callJsMethod(name: string, ...args: any[]): any必需调用 JavaScript 方法

示例

添加 JavaScript 方法，检查方法是否存在，调用方法

1scriptManager.addJsMethod("util.configToGame", (content) => {

2 return content.replaceAll("&", "§")

3})

4

5scriptManager.addJsMethod("util.sendGroupTextMessage", (groupId, message) => {

6 const json = [{

7 "type": "text",

8 "data": { "text": message }

9 }]

10 qq.sendGroupMessage(groupId, JSON.stringify(json))

11})

12

13if (scriptManager.hasJsMethod("util.parseTextJsonMessage")) {

14 const parsed = scriptManager.callJsMethod("util.parseTextJsonMessage", jsonMessage)

15}

StorageProvider

interface

存储提供者接口，用于获取数据库存储

参数

getStorage(): DatabaseStorage必需获取数据库存储对象

getStorageType(): string必需获取存储类型

示例

获取存储提供者并访问数据库存储

1const storageProvider = plugin.getStorageProvider()

2const storage = storageProvider.getStorage()

3const storageType = storageProvider.getStorageType()

4console.log("存储类型: " + storageType)

Scheduler

interface

调度器接口，用于执行计划任务

参数

submit(task: () => void): void必需提交同步任务

submitAsync(task: () => void): void必需提交异步任务

submit(task: () => void, delay: number): void必需提交延迟任务

submitAsync(task: () => void, delay: number): void必需提交延迟异步任务

submit(task: () => void, delay: number, period: number): void必需提交延迟周期任务

submitAsync(task: () => void, delay: number, period: number): void必需提交延迟周期异步任务

submit(scriptName: string, functionName: string, delay: number): void必需提交脚本延迟任务

submitAsync(scriptName: string, functionName: string, delay: number): void必需提交脚本延迟异步任务

submit(scriptName: string, functionName: string, delay: number, period: number): void必需提交脚本延迟周期任务

submitAsync(scriptName: string, functionName: string, delay: number, period: number): void必需提交脚本延迟周期异步任务

示例

使用调度器执行各种类型的任务

1plugin.getScriptScheduler().submit(() => {

2 console.log("执行同步任务")

3})

4

5plugin.getScriptScheduler().submitAsync(() => {

6 console.log("执行异步任务")

7})

8

9plugin.getScriptScheduler().submit(() => {

10 console.log("5秒后执行的任务")

11}, 5000)

12

13plugin.getScriptScheduler().submit(() => {

14 console.log("每10秒执行一次的任务")

15}, 1000, 10000)

NeoBot

interface

NeoBot 主接口，提供核心功能

参数

getNeoLogger(): Logger必需获取日志记录器

getStorageProvider(): StorageProvider必需获取存储提供者

getScriptScheduler(): Scheduler必需获取脚本调度器

broadcast(message: string): void必需广播消息到所有玩家

getOnlinePlayers(): Player[]必需获取所有在线玩家

getOnlinePlayer(name: string): Player必需获取指定名称的在线玩家

getOfflinePlayer(name: string): OfflinePlayer必需获取指定名称的离线玩家

parsePlaceholder(message: string, player: Player): string必需解析占位符

getPlatform(): string必需获取平台信息

示例

使用 NeoBot 主接口的各种功能

1const logger = plugin.getNeoLogger()

2const storage = plugin.getStorageProvider().getStorage()

3const scheduler = plugin.getScriptScheduler()

4

5plugin.broadcast("服务器公告: 欢迎来到服务器!")

6

7const players = plugin.getOnlinePlayers()

8console.log("当前在线玩家数: " + players.length)

9

10const player = plugin.getOnlinePlayer("Steve")

11if (player) {

12 const message = plugin.parsePlaceholder("欢迎 ${player_name} 回到服务器!", player)

13 player.sendMessage(message)

14}

Enum

interface

枚举接口，提供枚举类型的基本方法

参数

toString() => string必需将枚举值转换为字符串

示例

获取群成员角色并转换为字符串输出

1const role = memberInfo.getRole()

2console.log("成员角色: " + role.toString())