[综合][PCD]Denizen——不用定制，自己动手写插件！[1.8-1.13]

本帖最后由秋风残叶于 2019-2-17 19:27 编辑

这个帖子还没有编辑完，随心更新吧

★Denizen★

现在你可以自己写插件了

插件介绍

写在前面：

本帖适合代码阅读能力，英语能力，逻辑思维能力有一定基础的服主阅读，阅读本帖需要一些耐心

危险警告：
本插件大部分可用脚本是安全的，但是本插件也提供了一些相当危险的脚本（比如async异步执行指令）脚本危险度已在帖内标出，除非你知道自己在做什么，否则请不要擅自使用这些危险脚本，请不要在不了解内容的前提下擅自将不明脚本放入运行中的服务器，Denizen不承担因误用危险脚本造成的一切后果

版权提示：
本帖教程中展示的部分脚本非搬运者原创，仅供效果展示与学习参考

插件介绍

脚本编写教程

1. 基础 - 入门与常用脚本

教程目标：以触发型脚本为例子理解脚本结构，学会查阅帮助内容

理解变量的概念并学会在合适的地方调用变量

了解各数据类型含义，掌握常用脚本用法，能完成简单的一两层判断的小脚本

1.1 触发型脚本
热身 - 先从触发型脚本开始讲起

1.2 查阅帮助
学会阅读帮助内容

这才第一个例子就把你看晕了？不要急，Denizenscript论坛提供了很多有帮助的内容
就算你的记性再好，想把所有的事件/脚本类别/可用变量等等全部记住也是不可能的
想要成功地编写一个Denizen脚本，你应该学会去网站上看帮助内容
★触发事件
你可以在Event Search看到所有可用触发事件，比方说我们在上一个例子里用的“on command”事件

Names: 该事件的名称
Triggers: 该事件的触发原因
Context: 这个事件相关的一些变量，你可以在很多情况下调用，也可以通过if等脚本对变量进行判断
Determine: 当该事件下面有以“- determine”打头的脚本时，代表对该事件本身进行处理，比如上一个例子里给的“- determine fulfilled”

关于Context变量，以下是一个调用变量的例子

test:
type: world
debug: false
events:
on test command:
- determine passively fulfilled
- narrate '<&e>亲爱的玩家<player>，你刚刚执行了指令<context.command>！'

复制代码

★触发/执行脚本
你可以在Command Search看到所有可用触发脚本，比方说我们在上一个例子里用的“narrate”脚本

Name: 该脚本的名称
Syntax: 该脚本的正确写法
Description: 该脚本的介绍
Stable: 该脚本是否稳定，请注意某些“不稳定”的脚本可能弄坏你的服务器！
Related Tags: 相关的变量，可以在很多情况下调用或者判断
Usages: 用法示例（这作者懒的要死，很多脚本并没有给示例）
Warning: 危险警告，有此标记的脚本十分危险，请不要随意使用
Note: 备注，可能会提示你要安装前置啥的

关于Related Tags变量，以下是一个调用变量的例子

test:
type: world
debug: false
events:
on test command:
- determine passively fulfilled
- narrate '<&e>你刚刚执行了指令<context.command>！'
- give money quantity:50
- narrate '<&e>你获得了50金币！你现在有<player.money>金币！'

复制代码

★变量
你可以在Tag Search看到所有可用变量，你可以在很多场合调用这些变量，你需要注意变量的数据类型

Name: 变量名称
Returns: 返回数据类型
Description: 变量描述

可以通过给变量加一些“尾缀”来代表对该变量进行补充，我们称之为“附加变量”
比方说布尔值变量<aaa>，其返回值是true，给他加个not尾缀<aaa.not>，则其返回值是false
请看下面这个例子，附加变量<xxx.to_lowercase>代表把变量<xxx>返回值里所有大写字母改为小写

test:
type: world
debug: false
events:
on test command:
- determine passively fulfilled
- narrate '<&e>亲爱的玩家<player>，你刚刚执行了指令<context.command>！'
- narrate '<&e>这个指令如果转换成小写的话是<context.command.to_lowercase>！'

复制代码

值得一提的是，附加变量可以附加到很长，还可以添加附加的数据值，比如：

<player.location> 返回的是玩家当前坐标(dLocation)
<player.location.find.entities.within[15]> 返回的是以该玩家坐标为中心周围15格内所有实体的UUID(dList)
<player.location.find.entities.within[15].entity_type> 返回的是上述实体的实体名(dEntity)
<player.location.find.entities.within[15].entity_type.to_lowercase> 返回的是上述实体的小写实体名(dEntity)

鉴于太长的变量可能会让脚本变得很难看，可以在使用define脚本来给变量取个短名字，请参阅下文

★数据类型
一个变量究竟是什么？是一种物品？一个坐标？一串数字？还是一只生物？
为了防止混乱，Denizen让每个变量都拥有了数据类型，你可以在Mech Search查看所有数据类型
数据类型的名称是一个小写字母d后面跟一个单词，例如dEntity代表“实体数据类型”
在某些脚本中调用变量时，必须关注其数据类型，用错数据类型的脚本通常会导致bug产生
比如使用take脚本取走玩家手中一个物品时，正确写法是：

- take <player.item_in_hand> quantity:1

错误写法是：

- take <player.item_in_hand.material.name> quantity:1

虽然上面两个脚本中使用的变量，返回值从文字上看并无区别，但是其数据类型不同，前者是dItem，后者是文字，物品可以取走，文字怎么取得走？

可以通过附加变量，直接对某类型数据进行更改：

<player.location> - 返回的是玩家当前坐标（dLocation）
<player.location.add[0,2,0]> - 返回的是玩家当前坐标Y轴向上偏移2格的坐标（dLocation）

也可以通过附加变量让变量在不同的数据类型之间转换，比如上面引用的例子

如果你给某变量指定了名字，为了防止混乱，可以在脚本调用这个变量时在前面加一个标识来指代其变量类型，例如，你创建了一个物品，名叫custom，但是这个名字没有标注变量类型（一本书可以叫custom，一只怪物也能叫custom）因此在调用此变量时可以使用i@custom来告诉Denizen：这是一个物品类型的变量（dItem）
同理：

e@custom代表这是一个实体类变量
b@custom代表这是一个生物群系类变量
w@custom代表这是一个世界类变量

……更多请参Mech Search
在使用与这些变量相关的附加变量时也很方便，比如<e@custom.item_in_offhand>代表“名为custom的实体副手上的物品”

1.3 脚本if
通过if来讲权限限制

if脚本只是众多脚本之中的一种，其功能是：若玩家符合条件，则执行子脚本，若不符合条件则跳过
那么我就用这个脚本来做出“给指令添加权限限制”的效果

# 该脚本的功能是：有权限和无权限server.vip的玩家进服，显示不同的消息
test:
type: world
debug: false
events:
on player joins:
- wait 1t
- if <player.has_permission[server.vip]> {
- narrate '<&a>亲爱的VIP玩家欢迎回到服务器！'
}
- if !<player.has_permission[server.vip]> {
- narrate '<&a>欢迎您来到本服务器'
- queue clear
}

复制代码

该脚本被触发后执行脚本if，首先会判断其后变量是不是true（该变量可以是布尔值变量）
若变量条件符合，则执行下面的子脚本，若不符合，则跳过子脚本，继续进行下一步
在变量的前面加一个感叹号!或者加一个附加变量<[element].not>代表反向含义

当然，if脚本不一定判断的只能是布尔值变量，也可以判断两个相同数据类型变量是否相等或者谁大谁小，即 if A = B
请看例子，这里我们判断的是玩家主手的物品

# 该脚本的功能是：手持石头输入/sellhand可以卖出1个石头并获得10金币
test:
type: world
debug: false
events:
on sellhand command:
- determine passively fulfilled
# 如果玩家主手上是空气，即“什么都没有”，输出信息，同时终止序列，脚本不再往下运行
- if <player.item_in_hand.material.name||null> == air {
- narrate '<&a>你手上什么都没有，你必须把要出售的物品拿在手上！'
- queue clear
}
# 如果玩家手上不是石头（当然也不是空气）
# 输出信息，同时终止序列，脚本不再往下运行
- if <player.item_in_hand.material.name||null> != stone {
- narrate '<&a>目前本服务器只允许出售石头，请把石头拿在手上！'
- queue clear
}
# 如果玩家主手上有石头，扣除主手上的一个物品，输出信息，给予玩家10金币
- if <player.item_in_hand.material.name||null> == stone {
- take iteminhand
- narrate '<&a>你出售了1个石头，获得10金币'
- give money quantity:10
}

复制代码

1.4 脚本flag
标记 | 我已经做过这件事了？

当你给玩家加了某些效果以后，什么时候该把效果去掉？本插件该用什么来确认“这效果还在不在玩家身上？”
这时就应该使用flag标记，给玩家加上效果以后顺手给玩家加个标记，当插件想去掉效果时
首先会检测有没有标记：“哦~这家伙身上有标记，说明效果还在，移除掉！”
这种脚本大大减少了bug的发生率，很多bug产生的原因是因为：加了效果忘了移除
BUG高发提示：加了flag以后，什么时候该移除flag要考虑的非常周全，比较容易犯错误的地方有：玩家下线flag没移除，玩家死亡flag没移除，玩家转换世界flag没移除……等等

先看例子：

# 该脚本的功能是：主手或者副手手持火把，可以作为光源照亮周围，并跟随玩家移动
test:
type: world
debug: false
events:
on player steps on block:
# 若玩家有标记，则移除光照同时移除标记
# 因为生成的光照本身是无法“移动”的，必须消灭旧光照产生新光照来达到“移动”
- if <player.has_flag[torch_light_prev]> {
- light <context.previous_location> reset
- flag player torch_light_prev:!
}
# 若玩家主手/副手之一拿了火把，则给玩家所在位置Y轴+1的位置加上14亮度，同时给玩家加上标记
- if <player.item_in_hand.material.name||null> == torch || <player.item_in_offhand.material.name||null> == torch {
- light <context.location.add[0,1,0]> 14
- flag player torch_light_prev
}
# 当玩家下线时，若玩家身上有标记，则移除光照并移除标记
# 这是一个好发bug的地方：玩家都下线了，效果还在
on player quits:
- if <player.has_flag[torch_light_prev]> {
- light <context.previous_location> reset
- flag player torch_light_prev:!
}

复制代码

脚本flag的格式是
- flag <player> <标记名>
可在该脚本末尾加上冒号感叹号代表移除标记

1.5 脚本adjust
对变量进行“调整”

1.6 脚本foreach
遍历 | 挨个接受检查

1.7 脚本choose-case | 脚本define
不止一种的选择 | 临时的自定义变量

1.8 脚本determine
对触发事件本身进行处理

1.9 脚本inject
注入脚本 | 多次调用

1.10 脚本random
随机脚本多选一

1.11 脚本goto-mark
在按部就班的脚本序列中来回横跳

家庭作业：
1，请改写2.1 物品型脚本中的“夜视帽”实例，功能不变，至少用到一处flag脚本
（参考答案见2楼置顶）

2. 进阶 - 各类型脚本理论联系实际

教程目标：熟练运用触发型脚本，了解其它种类脚本的用法

能够把两个以上序列联系起来做出比较复杂的脚本

锻炼逻辑思维能力，尽量避免逻辑性bug出现

2.1 物品型脚本

创建物品并调用物品

“物品”是插件中不可或缺的一个元素之一，很多插件效果都要通过物品来触发（比如WorldEdit要用小木斧来选区）
那么我就在这里教大家如何使用Denizen创建一些特殊物品，并在脚本中调用物品，物品型脚本的type是item

我们以一个“夜视帽”的小脚本做例子来介绍

# 该脚本的功能是：创建一个名叫yeshimao的物品（锁链头盔）玩家把它戴在头上可获得夜视效果
# 玩家把帽子脱掉则夜视效果消失，该物品可以合成
#
# 先创建一个名叫yeshimao的物品，后面的脚本可以使用i@yeshimao来调用此物品
# 也可在游戏中执行/ex give yeshimao来直接获得此物品
yeshimao:
type: item
# 物品的种类，通常用i@<物品英文名>来表示
material: i@chainmail_helmet
# 物品的名称
display name: '<&a>夜视帽'
# 物品的lore
lore:
- '<&e>把它戴在头上'
- '<&e>获得夜视效果'
# 玩家不能丢弃此物品，也不能通过第三方插件途径扣除此物品
bound: true
# 物品合成配方，合成配方里也可以调用别的物品，来使用自定义物品合成
# 引申开来，只要是可以调用物品的地方，都可以使用自己创建的自定义物品
recipe:
- i@ink_sack,15|i@redstone_block|i@ink_sack,1
- i@glass|i@chainmail_helmet|i@glass
- i@ink_sack,2|i@quartz|i@ink_sack,4
# 附魔
# enchantments:
# - SHARPNESS:5
# 熔炉原料
# furnace_recipe: i@stone
# 下面这项设置为true，则该物品ID不可被调用，除非有特殊需求否则不推荐
# no_id: true/false
# 设置某些物品的颜色，如皮革衣服，数据类型为dColor
# color: co[url=home.php?mod=space&uid=296831]@color[/url]
# 如果该物品是成书（i@written_book）那么可以给这本书指定一个成书型脚本
# book: book_script_name
YESHIMAO_ON:
type: world
debug: false
events:
# 当玩家戴上头盔时，检测玩家的头盔是不是yeshimao
# 如果是，显示消息，执行cast脚本，玩家获得夜视效果
on player equips helmet:
- if <context.armor.simple> == i@yeshimao {
- narrate '你刚刚戴上了夜视帽！现在你能在黑暗中看清楚了'
- cast night_vision <player> duration:23h hide_particles
}
YESHIMAO_OFF:
type: world
debug: false
events:
# 当玩家取下头盔时，检测玩家的头盔是不是yeshimao
# 如果是，执行adjust脚本，移除玩家自带效果
on player unequips helmet:
- if <context.armor.simple> == i@yeshimao {
- adjust <player> remove_effects
}
YESHIMAO_CRAFT:
type: world
debug: false
events:
# 可以在触发事件中直接调用物品名
# 当夜视帽被合成时，检测玩家是否有权限yeshimao.craft
# 如果否，显示消息，取消合成
on i@yeshimao crafted:
- if !<player.has_permission[yeshimao.craft]> {
- narrate '<red>你没有权限合成这个，你必须拥有权限yeshimao.craft'
- determine cancelled
}

复制代码

2.2 指令型脚本

在服务器里执行指令

我们前面用了这么多“on command”触发型脚本举例子，这一次我们直接来讲指令型脚本，指令型脚本的type是command
可以直接给指令设置权限限制或者OP限制，很方便，不需要再套一层层if判断了，指令型脚本还能使用Tab补全

看例子

test_command:
type: command
debug: false
# 这个指令的根指令名称，会显示在/help指令列表里
name: test
# 这个指令的别称，会显示在/help指令列表里
aliases:
- testcmd
# 这个指令的用法，会显示在/help指令列表里
usage: /testcmd
# 这个指令的描述，可以通过<&nl>变量换行，会显示在/help指令列表里
description: 这是一个测试用的指令
# 执行这个指令所需的权限
permission: warps.setwarp
# 当玩家没有权限执行，显示的消息
permission message: '对不起， <player.name>，你没有权限<permission>'
# 前面提到该指令可以在/help列表里看到，那么什么样的人可以看到？
# 这里只能填写determine脚本+布尔值变量
# 常用的变量有：
# <player.has_permission[权限]> - 检测玩家是否有权限
# <player.is_op> - 检测玩家是否是OP
# <context.server> - 检测指令是不是由控制台执行
allowed help:
- determine <player.has_permission[warps.setwarp]||<player.is_op>>
# 一级指令tab补全，前面的if脚本只是判断玩家是不是OP/是不是控制台执行
# determine后面必须跟上dList组数据，比如<server.list_online_players.parse[name]>返回的是全服在线玩家名列表
tab complete:
- if !<player.is_op||<context.server>> queue clear
- determine help|list|info|reload
script:
# 当该指令是从控制台执行，会触发的内容
# 如果该指令只能由玩家执行，应该加上这部分脚本，以避免bug产生
- if <context.server> {
- announce to_console "<&c>只有玩家可以使用此指令"
- queue clear
}
- narrate "你输入了参数 '<context.raw_args>'!"

复制代码

2.2-1 实战 | “加血指令”

调用指令中的参数

你可以在指令中指定参数，在脚本中使用变量<context.args.get[参数序号]>即可获得此参数

让我们以一个例子来说明，下面这个是一个加血的脚本，玩家输入/jx <血量值> 即可给自己加血

可能有些人会嗤之以鼻：不就是个触发事件+执行脚本么？多简单！

错了！这是好发bug的地方！因为你无法知晓这个指令会以什么方式输入，指令的使用者说不定并不会按照指令的标准用法进行使用，而是胡乱添加参数，修改阈值，这些东西如果不加以注意，可能会造成严重bug

★需要注意的地方

过多参数和过少参数

指令的使用者执行指令时可能会给指令添加/减少参数，比如把/jx 8写成/jx 或者/jx 8 8，这个需要加个if来判断

参数的阈值

你真的以为指令使用者会按部就班的指定参数阈值？他会不会指定一个负数的值？会不会让阈值溢出？

阈值上出现问题的指令经常会造成严重bug（比如：加负数金钱）需要对指令参数进行阈值的判断，来避免问题

参数的格式，范围

有的时候，除了要给参数指定数字上的阈值，还要确认参数的范围，比如检查该参数的文字是否是合法字符，等等，进一步让这个参数运行在可控范围内

这个检测需要用到一个Java方法：match，一般的格式为：

- if <变量> matches <合法范围> {
- 下一步指令
- 在matches前面加感叹号!则含义相反
}

复制代码

常用的一些<合法范围>如下

判断变量是否是纯数字：if <变量> matches number

是不是通过控制台执行？

有的时候指令并非通过玩家执行，而是通过控制台执行，这种情况会导致脚本中获得玩家相关变量时总是null

也需要加个if判断，来让控制台执行不了玩家指令

请看这个加血指令脚本，仅仅一个参数的脚本就加了6个判断

test_command:
type: command
debug: false
name: jx
aliases:
- jiaxue
usage: /jx
description: 输入/jx <血量> 可以给自己加血
script:
# 当该指令是从控制台执行，触发消息，终止序列
- if <context.server> {
- announce to_console "<&c>只有玩家可以使用此指令"
- queue clear
}
# 当该指令参数过多，比如/jx 3 233 ，触发消息，终止序列
- if <context.args.get[2]||null> != null {
- narrate '<&c>指令参数过多'
- queue clear
}
# 当该指令参数过少，比如/jx ，触发消息，终止序列
- if <context.args.get[1]||null> == null {
- narrate '<&c>请输入要加的血量'
- queue clear
}
# 当第一个参数不是合法数字，比如/jx 1q5u，触发消息，终止序列
- if <context.args.get[1]||null> !matches number {
- narrate '<&c>请输入一个合法数字'
- queue clear
}
# 当第一个参数是负数或者零，比如/jx -1 ，触发消息，终止序列
- if <context.args.get[1]||null> <= 0 {
- narrate '<&c>不可以设置为零或者负数血量'
- queue clear
}
# 当玩家加了血量以后血量会超过最大血量，比如玩家当前血量18/20，又输入了/jx 3 ,触发消息，终止序列
- if <context.args.get[1].add[<player.health>]||null> > <player.health.max> {
- narrate '<&c>玩家即将达到最大血量，加血失败'
- queue clear
}
# 将以上可能性都排除后，再加血量
- heal <player> <context.args.get[1]>
- narrate '<&a>已为您加了<context.args.get[1]>血量'

复制代码

2.3 成书型脚本

创建自定义内容成书

2.4 实体型脚本

创建自定义实体生物

可以通过实体型脚本（type: entity）来创建一些实体，用于生成或者在脚本中被调用

先来看一个简单的生成生物的例子

# 该脚本的功能是：玩家执行指令/spawnwolf 在玩家鼠标指着的位置召唤一只狼
entityspawn:
type: entity
# 实体种类，必须是dEntity数据 (比如 e@zombie 或者 e@pig[age=baby])
entity_type: e@wolf
# 该生物有没有默认AI，有AI的生物行为和原版MC一样，没有AI的生物不会移动，不会和其它实体交互
has_ai: true
# 该生物的年龄
age: adult
spawncommand:
type: world
debug: false
events:
on spawnwolf command:
- determine passively fulfilled
# 在玩家鼠标所指的位置召唤实体e@entityspawn
- spawn e@entityspawn <player.location.cursor_on>
- narrate '已在<player.location.cursor_on>生成一只狼'

复制代码

与实体生成相关的设置项远远要比示例中多，你可以通过查阅这里来获得大量实体设置项，来进一步描述生成的实体（比如盔甲架的手臂是否可见，船的材质，僵尸的穿戴等等）

# 该脚本的功能是：玩家执行指令/spawnzombie 在玩家鼠标指着的位置召唤一只僵尸
entityzombie:
type: entity
# 实体种类，必须是dEntity数据 (比如 e@zombie 或者 e@pig[age=baby])
entity_type: e@zombie
# 该生物有没有默认AI，有AI的生物行为和原版MC一样，没有AI的生物不会移动，不会和其它实体交互
has_ai: true
# 该生物的年龄
age: adult
# 该生物的自定义名称
custom_name: '<&a>测试僵尸'
# 该生物的四件装备，请注意顺序：从下到上
equipment: i@diamond_boots|i@diamond_leggings|i@diamond_chestplate|i@diamond_helmet
# 该生物自带的药水效果
potion_effects: SPEED,0,120
spawncommand:
type: world
debug: false
events:
on spawnzombie command:
- determine passively fulfilled
# 在玩家鼠标所指的位置召唤实体e@entityzombie
# 由于僵尸是两格的生物，直接指定坐标可能会让僵尸卡进地下，因此要加个附加变量，让坐标在Y轴上移1格
- spawn e@entityzombie <player.location.cursor_on.add[0,1,0]>
- narrate '已在<player.location.cursor_on>生成一只僵尸'

复制代码

2.5 容器型脚本 | 脚本inventory

创建和打开自定义GUI菜单

GUI菜单是各种插件常有的元素之一，相信大家一定用过ChestCommands等一些著名的GUI菜单插件

Denizen提供了容器型脚本（type: inventory）来创建完全自定义的GUI，你可以自定义其GUI类型，标题，内含的各物品也可以调用已经存在的自定义物品

GUI该怎么打开？这里我们要用到脚本inventory

简略的inventory脚本标准格式如下（更多附加变量请参这里）

容器名的变量数据类型是dInventory，通常使用in@<容器名>来指代该容器

- inventory <open/close> destination:<容器名>

BUG高发提示：如果想通过容器型脚本做出“菜单”效果的GUI，需要注意其内容物是可以拿出来的，必须再加一条触发型脚本，当玩家点击GUI时取消事件，方可避免bug

来看一个简单的例子，这是一个输入指令以后能打开一个显示全服玩家在线列表的脚本

# 该脚本的功能是：玩家执行指令/openinv 打开一个GUI，显示在线玩家列表
# GUI的排版自定义，且里面的物品不可拿出
test:
type: inventory
# GUI的种类
# 可选种类: BREWING, CHEST, DISPENSER, ENCHANTING, ENDER_CHEST, HOPPER, PLAYER, WORKBENCH
inventory: chest
# GUI的标题
# 只有 CHEST, DISPENSER, FURNACE, ENCHANTING, HOPPER 这几个GUI支持标题
title: '<&4>测试GUI标题'
# GUI的大小，必须是 9 的倍数. 最好不要超过 54 否则GUI可能显示不正常
# 这个地方可以调用数字型变量来作为GUI大小
size: 27
# 用于填充GUI格子的各项物品，可以直接填入物品种类（比如i@diamond）也可以调用已经存在的自定义物品
definitions:
test1: i@iron_fence
test2: i@diamond
# Procedural items 这个部分会生成一组物品数据 dItems，并填入下面slots的空格里
# 每个组内的物品都会按照顺序被填充进下面GUI的空格内
# 如果GUI里已经没有空格了，那么不会再有新物品填充进去
# 请注意i@air空气并不代表空格！如果下面的格子里填入了空气，该格子将一直不会有物品填充进去
procedural items:
# 定义一个物品组li@为list，这个物品组现在为空
- define list li@
# 遍历全服在线玩家（输出值为<def[value]>）
- foreach <server.list_online_players>:
- define item i@human_skull[display_name=<def[value].name>]
# 输出包含所有在线玩头颅的def[list]
- define list <def[list].include[<def[item]>]>
- determine <def[list]>
# 这里你可以指定GUI内各物品位置
# 可以填入之前在definitions那里自定义的名称，也可以直接写上i@<物品种类>，也可以调用物品
# 可以留空[]代表空格子
slots:
- "[test2] [test1] [test1] [test1] [i@iron_fence] [test1] [test1] [test1] [test2]"
- "[test1] [] [] [] [i@apple] [] [] [] [test1]"
- "[test2] [test1] [test1] [test1] [test1] [test1] [test1] [test1] [test2]"
cmds:
type: world
debug: false
events:
# 执行指令/openinv 打开GUI：in@test
on openinv command:
- determine passively fulfilled
- inventory open destination:in@test
anticlick:
type: world
debug: false
events:
# 阻止玩家把物品从GUI中拿出来
# 这是一个bug的好发之处：从GUI里拿出物品
on player clicks in in@test:
- determine passively cancelled

复制代码

2.5-1 实战 | “服务器菜单”

用Denizen制作服务器菜单

看到这个动图是不是感觉和一些市面上流行的菜单插件差不多？

那么这次就用这个例子来讲一讲在实战中创建GUI菜单的要素

阅读此部分前请确保自己已经认真阅读了2.5 容器型脚本 部分内容

★触发事件中的要素

玩家点击菜单中某物品时触发（任意点击/左键点击/右键点击/Shift+左键/Shift+右键/中键）

on player clicks in <容器变量名>
on player left clicks in <容器变量名>
on player right clicks in <容器变量名>
on player shift_left clicks in <容器变量名>
on player shift_right clicks in <容器变量名>
on player middle clicks in <容器变量名>

★点击后执行脚本中的要素

可以使用if脚本判断一下是否有权限/是否是OP等等
可以打开其它GUI
可以执行一些常用的脚本，比如修改金钱/经验，执行指令等等

★容易产生BUG的地方

老生常谈：把物品从GUI里拿出来的bug，所以无论是什么GUI，只要涉及到点击事件，必须加个触发型脚本取消事件，以防止拿出物品bug产生

上面那个动图里的菜单，脚本如下：

# 该脚本的功能是：玩家执行指令/openinv 打开一个GUI，显示有两个按钮的“服务器菜单”
# 一个按钮左键点击可传送，右键点击显示消息，另一个按钮点击可打开另一个GUI
# 首先创建两个GUI里的按钮物品：i@lobby和i@storeopen
lobby:
type: item
material: i@redstone
display name: '<&a><&l>点击'
lore:
- '<&e>左键点击: <&f>回到主城'
- '<&e>右键点击: <&a>打开充值链接'
- '<&7>祝大家在服务器游玩愉快'
storeopen:
type: item
material: i@diamond
display name: '<&a><&l>服务器商店'
lore:
- '<&e>点击打开服务器商店'
# 这是玩家输入指令后首先打开的GUI，里面包含两个按钮
test:
type: inventory
inventory: dispenser
title: '<&1>PCD服务器菜单'
definitions:
test1: i@iron_fence
test2: i@diamond
slots:
- "[] [] []"
- "[] [i@lobby] [i@storeopen]"
- "[] [] []"
# 这是第二个GUI"服务器商店"
store:
type: inventory
inventory: chest
title: '<&1><&l>PCD服务器商店'
size: 27
definitions:
test1: i@iron_fence
test2: i@diamond
slots:
- "[test2] [test1] [test1] [test1] [test1] [test1] [test1] [test1] [test2]"
- "[test1] [i@cooked_beef] [i@melon] [i@potato_item] [i@apple] [i@carrot_item] [i@bread] [i@cake] [test1]"
- "[test2] [test1] [test1] [test1] [test1] [test1] [test1] [test1] [test2]"
# 玩家执行指令，打开in@test GUI菜单，即“服务器菜单”
cmds:
type: world
debug: false
events:
on openinv command:
- determine passively fulfilled
- inventory open destination:in@test
# 玩家左键点击“服务器菜单”里的i@lobby物品时，显示消息
# 除此之外，点击GUI内任何物品均取消动作，以防止拿物品出来
rclick:
type: world
debug: false
events:
on player right clicks in in@test:
- if <context.item.simple> = i@lobby {
- determine passively cancelled
- narrate '<&a>充值链接 www.mcbbs.net'
} else {
- determine passively cancelled
}
# 玩家右键点击“服务器菜单”里的i@lobby物品时，传送玩家
# 除此之外，点击GUI内任何物品均取消动作，以防止拿物品出来
lclick:
type: world
debug: false
events:
on player left clicks in in@test:
- if <context.item.simple> = i@lobby {
- determine passively cancelled
- teleport <player> l@102,78,102,0,0,world
- wait 1t
- narrate '<&a>已将您传送至主城'
} else {
- determine passively cancelled
}
# 玩家点击“服务器菜单”里的i@storeopen物品时，打开另一个GUI in@store,即“服务器商店”
cmdclick:
type: world
debug: false
events:
on player clicks in in@test:
- if <context.item.simple> = i@storeopen {
- determine passively cancelled
- inventory open d:in@store
} else {
- determine passively cancelled
}
# 玩家在in@store菜单里点击时，取消事件，防止物品被拿出
storeclick:
type: world
debug: false
events:
on player clicks in in@store:
- determine passively cancelled

复制代码

家庭作业：
1，请给2.2-1实战中的“加血指令”新增功能，玩家输入/jx <玩家名> <血量值> 可给指定在线玩家加血
（参考答案见2楼置顶）

3. 配置 - 生成和读取配置文件

教程目标：了解配置文件的生成和读取

3.1 什么是配置文件？

必须先把基础概念搞清楚

3.2 生成与加载配置文件 | 脚本yaml

一般插件的惯用步骤，一步一步来

首先需要介绍一个新脚本：脚本yaml

这个脚本可以用于生成配置，加载配置，卸载配置，读取并调用配置文件里的东西，保存修改到配置文件等等

前文里已经讲了内存和磁盘配置文件两种形态的区别，接下来只要不涉及保存的，我们一律以内存里的已加载配置作为介绍中心，所谓的“配置id”也都是针对内存里的配置而言的

常用的关于yaml的脚本：

★生成配置（不是直接生成配置文件，搞清楚区别！）

- yaml create id:<配置id>

★编辑配置（如果路径不存在则会自动创建）

- yaml id:<配置id> set 路径.子路径.子子路径:<值>

★保存配置至文件/从文件加载配置至内存

所谓的文件夹路径，其根目录都是你插件文件夹里的Denizen文件夹

- yaml savefile:/<文件夹名字>/<配置文件名>.yml id:<配置id>
- yaml load:/<文件夹名字>/<配置文件名>.yml id:<配置id>

★常用变量

<yaml[<配置id>].read[<路径>]> —— 最常用的变量：读取配置中某个设置项的值
<yaml[<配置id>].read[<路径>].as_list> —— 若路径下包含多个子路径以及多个值，则以dList组数据的方式输出
<yaml[<配置id>].contains[<路径>]> —— 布尔值变量，某配置文件中是否包含某路径

让我们一边看例子一边讲，以下是一个生成并加载配置文件的脚本，常见的套路都在里面

qi_dong:
debug: false
type: world
events:
# 当服务器启动时，注入脚本，加载配置文件（这一步必做）
on server start:
- inject locally path:jia_zai_pei_zhi
# 当整个Denizen重载时，注入脚本，加载配置文件（也可以不做这一步，单独使用指令重载也行）
on reload scripts:
- inject locally path:jia_zai_pei_zhi
# 你也可以自己指定一个"重载指令"，用来生成/重载配置文件（要加权限/OP限制）
on pluginreload command:
- determine passively fulfilled
- if <player.is_op.not> queue clear
- inject locally path:jia_zai_pei_zhi
jia_zai_pei_zhi:
# 加载配置之前先注入脚本，检查配置文件是否已经存在了
- inject locally path:check_config
- narrate '<&a>测试配置文件已加载/重载完毕！'
check_config:
# 先检查以下路径配置文件是否存在，如果存在，加载这个配置文件，并赋予其一个ID
# 某些偏执的插件作者可以在这一步里，一项一项检查配置项有没有拼写错误，缺漏什么的，这样也行
- if <server.has_file[/chajian/config.yml]> {
- yaml load:/chajian/config.yml id:config
# 如果配置文件不存在，先在内存里创建一个（仅ID），然后一项一项生成配置项，最后将其保存成磁盘里的配置文件
} else {
- yaml create id:config
- yaml id:config set PCD小组概况.年作品量.秋风残叶:16
- yaml id:config set PCD小组概况.年作品量.组长夜幕:12
- yaml id:config set PCD小组概况.年作品量.背锅坏黑:10
- yaml id:config set PCD小组概况.圈内贡献.秋风残叶:14
- yaml id:config set PCD小组概况.圈内贡献.女装海螺:90
- yaml id:config set PCD小组概况.PCD最棒:true
- yaml savefile:/chajian/config.yml id:config
}

复制代码

OK，只要运行这个脚本，在开服后/手动重载后，配置文件即可自动生成在Denizen文件夹中

这个配置文件里都写了些啥呀？

3.3 读取和修改配置文件

在游戏中对配置文件进行操作

本教程还没有写完

待完成：inject脚本增加非本地注入示例，地图型脚本

指令与权限

/denizen help - 插件帮助
/denizen scripts - 列出当前加载的脚本
/denizen reload scripts - 重载脚本
/denizen debug - 切换debug模式
/denizen save - 将当前插件状态保存至saves.yml
/denizen version - 查看denizen版本
/ex <单行脚本> - 直接运行单行脚本

本插件没有任何权限需要给玩家

配置文件

暂无

下载地址

本插件大小约5MB，请不要在Spigot帖子里下载，请至这里下载最新构建

不知何故下载经常中断，可能需要多试几次（如果你下载下来的文件只有1MB说明中断了）

更新记录

[groupid=1330]PluginsCDTribe[/groupid]

[综合][PCD]Denizen——不用定制，自己动手写插件！[1.8-1.13]

回复: