GuillaumeVDN的插件文档/QuestCreator/高级内容 - 版本历史

Qsefthuopq：/* 功能性任务 */

2020-11-29T07:07:28Z

功能性任务

←上一版本		2020年11月29日 (日) 07:07的版本
第211行：		第211行：

	它位于<code>/quest_models_functional/</code>。		它位于<code>/quest_models_functional/</code>。

			= 开发者API =
			插件包含了一些事件，但由于一切都可以轻易地完成，插件并没有特定的API。我的插件并没有混淆代码。

			如果你想要关联QuestCreator而不想购买这款插件，你可以联系我。

			确保在你的项目路径中同时包含QuestCreator和GCore，这样你就可以看到所有的自动补全选项。

			如有疑问，请勿犹豫，请联系我。

			== 事件 ==
			事件无法取消，它只会告诉你有事情发生。它主要用于统计数据或增加额外效果

			* <code>QuestStartEvent</code>：在任务开始时调用
			* <code>QuestStopEvent</code>：在任务完成时调用
			* <code>BranchStartEvent</code>：在分支开始时调用
			* <code>BranchStopEvent</code>：在分支停止时调用
			* <code>ObjectCompleteEvent</code>：在任务目标完成时调用
			* <code>QuestAppliedGotoEvent</code>：在应用got时调用
			* <code>QueueChangePositionEvent</code>：在排队中玩家更改队列位置时调用

			在这些事件中，当你调用 <code>getQuest()</code>方法时，你会得到 <code>AbstractQuest</code>。如果是进行中的任务<code>Quest</code>，你将可以获得更多关于它的信息（启动/停止任务的原因等）。

			即使功能性任务会触发事件，它也不值得检查（FunctionalQuest）。

			== 数据管理 ==
			你可以用<code>UserQC</code>访问用户数据。
			<code>// 检索缓存用户
			UserQC user = UserQC.cachedOrNull(player);

			// 如果用户不在缓存中，则获取用户，然后做一些事。
			// 如果用户不在缓存中且数据被修改，则保存数据，并在回调后丢弃。
			UserQC.process(uuid, user -> {
			// user was loaded
			});

			// 如果用户不在缓存中，则获取用户，然后做一些事。
			// 如果用户不在缓存中且数据被修改，则保存数据，并在回调后丢弃。
			UserQC.processWithQuests(uuid, user -> {
			// user was loaded
			});

			// 你也可以用“UserQC”访问任务数据
			user.getCachedActiveQuests().forEach(quest -> {
			// process quest
			});</code>
			您也可以直接从任务板中获取缓存任务。不建议通过任务板获取某个玩家的任务，请使用UserQC来获取。
			<code>// get all cached active quests on the server
			BoardQuests.inst().getCacheValues().forEach(quest -> {
			// process quest
			});</code>

			== 自定义目标类型 ==
			为了创建自定义元素类型，我们以一个新的任务目标类型作为示例。我建议您查看进度流程，以了解任务调用的大致情况。

			首先你需要扩展类型类。以事件目标为例：
			<code>public class TypePlayerBlockFarmCustom extends QuestObjectTypeEventGoalCustom<BlockPlaceEvent> {

			public static final QuestObjectEvent EVENT = QuestObjectEvent.register(BlockPlaceEvent.class, "getPlayer");

			public TypePlayerBlockFarm(String id) {
			super(id, CommonMats.DIRT, PositionNeed.OPTIONAL, AllowItemsNeeded.YES, AllowProgressConditions.YES, EVENT);
			}

			// call
			@Override
			protected boolean match(AbstractElementQuestObject object, QuestCallBranchProgress call, ObjectProgression progression, BlockPlaceEvent event, Player eventPlayer) {
			if (!event.getBlock().getType().equals(Material.FARMLAND)) {
			return false;
			}
			Mat mat = Mat.fromItem(eventPlayer.getItemInHand()).orNull();
			if (mat == null \|\| !mat.getData().getDataName().toUpperCase().contains("_HOE")) {
			WorkerQC.inst().logSpam(call.getQuest(), event, eventPlayer, ">>>> found item " + mat + " isn't a hoe");
			return false;
			}
			return true;
			}

			@Override
			protected Location findLocationToMatch(AbstractElementQuestObject object, QuestCallBranchProgress call, BlockPlaceEvent event, Player eventPlayer) {
			return event.getBlock().getLocation();
			}

			}</code>
			<code>QuestObjectTypeEventGoalCustom</code> 自动添加在目标设置内，但你也许想要为该目标添加自定义设置。你可以在fill方法内这么做。比如：
			<code>// 添加额外几率设置
			@Override
			protected void doFillSettingsElements(AbstractElementQuestObject object) {
			super.doFillSettingsElements(object); // fill other type settings
			object.addChancePercentage("extra_chance", Need.OPTIONAL, 0d, new TextElement(CollectionUtils.asList("&7这是我们为该目标添加的额外几率 (editor description)")));
			}

			// 在匹配方法中，让我们在能够正常继续之前先确保匹配额外的设置。
			@Override
			protected boolean match(AbstractElementQuestObject object, QuestCallBranchProgress call, ObjectProgression progression, BlockPlaceEvent event, Player eventPlayer) {
			// ... other stuff described above
			Double configuredExtraChance = object.parseElementAsOrNull("extra_chance", call.getParser()); // retrieve the current value of the setting
			if (configuredExtraChance != null && NumberUtils.random(0d, 100d) > configuredExtraChance) {
			WorkerQC.inst().logSpam(call.getQuest(), event, eventPlayer, ">>>> we are very unlucky and can't progress the object for this event");
			return false;
			}
			return true;
			}</code>
			可用于目标的类型类：

			* <code>QuestObjectTypeEvent</code>：默认事件类型（你必须手动建立目标）
			* <code>QuestObjectTypeEventGoalDefault</code>：目标数为1的事件类型
			* <code>QuestObjectTypeEventGoalCustom</code>：用户可配置的带目标事件类型
			* <code>QuestObjectTypeTimer</code>：默认定时器类型（你必须手动建立目标）
			* <code>QuestObjectTypeTimerGoalDefault</code>：目标数为1的定时器类型；在调用后会立即进行
			* <code>QuestObjectTypeTimerAction</code>：目标数为1的定时器类型；在调用后会立即进行并调用performInstantEffects()方法

			之后，你需要在任务目标类型中注册你的目标。
			<code>QuestCreator.inst().getQuestObjectTypes().register(new TypePlayerBlockFarmCustom("PLAYER_BLOCK_FARM_CUSTOM"));
			TypePlayerBlockFarmCustom.EVENT.registerListener(); // 在示例中，我们必须也要注册事件的监听器</code>
			别忘了在插件卸载时取消注册。
			<code>QuestCreator.inst().getQuestObjectTypes().unregister("PLAYER_BLOCK_FARM_CUSTOM");
			TypePlayerBlockFarmCustom.EVENT.unregisterListener(); // 在示例中，我们必须也要注册事件的监听器</code>

			== 其它自定义类型 ==
			你可以注册几乎全部新内容：

			* 激活器类型必须扩展<code>ActivatorType</code>（或 <code>ActivatorTypePhysical</code>）并用<code>QuestCreator.inst().getActivatorTypes()</code>注册/取消注册
			* 条件类型必须拓展<code>ConditionType</code>并用<code>QuestCreator.inst().getConditionTypes()</code>注册/取消注册
			* 分支类型必须拓展<code>BranchType</code>并用<code>QuestCreator.inst().getBranchTypes()</code>注册/取消注册

			……

Qsefthuopq：/* 全局元素 */

2020-11-29T06:42:10Z

全局元素

@@ 第102行： / 第102行： @@
     global@RECONNECT_EFFECTS: /
-    global@ANOTHER_EASY_GENERIC_BRANCH: /</code>
+    global@ANOTHER_EASY_GENERIC_BRANCH: /</source>
 == 全局任务目标 ==
@@ 第119行： / 第119行： @@
     ANOTHER_OBJECT:
       # 其它普通本地目标</source>
 = 功能性任务 =

Qsefthuopq：创建页面，内容为“{{模板:VDNBox}} = 变量 = 插件有一个可影响任务的内置变量系统。例如，你可以用它来记住一名玩家在任务A中做出的抉择，并因…”

2020-11-29T06:14:16Z

创建页面，内容为“{{模板:VDNBox}} = 变量 = 插件有一个可影响任务的内置变量系统。例如，你可以用它来记住一名玩家在任务A中做出的抉择，并因…”

新页面

{{模板:VDNBox}}
= 变量 =
插件有一个可影响任务的内置变量系统。例如，你可以用它来记住一名玩家在任务A中做出的抉择，并因此在任务B中显示不同的抉择选项，而这将存储在用户变量中。

每个变量都是一行文本。变量可以包含数字，并用在解析逻辑或在数学公式中。

变量名对大小写敏感：<code>MyValue</code>不等于<code>myvalue</code>。

如果变量没有值，则该变量值会显示为<code>0</code>。

== 用户变量 ==
每名玩家的用户变量都是特有的。如果有一个名为<code>my_variable</code>的变量，那么它对GuillaumeVDN而言的值是<code>1</code> ,而对Notch而言的值是<code>2</code>。

你可以在这里配置变量默认值：<code>/plugins/QuestCreator/default_variables.yml</code>
<source lang="yaml">variable_1: 0
variable_2: 'default'</source>

== 模型变量 ==
模型变量用于活跃的任务中，任务结束后这些变量就会被废弃。这些变量可能只在进行任务时有用，而对未来的任务并不重要。

你可以在每个任务模型中配置变量默认值。

== 服务器变量 ==
这些变量用于服务器。服务器变量值对所有的玩家都一样。

你可以在这里配置服务器变量默认值：<code>/plugins/QuestCreator/server_variables.yml</code>
<source lang="yaml">server_variable_1: 0
server_variable_2: 'default'</source>

== 全局变量 ==
全局变量拥有固定值且无法修改。它主要用于避免你在任务中重复编写相同内容。它就相当于宏，你可以在配置内的某个地方使用<code>{gvariable:<variable>}</code>来获取全局变量。

全局变量包含其它变量或占位符。

你可以在这批配置全局变量默认值：<code>/plugins/QuestCreator/global_variables.yml</code>
<source lang="yaml">message_prefix: '&6[QuestCreator] &7'
sample_variable_placeholderapi: '嘿，%player_name%'
sample_variable_qc: '{variable:my_variable} is the value'
sample_spawn_location: 'world,0,64,0'
sample_player_location_through_papi: '%player_world%,%player_x%,%player_y%,%player_z%'</source>

= 全局元素 =
为避免重复，你可以用全局元素来配置几乎全部的元素类型，其位于<code>/global_<element type>/</code>。

比如在这个分支里，玩家重连服务器时会获得药水效果：
<source lang="yaml">branches:

MAIN_BRANCH:
# 任务内容

ANOTHER_BRANCH:
# 其它任务分支

RECONNECT_EFFECTS:
starts_directly: true
starts_at: TRIGGER
objects:
TRIGGER:
type: PLAYER_CONNECT
goto: OBJECT EFFECT
EFFECT:
type: SERVER_PLAYER_EFFECTS_GIVE
start_notify:
message: >
&a欢迎回来，{player}&a！这是你的速度 II效果。
effects:
a:
type: SPEED
amplifier: 1
duration: 1 MINUTE
goto: OBJECT TRIGGER # 循环触发</source>
你不需要复制粘帖该分支到你的全部任务内，你可以在<code>/global_branches/RECONNECT_EFFECTS.yml</code>内创建一个全局分支：
<source lang="yaml">starts_directly: true
starts_at: TRIGGER
objects:
TRIGGER:
type: PLAYER_CONNECT
goto: OBJECT EFFECT
EFFECT:
type: SERVER_PLAYER_EFFECTS_GIVE
start_notify:
message: >
&a欢迎回来，{player}&a！这是你的速度 II效果。
effects:
a:
type: SPEED
amplifier: 1
duration: 1 MINUTE
goto: OBJECT TRIGGER # 循环触发</source>
只需要一行文本，你就可以在你的实际任务模型里面引用这个分支。

你可以通过将元素键设置为<code>global@<全局元素id></code>和一个任意值来引用全局元素，如下示例：
<source lang="yaml">branches:

MAIN_BRANCH:
# 任务内容

ANOTHER_BRANCH:
# 其它任务分支

global@RECONNECT_EFFECTS: /

global@ANOTHER_EASY_GENERIC_BRANCH: /</code>

== 全局任务目标 ==
全局任务目标只有一点不同：你仍可以配置goto：
<source lang="yaml">objects:

SOME_OBJECT:
# 普通本地目标

global@COOL_GLOBAL_OBJECT:
goto: OBJECT NEXT_COOL_GLOBAL_OBJECT

global@NEXT_COOL_GLOBAL_OBJECT:
goto: OBJECT ANOTHER_OBJECT

ANOTHER_OBJECT:
# 其它普通本地目标</source>

= 功能性任务 =
功能性任务是基本没有用户显示和限制的任务。它对于创建一些特性很有用，你可以用QuestCreator的任务分支/目标轻松地创建功能性任务。你可以用功能性任务做任何事情：当玩家进入一片区域，与一个方块交互，杀死一个实体等时，执行一些效果。你可以使用所有的玩家和服务器目标类型（不包括特殊类型）。

功能性任务实际上并不会被保存，它们在玩家连接时自动启动（根据条件自动启动），并在玩家断开连接时被丢弃。它们无法拥有激活器或结束目标。

它拥有大部分常规任务模型的设置，但没有大部分的用户显示：它没有提醒、显示名、描述、信息、GUI物品等。它也没有一些时间设置，如模型时间限制或冷却。它们不能在多人任务中运行，因为它们是针对每个玩家的，且没有玩家相关的设置。

它位于<code>/quest_models_functional/</code>。

GuillaumeVDN的插件文档/QuestCreator/高级内容 - 版本历史

Qsefthuopq：​/* 功能性任务 */

Qsefthuopq：​/* 全局元素 */

Qsefthuopq：​创建页面，内容为“{{模板:VDNBox}} = 变量 = 插件有一个可影响任务的内置变量系统。例如，你可以用它来记住一名玩家在任务A中做出的抉择，并因…”

Qsefthuopq：/* 功能性任务 */

Qsefthuopq：/* 全局元素 */

Qsefthuopq：创建页面，内容为“{{模板:VDNBox}} = 变量 = 插件有一个可影响任务的内置变量系统。例如，你可以用它来记住一名玩家在任务A中做出的抉择，并因…”