📖 规范#

Bookshelf 遵循特定命名规范,以降低阅读和理解代码所需的精力。


文件

使用 snake_case 规范。部分名称保留用于每个模块根目录的特殊函数__help____load____unload__

示例:function/<my_function>.mcfunction

实体标签

使用 snake_case 规范。必须以 bs. 和模块名称作为前缀

示例:bs.<module>.my_tag

数据存储

使用 snake_case 规范。仅限于共享资源部分定义的内容

示例:bs:data <module>.<feature>

计分板目标

使用 snake_case 规范和 bs. 前缀。仅当共享资源部分定义的现有目标无法使用时才创建新目标

示例:bs.my_objective

计分板持有者

使用 snake_case 规范。必须以模块名称作为前缀。每个分数还应使用 #(私有分数)或 $(公共分数)作为前缀

示例:$<module>.debug#<module>.any

此外,Bookshelf 遵循 Smithed 的规范,尤其是实体标签。以下是 Bookshelf 使用的实体标签:

smithed.entity

用于标识由数据包创建的实体,不应被针对原版实体的数据包修改

smithed.strict

用于标识由数据包创建的实体,不应被其他数据包修改

bs.persistent

用于标识 Bookshelf 中的持久性实体,不应被消失/杀死

bs.entity

用于标识由 Bookshelf 创建的实体