commit

docs.md

@@ -2,7 +2,7 @@
 
 sqrtools 的接口调用指南。
 
-当前 API 版本：**1**
+当前 API 版本：**2**
 
 ------
 
@@ -23,13 +23,11 @@ sqrtools 的主要功能是名为 `Name` 的 python 类。
 
 `Name` 中包含以下数值：
 
-- `namestr`, `teamstr`, `namelen`, `teamlen` : 编码存储名字和战队名字符串信息的数组，不建议手动调用。
-
 - `val`, `namebase` : 使用字符串生成的 hash-like 数组，在其他算号器中可能被称为 `name_base` 等。`val` 长度为 256，`namebase` 长度为 128。
 
 - `nameprop` : 名字属性，也就是俗称的"八围"。是长度为 8 的数组，从前到后分别为 \[攻, 防, 速, 敏, 魔, 抗, 智, HP\] 数值。
 
-- `sklid`, `sklfreq` : 名字技能。`sklid` 与 `sklfreq` 一一对应，分别表示技能的名称与熟练度。技能 id 与名称的对应关系如下：
+- `nameskill` : 存储名字技能的数组，由 40 个形如 (id, 熟练度) 的二元组组成。技能 id 与名称的对应关系如下：
 
 id|0|1|2|3|4|5|6|7|8|9|
 :-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:
@@ -43,17 +41,25 @@ id|0|1|2|3|4|5|6|7|8|9|
 
 #### Name 类型方法
 
-使用 `Name()` 可以创建一个新的空白名字。一个 `Name` 类型理论上可以多次使用，但我们不推荐这样做。
+使用 `Name()` 可以创建一个新的空白名字。一个 `Name` 类型理论上可以重复使用，但我们不推荐这样做。
+
+在开始计算前，你需要使用 `check()` 方法将名字以字符串参数的形式传入。此函数会返回一个数值，代表操作的完成状态：
+
+- 0: 名字成功载入。
+
+- -1: 输入了空的字符串，载入失败。
+
+- -2: 无法分割名字与战队名（可能是因为输入了过多的 @ 符号），载入失败。
+
+- -3: 名字长度过长，载入失败。
 
 `Name` 类型包含以下用于算号的函数方法：
 
-- `check(namein)` : 载入字符串 `namein`。如果报错，会自动用 `print()` 输出错误信息。
+- `load()` : 计算 `val` 和 `namebase`。
 
-- `load()` : 计算 `val` 和 `namebase`。在执行函数前，需要先使用 `check()` 载入。
+- `calcprops()` : 计算名字属性，执行前需要先使用 `load()`。
 
-- `calcprops()` : 计算名字属性。在执行函数前，需要先使用 `check()` 和 `load()` 载入。
-
-- `calcskill()` : 计算名字技能。在执行函数前，需要先使用 `check()` 和 `load()` 载入。
+- `calcskill()` : 计算名字技能，执行前需要先使用 `load()`。
 
 需要注意的是，以上函数均不会返回任何信息。计算完成后，你需要手动调用相关的属性变量查看结果。