aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/Standard/Term/check/ability.md4
-rw-r--r--docs/docs/Standard/Term/check/index.md4
-rw-r--r--docs/docs/Standard/what-is-rule-package.md15
-rw-r--r--docs/mkdocs.yml6
4 files changed, 17 insertions, 12 deletions
diff --git a/docs/docs/Standard/Term/check/ability.md b/docs/docs/Standard/Term/check/ability.md
index 421fc210..ccb28d06 100644
--- a/docs/docs/Standard/Term/check/ability.md
+++ b/docs/docs/Standard/Term/check/ability.md
@@ -1,5 +1,7 @@
---
title: ability 检定
+icon: material/tooltip-plus
+status: question
---
!!! warning
- 关于这部分内容请移步正式术语[`check 检定`](/Standard/Term/check/)
+ 关于这部分内容请[移步正式术语](https://HydroRollCore.retrofor.space "我为什么会看到此项内容?"): [`check 检定`](/Standard/Term/check/)
diff --git a/docs/docs/Standard/Term/check/index.md b/docs/docs/Standard/Term/check/index.md
index dcfafafc..ced50585 100644
--- a/docs/docs/Standard/Term/check/index.md
+++ b/docs/docs/Standard/Term/check/index.md
@@ -5,10 +5,10 @@ title: check 检定
!!! tip
这是一个可选实现但是{==建议尽量必须实现==}的方法,主要表现在规则书正是检定方法不同而有所不同上。
-### 方法
+### 方法说明
使用`check`或者`ability`方法, 必须对检定结果设定一个完整的输出判定范围。
### 检定结果表
-如[`方法`](#_1)所言,你必须为检定的结果设计一个完整的输出判定范围,因此你需要严格并且合理的分配划分界限。 \ No newline at end of file
+如[`方法`](#_1)所言,你必须为检定的结果设计一个完整的输出判定范围,因此你需要严格并且合理的分配划分界限,保证所有情况都在允许范围内有一个类似”成功””失败”的输出。
diff --git a/docs/docs/Standard/what-is-rule-package.md b/docs/docs/Standard/what-is-rule-package.md
index 5dc19098..05c2921f 100644
--- a/docs/docs/Standard/what-is-rule-package.md
+++ b/docs/docs/Standard/what-is-rule-package.md
@@ -13,7 +13,8 @@ from HydroRolicore import RuLe
class MyRule(Rule):
"""我的自定义规则包
- appniasal函数是必须实现的方法之一
+
+ check 函数是必须实现的方法之一
name属性是必须实现的属性之一,用来定义这个规则包的名字
priority是可选实现的属性之一,默认0
"""
@@ -21,19 +22,19 @@ class MyRule(Rule):
name = "我的自定义规则包"
priority = 0 # 优先级
- def ability(self):
- """鉴定方法
+ def check(self):
+ """检定方法
- self.result 是需要鉴定时计算的结果,可以直接使用
- self.rule.ability 是Rule类里提供的用于判断鉴定情况的属性
+ self.result 是需要检定时计算的结果,可以直接使用
+ self.rule.ability 是Rule类里提供的用于判断检定情况的属性
"""
if self.result < 5 and self.result > 0:
return self.rule.ability.success # 返回大成功时骰主自定义的大成功文本
else:
- ... # 其他的鉴定情况
+ ... # 其他的检定情况
```
-这样就实现了一个水系规则包,当pl使用ability()方法,如果检定结果数值小于5且大于0那么返回大成功。
+这样就实现了一个水系规则包,当pl使用检定掷骰指令时就会调用check()方法,如果检定结果数值小于5且大于0那么返回大成功。
我们要做的通用规则包标准就是这样一个“到底需要在Rule的子类MyRule里必须实现哪些方法?”的问题。
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 5a52f425..2610a929 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -16,6 +16,7 @@ theme:
features:
- content.action.edit
- content.action.view
+ - content.tooltips
- navigation.footer
- navigation.tabs
# - navigation.tabs.sticky
@@ -94,7 +95,8 @@ markdown_extensions:
# - neoteroi.timeline
# - neoteroi.cards
# - neoteroi.projects
- # - neoteroi.spantable
+ # - neoteroi.spantabs
+ - pymdownx.snippets
- abbr
- admonition
- attr_list
@@ -179,4 +181,4 @@ nav:
- Standard/Term/check/index.md
- ability 检定: Standard/Term/check/ability.md
- API Reference:
- - "API Reference": API/index.md \ No newline at end of file
+ - "API Reference": API/index.md