NativeBot/docs/development.md

2.5 KiB
Raw Blame History

NativeBot 开发帮助

关于向本项目贡献代码

  1. 和其他项目一样,先给自己的账户 Fork 一份,然后添加完代码后向主仓库提交 Pull-Request。
  2. 要求代码格式遵循《Google Java Style Guide》。
  3. 要求在你添加的代码周围添加上代码注释,和作者名称。
  4. 在改动原有代码时,向原作者商议。

关于用户系统

用户系统的核心为两个用户实例,分别为UserTencentUserMinecraft,这两个用户实例分别管理游戏内和游戏外的账号,一个是 Minecraft 账号,一个是 QQ 账号。

1. 获取用户的账号实例

// player 是 org.bukkit.entity.Player
// 传入的数据是玩家的游戏名(没有任何样式)
UserMinecraft um = UserMinecraft.of(player.getName());

// user 是 cc.moecraft.icq.user.User
// 传入的数值是用户QQ号
UserTencent ut = UserTencent.of(user.getUserId());

// 也可以根据 UserMinecraft 绑定的QQ号来获取 UserTencent
UserTencent ut = um.getTencentUser();

2. 设置和获取 UserMinecraft 的QQ号

UserMinecraft um = UserMinecraft.of("Taskeren"); // 先获取UM实例
um.setTencentId(3070190799L); // 传入的是QQ号类型是长整数
long qqid = um.getTencentId(); // 获取到的QQ号是长整数如果没有设置则返回 -1L

关于权限系统

权限系统主要是使用SimpleDataStorage进行存储,UserTencentUserMinecraft所获取和设置的权限都是存于UserTencent如果没有绑定QQ号的UserMinecraft读取权限,则返回-1为QQ号的错误UserTencent,即永远返回false

1. 获取和设置权限

UserTencentUserMinecraft使用完全相同,因为UserMinecraftsetPermision(String, boolean)getPermission(String)两个方法都是UserTencent的代理方法。

UserTencent ut = UserTencent(3070190799L); // 先获取UT实例
ut.setPermission("chatting.minecraft", true); // 传入权限名称和设置的值
boolean isAuthorized = ut.getPermission("chatting.tencent"); // 传入权限名称

2. 注册一个权限

注册权限目前只能抢在机器人启动前注册,将来会开发事件系统用于注册。

boolean isAdded = Permission.add("test"); // 传入权限名称,返回是否被注册
boolean addedYet = Permission.add("test.yes", true); // 传入权限名称和权限默认值,返回是否被注册。多用于默认给予的权限,比如 chatting.minecraft 和 chatting.tencent。