插件文档

PTitle是一个可高度自定义的称号系统插件,他支持玩家定制称号、带buff效果的称号、限时称号等,开放了外接接口,可通过接口对PTitle进行操作,例如: 获取指定玩家当前佩戴的称号、删除指定玩家指定称号等等

全新改版的PTitle即将登场,我们将对底层代码进行重写,新PTitle将支持多buff、自定义buff、实物称号（命名牌）,带来不一样的称号体验。对影响服务器TPS的所有逻辑单元进行简化,以达到最优效果

前置组件

必选

LL2

LiteLoaderBDS

LL3

LeviLamina
LegacyScriptEngine
此插件需要LL3的LSE-nodejs加载器下运行,使用前请确保您已安装了该加载器

可选

LL2上使用PAPI的所需组件

BEPlaceholderAPI

LL3上使用PAPI的所需组件

安装

LL2

首次安装,将文件夹PTitle解压到此路径下:BDS/plugins/nodejs/
更新插件请将原来的文件夹删除

LL3

将文件夹PTitle解压到此路径下:BDS/plugins/
更新插件请将原来的文件夹删除

注册指令说明

/ch - 我的称号
/chshop - 称号商城
/delch - 删除称号
/chset - 称号设置

聊天界面变量(支持`BEPlaceholderAPI`所有注册变量)

v2.0.0 Beta 23.05.0617M开始支持

使用BEPlaceholderAPI公共变量需要安装BEPlaceholderAPI插件

自带变量

变量	注释	变量	注释
`%score%`	计分板	`%money%`	LLMoney
`%world%`	玩家所在的世界维度	`%vip%`	玩家是否拥有VIP身份(需要安装PCsvip插件)
`%ping%`	玩家实时延迟	`%os%`	玩家设备系统
`%ch%`	玩家当前佩戴的称号	`%time%`	当前时间
`%name%`	玩家ID	`%msg%`	玩家发送的消息

配置文件说明

更改配置文件请注意 JSON 文件格式，不推荐使用记事本修改配置文件

`config`文件(全新改版，将支持中英双语配置文件)

{
    "version": "v2.0.5 Beta 24.02.2401A", //配置文件版本
    "money": 0, //经济模式(0为计分板，1为LLMoney)
    "score": "money", //计分板项(经济模式为计分板时生效)
    "defaul_title": "§f萌新求饶", //默认的称号
    "defaul_language": "zh_CN", //默认的语言
    "config_language": "en_US", //配置文件语言(新增)
    "chat": { //聊天界面
        "switch": false, //开关(true为开，false为关)
        "msg": "§l§3[记分板money:%score%]§1[%os%]§6[%ping%ms]§7%time%§r[§2%world%§r]<§3%name%§r> %msg%", //游戏聊天界面
        "log": "<[%ch%]%name%> %msgs%", //控制台输出
        "team": "§r[§c队内聊天§r]<[%ch%§r]%name%> %msgs%" //队内聊天界面  将会在2.0.7版本弃用对原Team插件的对接
    },
    "title_set": { //称号设置
        "buy_title": false, //购买称号(true为开，false为关)
        "sell_title": false, //出售称号(true为开，false为关)
        "del_title": false, //删除称号(true为开，false为关)
        "customize": false, //定制称号(true为开，false为关)
        "discount": 95, //出售称号时的折扣
        "vipdiscount": 90 //VIP玩家购买称号时的折扣
    },
    "customize": { //定制称号配置项
        "sort": "个人称号", //定制称号的分类
        "suffix": "№.", //定制称号的后缀
        "sell": false, //定制称号的字数
        "dele": false, //定制称号的出售条件
        "max": 3 //定制称号的删除条件
    },
    "grade": [ //品阶&等级
        {
            "name": "普通", //中文名
            "id": "§f", //颜色代码
            "customize": true, //定制是否可选(true为允许定制称号时选择，false则反)
            "money": 1000, //定制称号时的价格
            "buff_list": [] //允许定制的属性列表(buff列表)
        },
        {
            "name": "中级",
            "id": "§2",
            "customize": true,
            "money": 2000,
            "buff_list": [ //允许定制的属性列表(buff列表)
                {
                    "id": 1, //buff的数字ID
                    "type": "speed", //buff的type
                    "rank": 1, //buff的等级
                    "money": 300 //buff的价格
                },
                {
                    "id": 3,
                    "type": "haste",
                    "rank": 1,
                    "money": 300
                }
            ]
        },
        {
            "name": "高级",
            "id": "§1",
            "customize": true,
            "money": 3000,
            "buff_list": [
                {
                    "id": 1,
                    "type": "speed",
                    "rank": 0,
                    "money": 200
                },
                {
                    "id": 3,
                    "type": "haste",
                    "rank": 0,
                    "money": 200
                }
            ]
        }
    ]
}

{
  "version": "v2.0.1 Beta 23.06.2209H", //配置文件版本
  "money": 0, //经济模式(0为计分板，1为LLMoney)
  "score": "money", //计分板项(经济模式为计分板时生效)
  "defaulch": "§f萌新求饶", //默认的称号
  "language": "zh_CN", //默认的语言
  "chat": { //聊天界面
    "switch": true, //开关(true为开，false为关)
    "msg": "§l§3[记分板money:%score%]§1[%os%]§6[%ping%ms]§7%time%§r[§2%world%§r]<%ch%§r§3%name%§r> %msg%", //游戏聊天界面
    "log": "%ch%%name% >> %msg%", //控制台输出
    "team": "§r[§c队内聊天§r]<%ch%§r%name%> %msgs%" //佩戴称号时的队内聊天界面  将会在2.0.7版本弃用对原Team插件的对接
  },
  "chset": { //称号设置
    "buych": true, //购买称号(true为开，false为关)
    "sellch": true, //出售称号(true为开，false为关)
    "delch": true, //删除称号(true为开，false为关)
    "customize": true, //定制称号(true为开，false为关)
    "discount": 95, //出售称号时的折扣
    "vipdiscount": 90 //VIP玩家购买称号时的折扣
  },
  "customize": { //定制称号配置项
    "sort": "个人称号", //定制称号的分类
    "suffix": "№.", //定制称号的后缀
    "quantity": 10, //定制称号的字数
    "sell": false, //定制称号的出售条件
    "dele": false, //定制称号的删除条件
    "max": 3 //定制称号次数限制(允许玩家最多定制称号的次数)
  },
  "grade": [ //品阶&等级
    {
      "name": "普通", //中文名
      "id": "§f", //颜色代码
      "customize": true, //定制是否可选(true为允许定制称号时选择，false则反)
      "money": 1000, //定制称号时的价格
      "level": 1 //等级(对应着bufflist配置项中的level项)
    }
  ],
  "bufflist": [ //buff列表(定制称号时可选的)
    {
      "buffmcid": "speed", //buff的MCID
      "level": 3, //所属等级
      "rank": 0, //buff等级
      "money": 200 //定制称号时的价格
    }
  ]
}

`language`文件

语言菜单的配置文件
路径: BDS/plugins/Planet/PTitle/lang/language.json

{
  "lang": [ //注意:若要添加新的语言菜单，那么请先配置好语言配置文件，否则会出错
    {
      "language": "zh_CN", //类型
      "chinese": "简体中文", //中文名称
      "english": "Simplified Chinese" //英文名称
    },
    {
      "language": "en_US",
      "chinese": "英语(美国)",
      "english": "English(USA)"
    }
  ],
  "SUNSServer": "zh_CN" //玩家使用的语言
}

`titlesort`文件(改版)

称号商店分类的配置文件
路径: BDS/plugins/Planet/PTitle/data/store/titlesort.json
新

[
    "个人称号",
    "西游记称号"
]

{
  "sort": [
    "个人称号",
    "西游记称号"
  ]
}

`title`文件(改版)

称号商店商品的配置文件
路径: BDS/plugins/Planet/PTitle/data/store/title.json
新

[
    {
      "sort": "个人称号", //称号所属分类
      "title": "萌新求饶", //称号
      "sell": false, //出售条件(false为禁止，true为允许)
      "dele": false, //删除条件(false为禁止，true为允许)
      "money": 0, //称号售价(0为免费，大于0为收费)
      "buff": null, //称号buff加成 (null为无加成，根据Minecraft Wiki上的药水buff的ID进行设置)
      "time": 0, //称号有效时长 (0为永久，大于0为有效时长)
      "selltime": 0, //称号售卖时长 (0为长期，大于0为倒计时)
      "addtime": "2022-07-27 02:34:39" //(添加称号时的时间)
    },
    {
      "sort": "西游记称号",
      "title": "§6天蓬元帅",
      "sell": true,
      "dele": true,
      "money": 99999,
      "buff": "absorption",
      "time": 0,
      "selltime": 0,
      "addtime": "2022-07-28 02:34:39"
    }
  ]

{
  "goods": [
    {
      "sort": "个人称号", //称号所属分类
      "title": "萌新求饶", //称号
      "sell": false, //出售条件(false为禁止，true为允许)
      "dele": false, //删除条件(false为禁止，true为允许)
      "money": 0, //称号售价(0为免费，大于0为收费)
      "buff": null, //称号buff加成 (null为无加成，根据Minecraft Wiki上的药水buff的ID进行设置)
      "time": 0, //称号有效时长 (0为永久，大于0为有效时长)
      "selltime": 0, //称号售卖时长 (0为长期，大于0为倒计时)
      "addtime": "2022-07-27 02:34:39" //(添加称号时的时间)
    },
    {
      "sort": "西游记称号",
      "title": "§6天蓬元帅",
      "sell": true,
      "dele": true,
      "money": 99999,
      "buff": "absorption",
      "time": 0,
      "selltime": 0,
      "addtime": "2022-07-28 02:34:39"
    }
  ]
}

`buff`文件(2.1.0版新增)

预计格式

[
  //原版格式（若装有PLib,PTitle在启动时会自动删除原版buff数据)
  {
    "id":1,
    "type": "speed",
    "rank": 0,
    "money": 200 
  },
  //自定义格式
  //设计中
]

`customize`文件

玩家定制称号的记录文件
路径: BDS/plugins/Planet/PTitle/data/store/customize.json

{
  "customize": [
    {
      "name": "SUNSServer",  // 玩家名称
      "customize": "§1测试称号§r№.1" // 定制的称号
    },
    {
      "name": "定制玩家已删除",  // 当玩家删除定制的称号后,为了检测玩家定制称号的次数保留这个参数
      "customize": "§d测试定制称号§r№.21",  // 定制的称号
      "history": "SUNSServer"  // 指明定制这个称号的玩家名称
    }
  ]
}

`titlesort`文件

玩家称号分类文件
路径: BDS/plugins/Planet/PTitle/data/player/titlesort.json

{
  "SUNSServer": [
    "个人称号",
    "西游记称号"
  ]
}

`title`文件(称号buff部分改版，新增强化属性)

玩家称号数据
路径: BDS/plugins/Planet/PTitle/data/player/title.json
新

{
  "SUNSServer": [
    {
      "sort": "个人称号",
      "title": "§f萌新求饶",
      "sell": false,
      "dele": false,
      "money": 0,
      "buff": [
        {
          "id":10,
          "type":"",
          "rank":0
        },
        {
          "id":21,
          "type":"",
          "rank":0
        }, 
        {
          "type":"xp",
          "rank":1.5
        }
      ],
      "time": 0,
      "gattime": "2023-04-09 13:04:27"
    }
  ]
}

{
  "SUNSServer": [
    {
      "sort": "个人称号",
      "title": "§f萌新求饶",
      "sell": false,
      "dele": false,
      "money": 0,
      "buff": null,
      "rank": 0,
      "time": 0,
      "gattime": "2023-04-09 13:04:27"
    }
  ]
}

`weartitle`文件

玩家当前佩戴的称号
路径: BDS/plugins/Planet/PTitle/data/player/weartitle.json

{
  "SUNSServer": "§1测试称号§r№.1"
}

API

PTitle提供了6个接口

获取玩家当前佩戴称号

ll.import("getwearch")(name)
ll.import("PTitle", "getwearch")(name)

参数:
- name: String
  玩家名称
返回值: 佩戴的称号
返回值类型: String
- 如果返回 null 则表示玩家没有佩戴称号或没有数据

设置玩家当前佩戴称号

ll.import("setwearch")(name,title)
ll.import("PTitle","setwearch")(name,title)

参数:
- name: String
  玩家名称
- title: String
  要佩戴的称号
返回值: 是否佩戴成功
返回值类型: Boolean 注: 设置佩戴称号不会判断玩家是否拥有

示例：

const PTitle = ll.import("PTitle", "setwearch");

// 给玩家佩戴一个称号<测试称号>
PTitle("SUNSServer","测试称号")

给玩家添加一个个人分类称号

ll.import("ptitleaddpersonalch")(name, title, sell, dele, money, buff, rank, time)
ll.import("PTitle", "addpersonalch")(name, title, sell, dele, money, buff, rank, time)

参数:
- name: String
  玩家名称
- title: String
  要添加的称号
- sell: Boolean
  出售条件注: true或false
- dele: Boolean
  删除条件注: true或false
- money: Number
  称号价值注: 0为免费
- buff: String
  称号所带的buff 注: 无buff可填null
- rank: String
  称号buff的等级注: 无buff可填null
- time: Number
  称号有效时间注: 0为永久
返回值: 添加情况
返回值类型: Boolean
- 如果返回 false 则表示已添加

示例：

const PTitle = ll.import("PTitle", "addpersonalch");

// 给玩家一个个人分类称号<测试称号>,无法出售、允许删除、无buff、限时7天
PTitle("SUNSServer","测试称号",false,true,0,null,null,7)

给玩家添加一个团队分类称号

ll.import("ptitleaddteamchdata")(name, title, sell, dele, money, buff, rank, time)
ll.import("PTitle", "addteamch")(name, title, sell, dele, money, buff, rank, time)

参数:
- name: String
  玩家名称
- title: String
  要添加的称号
- sell: Boolean
  出售条件注: true或false
- dele: Boolean
  删除条件注: true或false
- money: Number
  称号价值注: 0为免费
- buff: String
  称号所带的buff 注: 无buff可填null
- rank: String
  称号buff的等级注: 无buff可填null
- time: Number
  称号有效时间注: 0为永久
返回值: 添加情况
返回值类型: Boolean
- 如果返回 false 则表示已添加

示例：

const PTitle = ll.import("PTitle", "addteamch");

// 给玩家一个团队分类称号<测试称号>,无法出售、允许删除、无buff、限时7天
PTitle("SUNSServer","测试称号",false,true,0,null,null,7)

给玩家添加一个分类

ll.import("ptitleaddsort")(name, sort)
ll.import("PTitle", "addsort")(name, sort)

参数:
- name: String
  玩家名称
- sort: String
  要添加的分类名称
返回值: 添加情况
返回值类型: Boolean
- 如果返回 false 则表示已添加

示例：

const PTitle = ll.import("PTitle", "addsort");

// 给玩家一个称号<测试分类>
PTitle("SUNSServer","测试分类")

给玩家添自定义分类称号

ll.import("addsorttitle")(name, title, sort, sell, dele, money, buff, rank, time)
ll.import("PTitle", "addsorttitle")(name, title, sort, sell, dele, money, buff, rank, time)

参数:
- name: String
  玩家名称
- title: String
  要添加的称号
- sort: String
  要添加的分类名称
- sell: Boolean
  出售条件注: true或false
- dele: Boolean
  删除条件注: true或false
- money: Number
  称号价值注: 0为免费
- buff: String
  称号所带的buff 注: 无buff可填null
- rank: String
  称号buff的等级注: 无buff可填null
- time: Number
  称号有效时间注: 0为永久
返回值: 添加情况
返回值类型: Boolean
- 如果返回 false 则表示已添加
- 若玩家没有这个分类,PTitle会自动为玩家创建这个分类

示例：

const PTitle = ll.import("PTitle", "addteamch");

// 给玩家测试分类中添加一个称号<测试称号>,无法出售、允许删除、无buff、限时7天
PTitle("SUNSServer","测试称号","测试分类",false,true,0,null,null,7)

删除玩家一个称号

ll.import("ptitledelch")(name,title)
ll.import("PTitle", "delch")(name,title)

参数:
- name: String
  玩家名称
- title: String
  要删除的称号
返回值: 删除情况
返回值类型: Boolean
- 如果返回 false 则表示删除失败或称号不存在

示例：

const PTitle = ll.import("PTitle", "delch");

// 删除玩家称号<测试称号>
PTitle("SUNSServer","测试称号")

获取玩家所有称号

ll.import("playerchdata")(name)
ll.import("PTitle", "chdata")(name)

参数:
- name: String
  玩家名称
返回值: 玩家的称号数据
返回值类型: Array<Object,Object,...>
- 如果返回 null 则表示玩家没有称号数据

属性	含义	类型	返回值示范
.sort	称号所属分类	`String`	个人称号
.title	称号	`String`	萌新求饶
.sell	出售条件	`Boolean`	false
.dele	删除条件	`Boolean`	false
.money	称号价值	`Number`	0
.buff	称号绑定的buff	`String`	null
.rank	buff等级	`Number`	0
.time	有效时长	`Number`	0
.gattime	获取称号时间	`String`	2022-08-03 20:25:43

前置组件 ​

必选 ​

LL2 ​

LL3 ​

可选 ​

安装 ​

LL2 ​

LL3 ​

注册指令说明 ​

聊天界面变量(支持BEPlaceholderAPI所有注册变量) ​

自带变量 ​

配置文件说明 ​

config文件(全新改版，将支持中英双语配置文件) ​

language文件 ​

titlesort文件(改版) ​

title文件(改版) ​

buff文件(2.1.0版新增) ​

customize文件 ​

titlesort文件 ​

title文件(称号buff部分改版，新增强化属性) ​

weartitle文件 ​

API ​

获取玩家当前佩戴称号 ​

设置玩家当前佩戴称号 ​

给玩家添加一个个人分类称号 ​

给玩家添加一个团队分类称号 ​

给玩家添加一个分类 ​

给玩家添自定义分类称号 ​

删除玩家一个称号 ​

获取玩家所有称号 ​

前置组件

必选

LL2

LL3

可选

安装

LL2

LL3

注册指令说明

聊天界面变量(支持`BEPlaceholderAPI`所有注册变量)

自带变量

配置文件说明

`config`文件(全新改版，将支持中英双语配置文件)

`language`文件

`titlesort`文件(改版)

`title`文件(改版)

`buff`文件(2.1.0版新增)

`customize`文件

`titlesort`文件

`title`文件(称号buff部分改版，新增强化属性)

`weartitle`文件

API

获取玩家当前佩戴称号

设置玩家当前佩戴称号

给玩家添加一个个人分类称号

给玩家添加一个团队分类称号

给玩家添加一个分类

给玩家添自定义分类称号

删除玩家一个称号

获取玩家所有称号