API Reference

From 848ade17dc7b713ccec930fe4ba362eeb7636705 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sat, 7 Oct 2023 01:37:22 +0000 Subject: Deployed 3354c5b to dev with MkDocs 1.5.3 and mike 1.1.2 --- dev/API/index.html | 2 +- dev/CLI/index.html | 2 +- dev/Core/index.html | 2 +- dev/RulePackage/Write/prepare/index.html | 2 +- dev/RulePackage/Write/python/index.html | 2 +- dev/RulePackage/Write/write/index.html | 2 +- dev/RulePackage/getStart/attribute/index.html | 2 +- dev/RulePackage/getStart/class/index.html | 2 +- dev/RulePackage/getStart/getDeeper/Module/index.html | 2 +- dev/RulePackage/getStart/getDeeper/Package/index.html | 2 +- dev/RulePackage/getStart/getDeeper/object/index.html | 2 +- dev/RulePackage/getStart/method/index.html | 2 +- dev/RulePackage/intro/index.html | 2 +- dev/RulePackage/skill/index.html | 2 +- dev/Standard/Term/DefaultDice/_counts/index.html | 2 +- dev/Standard/Term/DefaultDice/_sides/index.html | 2 +- dev/Standard/Term/DefaultDice/index.html | 2 +- dev/Standard/Term/PlayerCard/index.html | 2 +- dev/Standard/Term/check/ability/index.html | 2 +- dev/Standard/Term/check/index.html | 2 +- dev/Standard/Term/duration/campaign/index.html | 2 +- dev/Standard/Term/duration/index.html | 2 +- dev/Standard/Term/duration/module/index.html | 2 +- dev/Standard/Term/duration/sene/index.html | 2 +- dev/Standard/Term/scenario/index.html | 2 +- dev/Standard/Term/setting/index.html | 2 +- dev/Standard/what-is-rule-package/index.html | 2 +- dev/Standard/what-is-standard/index.html | 2 +- dev/Standard/why-rule-package/index.html | 2 +- dev/blog/2023/10/07/rule/index.html | 2 +- dev/changelog/index.html | 2 +- dev/sitemap.xml.gz | Bin 127 -> 127 bytes 32 files changed, 31 insertions(+), 31 deletions(-) diff --git a/dev/API/index.html b/dev/API/index.html index b9ccdb7e..f6b83750 100644 --- a/dev/API/index.html +++ b/dev/API/index.html @@ -1 +1 @@ - API Reference - HydroRollCore 核心文档 (草案)

\ No newline at end of file + API Reference - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/CLI/index.html b/dev/CLI/index.html index 89001b5e..0eb6c6e2 100644 --- a/dev/CLI/index.html +++ b/dev/CLI/index.html @@ -59,4 +59,4 @@ result.append("") return "\n".join(result) -

print(render_parser(parser, "HydroRollCore")) ```

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file +

print(render_parser(parser, "HydroRollCore")) ```

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file diff --git a/dev/Core/index.html b/dev/Core/index.html index 116c4804..2ad07dcd 100644 --- a/dev/Core/index.html +++ b/dev/Core/index.html @@ -19,4 +19,4 @@ class Myrule(Rule): """自设规则包，继承 Rule 基类""" -

合理修改你的 config.toml 配置文件，完成注册!

📄 License⚓︎

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file +

合理修改你的 config.toml 配置文件，完成注册!

📄 License⚓︎

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file diff --git a/dev/RulePackage/Write/prepare/index.html b/dev/RulePackage/Write/prepare/index.html index a9397eb0..05a65689 100644 --- a/dev/RulePackage/Write/prepare/index.html +++ b/dev/RulePackage/Write/prepare/index.html @@ -1 +1 @@ - 准备规则书 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + 准备规则书 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/Write/python/index.html b/dev/RulePackage/Write/python/index.html index 29c29ad5..cafc67df 100644 --- a/dev/RulePackage/Write/python/index.html +++ b/dev/RulePackage/Write/python/index.html @@ -1 +1 @@ - 了解Python - HydroRollCore 核心文档 (草案)

\ No newline at end of file + 了解Python - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/Write/write/index.html b/dev/RulePackage/Write/write/index.html index 8cc6635e..71e892ed 100644 --- a/dev/RulePackage/Write/write/index.html +++ b/dev/RulePackage/Write/write/index.html @@ -1 +1 @@ - 编写规则包 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + 编写规则包 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/getStart/attribute/index.html b/dev/RulePackage/getStart/attribute/index.html index 86dffb3b..02bb1a40 100644 --- a/dev/RulePackage/getStart/attribute/index.html +++ b/dev/RulePackage/getStart/attribute/index.html @@ -1 +1 @@ - attribute 属性 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + attribute 属性 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/getStart/class/index.html b/dev/RulePackage/getStart/class/index.html index ff5c0504..caf85346 100644 --- a/dev/RulePackage/getStart/class/index.html +++ b/dev/RulePackage/getStart/class/index.html @@ -1 +1 @@ - class 类 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + class 类 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/getStart/getDeeper/Module/index.html b/dev/RulePackage/getStart/getDeeper/Module/index.html index b3841893..e555e1cf 100644 --- a/dev/RulePackage/getStart/getDeeper/Module/index.html +++ b/dev/RulePackage/getStart/getDeeper/Module/index.html @@ -1 +1 @@ - Module 模块 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + Module 模块 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/getStart/getDeeper/Package/index.html b/dev/RulePackage/getStart/getDeeper/Package/index.html index 967e1b18..a4e1f3e7 100644 --- a/dev/RulePackage/getStart/getDeeper/Package/index.html +++ b/dev/RulePackage/getStart/getDeeper/Package/index.html @@ -1 +1 @@ - Package 包 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + Package 包 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/getStart/getDeeper/object/index.html b/dev/RulePackage/getStart/getDeeper/object/index.html index a0bd6c03..c9e15e10 100644 --- a/dev/RulePackage/getStart/getDeeper/object/index.html +++ b/dev/RulePackage/getStart/getDeeper/object/index.html @@ -1 +1 @@ - object 对象 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + object 对象 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/getStart/method/index.html b/dev/RulePackage/getStart/method/index.html index a9e5c51a..90dd2132 100644 --- a/dev/RulePackage/getStart/method/index.html +++ b/dev/RulePackage/getStart/method/index.html @@ -1 +1 @@ - method 方法 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + method 方法 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/intro/index.html b/dev/RulePackage/intro/index.html index da5ad68d..3a9dba65 100644 --- a/dev/RulePackage/intro/index.html +++ b/dev/RulePackage/intro/index.html @@ -1 +1 @@ - 规则包简介 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + 规则包简介 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/RulePackage/skill/index.html b/dev/RulePackage/skill/index.html index 96ab2e9c..bc958986 100644 --- a/dev/RulePackage/skill/index.html +++ b/dev/RulePackage/skill/index.html @@ -1 +1 @@ - Index - HydroRollCore 核心文档 (草案)

\ No newline at end of file + Index - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/Standard/Term/DefaultDice/_counts/index.html b/dev/Standard/Term/DefaultDice/_counts/index.html index 82b8c5db..b5fead10 100644 --- a/dev/Standard/Term/DefaultDice/_counts/index.html +++ b/dev/Standard/Term/DefaultDice/_counts/index.html @@ -1 +1 @@ - _counts 骰子个数 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file + _counts 骰子个数 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/DefaultDice/_sides/index.html b/dev/Standard/Term/DefaultDice/_sides/index.html index 1428b32e..4afbaff8 100644 --- a/dev/Standard/Term/DefaultDice/_sides/index.html +++ b/dev/Standard/Term/DefaultDice/_sides/index.html @@ -1 +1 @@ - _sides 骰子面数 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file + _sides 骰子面数 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/DefaultDice/index.html b/dev/Standard/Term/DefaultDice/index.html index 6cde26a0..7977744d 100644 --- a/dev/Standard/Term/DefaultDice/index.html +++ b/dev/Standard/Term/DefaultDice/index.html @@ -1 +1 @@ - DefaultDice 默认骰子 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file + DefaultDice 默认骰子 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/PlayerCard/index.html b/dev/Standard/Term/PlayerCard/index.html index bbba9137..5f58f157 100644 --- a/dev/Standard/Term/PlayerCard/index.html +++ b/dev/Standard/Term/PlayerCard/index.html @@ -1 +1 @@ - PlayerCard 人物卡 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file + PlayerCard 人物卡 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/check/ability/index.html b/dev/Standard/Term/check/ability/index.html index d60a7520..7af42526 100644 --- a/dev/Standard/Term/check/ability/index.html +++ b/dev/Standard/Term/check/ability/index.html @@ -1 +1 @@ - ability 检定 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + ability 检定 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/Standard/Term/check/index.html b/dev/Standard/Term/check/index.html index 3a990b5b..edc09fac 100644 --- a/dev/Standard/Term/check/index.html +++ b/dev/Standard/Term/check/index.html @@ -1 +1 @@ - check 检定 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file + check 检定 - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/duration/campaign/index.html b/dev/Standard/Term/duration/campaign/index.html index 4e0810b9..46817449 100644 --- a/dev/Standard/Term/duration/campaign/index.html +++ b/dev/Standard/Term/duration/campaign/index.html @@ -1 +1 @@ - campaign 战役 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + campaign 战役 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/Standard/Term/duration/index.html b/dev/Standard/Term/duration/index.html index 7a6285b6..1f8dec32 100644 --- a/dev/Standard/Term/duration/index.html +++ b/dev/Standard/Term/duration/index.html @@ -1 +1 @@ - duration (时长) - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file + duration (时长) - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file diff --git a/dev/Standard/Term/duration/module/index.html b/dev/Standard/Term/duration/module/index.html index d5c401b7..b4d07617 100644 --- a/dev/Standard/Term/duration/module/index.html +++ b/dev/Standard/Term/duration/module/index.html @@ -1 +1 @@ - module 模组 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + module 模组 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/Standard/Term/duration/sene/index.html b/dev/Standard/Term/duration/sene/index.html index aa2c7418..e64fea65 100644 --- a/dev/Standard/Term/duration/sene/index.html +++ b/dev/Standard/Term/duration/sene/index.html @@ -1 +1 @@ - sene 场 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + sene 场 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/Standard/Term/scenario/index.html b/dev/Standard/Term/scenario/index.html index dee3be10..08bfd31c 100644 --- a/dev/Standard/Term/scenario/index.html +++ b/dev/Standard/Term/scenario/index.html @@ -1 +1 @@ - scenario 剧本 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + scenario 剧本 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/Standard/Term/setting/index.html b/dev/Standard/Term/setting/index.html index 9295ecd2..5efae91f 100644 --- a/dev/Standard/Term/setting/index.html +++ b/dev/Standard/Term/setting/index.html @@ -1 +1 @@ - setting 背景 - HydroRollCore 核心文档 (草案)

\ No newline at end of file + setting 背景 - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/Standard/what-is-rule-package/index.html b/dev/Standard/what-is-rule-package/index.html index 51fb8ca9..05dc8096 100644 --- a/dev/Standard/what-is-rule-package/index.html +++ b/dev/Standard/what-is-rule-package/index.html @@ -45,4 +45,4 @@ return self.rule.ability.success # 返回大成功时骰主自定义的大成功文本 else: ... # 其他的检定情况 -

这样就实现了一个水系规则包，当pl使用检定掷骰指令时就会调用check()方法，如果检定结果数值小于5且大于0那么返回大成功。

我们要做的通用规则包标准就是这样一个“到底需要在Rule的子类MyRule里必须实现哪些方法？”的问题。

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file +

这样就实现了一个水系规则包，当pl使用检定掷骰指令时就会调用check()方法，如果检定结果数值小于5且大于0那么返回大成功。

我们要做的通用规则包标准就是这样一个“到底需要在Rule的子类MyRule里必须实现哪些方法？”的问题。

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file diff --git a/dev/Standard/what-is-standard/index.html b/dev/Standard/what-is-standard/index.html index 6b225d5c..abdf607c 100644 --- a/dev/Standard/what-is-standard/index.html +++ b/dev/Standard/what-is-standard/index.html @@ -1 +1 @@ - 什么是通用规则包标准? - HydroRollCore 核心文档 (草案)

\ No newline at end of file + 什么是通用规则包标准? - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/Standard/why-rule-package/index.html b/dev/Standard/why-rule-package/index.html index 2fe2817e..4ae4e519 100644 --- a/dev/Standard/why-rule-package/index.html +++ b/dev/Standard/why-rule-package/index.html @@ -1 +1 @@ - 为什么要做规则包? - HydroRollCore 核心文档 (草案)

\ No newline at end of file + 为什么要做规则包? - HydroRollCore 核心文档 (草案)

\ No newline at end of file diff --git a/dev/blog/2023/10/07/rule/index.html b/dev/blog/2023/10/07/rule/index.html index 36305a67..8101cd65 100644 --- a/dev/blog/2023/10/07/rule/index.html +++ b/dev/blog/2023/10/07/rule/index.html @@ -103,4 +103,4 @@ arcu tincidunt pulvinar. Vestibulum laoreet risus scelerisque porta congue. In velit purus, dictum quis neque nec, molestie viverra risus. Nam pellentesque tellus id elit ultricies, vel finibus erat cursus. -

If you mark a post as a draft, a red marker appears next to the post date on index pages. When the site is built, drafts are not included in the output. This behavior can be changed, e.g. for rendering drafts when building deploy previews.

When you spin up the live preview server, you should be greeted by your first post! You'll also realize, that archive and category indexes have been automatically generated for you:

Blog

However, this is just the start. The built-in blog plugin packs a lot of functionality needed in day-to-day blogging. Visit the documentation of the plugin to learn about the following topics:

Additionally, the built-in blog plugin has dozens of configuration options which allow for fine-tuning the output. You can configure post slugs, general behavior and much more.

What's next?⚓︎

Getting basic blogging support out the door was quite a challenge – the built-in blog plugin is probably the biggest release this year and already packs a lot of functionality. However, Material for MkDocs is used in many different contexts, which is why we'd expect to iterate, as always.

Some ideas already proposed by users:

Blog series: Authors should be able to create so called blog series and assign posts to a blog series using simple identifiers. For each post that is part of a series, a list with links to all other posts should be included in the post's content.
Author indexes: Besides archive and category indexes, authors should be able to create per-author indexes, which list all posts linked to an author. Additionally, a profile should be created for each author and linked from posts.
Social share buttons: It should be easy to share blog posts via social media or other ways. For this reason, it should be possible to automatically include social sharing buttons with each post.

What's still missing from the brand new built-in blog plugin? Feel free to share your ideas in the comments. Together, we can build one of the best modern engines for technical blogging!

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file +

If you mark a post as a draft, a red marker appears next to the post date on index pages. When the site is built, drafts are not included in the output. This behavior can be changed, e.g. for rendering drafts when building deploy previews.

When you spin up the live preview server, you should be greeted by your first post! You'll also realize, that archive and category indexes have been automatically generated for you:

Blog

However, this is just the start. The built-in blog plugin packs a lot of functionality needed in day-to-day blogging. Visit the documentation of the plugin to learn about the following topics:

Additionally, the built-in blog plugin has dozens of configuration options which allow for fine-tuning the output. You can configure post slugs, general behavior and much more.

What's next?⚓︎

Some ideas already proposed by users:

Blog series: Authors should be able to create so called blog series and assign posts to a blog series using simple identifiers. For each post that is part of a series, a list with links to all other posts should be included in the post's content.
Author indexes: Besides archive and category indexes, authors should be able to create per-author indexes, which list all posts linked to an author. Additionally, a profile should be created for each author and linked from posts.
Social share buttons: It should be easy to share blog posts via social media or other ways. For this reason, it should be possible to automatically include social sharing buttons with each post.

What's still missing from the brand new built-in blog plugin? Feel free to share your ideas in the comments. Together, we can build one of the best modern engines for technical blogging!

最后更新: 2023-10-07
创建日期: 2023-10-07

\ No newline at end of file diff --git a/dev/changelog/index.html b/dev/changelog/index.html index 19201ff5..2ad19a97 100644 --- a/dev/changelog/index.html +++ b/dev/changelog/index.html @@ -1 +1 @@ - Changelog - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file + Changelog - HydroRollCore 核心文档 (草案)

跳转至

\ No newline at end of file diff --git a/dev/sitemap.xml.gz b/dev/sitemap.xml.gz index fa04165c..4d82a15b 100644 Binary files a/dev/sitemap.xml.gz and b/dev/sitemap.xml.gz differ -- cgit v1.2.3-70-g09d2

API Reference

📄 License⚓︎

📄 License⚓︎

准备规则书

准备规则书

了解Python

了解Python

编写规则包

编写规则包

属性

属性

类

类

模块

模块

包

包

对象

对象

方法

方法

简介

简介

Index

Index

_counts 骰子个数

属性说明⚓︎

_counts 骰子个数

属性说明⚓︎

_sides 骰子面数

属性说明⚓︎

_sides 骰子面数

属性说明⚓︎

DefaultDice 默认骰子

类说明⚓︎

DefaultDice 默认骰子

类说明⚓︎

PlayerCard 人物卡

类说明⚓︎

PlayerCard 人物卡

类说明⚓︎

ability 检定

ability 检定

check 检定

方法说明⚓︎

检定结果表⚓︎

check 检定

方法说明⚓︎

检定结果表⚓︎

campaign 战役

campaign 战役

duration (时长)⚓︎

duration (时长)⚓︎

module 模组

module 模组

sene 场

sene 场

scenario 剧本

scenario 剧本

setting 背景

setting 背景

什么是通用规则包标准?

什么是通用规则包标准?

为什么要做规则包?

为什么要做规则包?

What's next?⚓︎

What's next?⚓︎

Changelog

1.0.2 (2023-10-07)⚓︎

FEATURES⚓︎

1.0.1 (2023-10-07)⚓︎

BUG FIX⚓︎

0.1.2 (2023-10-07)⚓︎

0.1.1 (2023-10-07)⚓︎

BUG FIX⚓︎

0.1.0-rc1 (2023-10-07)⚓︎

CHORE⚓︎

0.1.0 (2023-10-07)⚓︎

Features⚓︎