api v3 update #1

Merged
whoami merged 7 commits from v3-dev into main 2024-08-04 19:38:21 +08:00
Showing only changes of commit 4332bdeb61 - Show all commits

19
docs.md
View File

@ -47,6 +47,8 @@ id|0|1|2|3|4|5|6|7|8|9|
- 0: 名字成功载入。
- 1: 对已加载的名字变量重复载入,操作失败。
- -1: 输入了空的字符串,载入失败。
- -2: 无法分割名字与战队名(可能是因为输入了过多的 @ 符号),载入失败。
@ -55,11 +57,11 @@ id|0|1|2|3|4|5|6|7|8|9|
`Name` 类型包含以下用于算号的函数方法:
- `load()` : 计算 `val``namebase`
- `load()` : 计算 `val``namebase`该操作只能进行一次。
- `calcprops()` : 计算名字属性,执行前需要先使用 `load()`
- `calcskill()` : 计算名字技能,执行前需要先使用 `load()`
- `calcskill()` : 计算名字技能,执行前需要先使用 `load()`算技能操作只能进行一次。
计算完成后,你需要手动调用 Name 变量下相关的属性数组查看结果。
@ -74,4 +76,15 @@ name.calcprops()
print(name.nameprop)
```
#### Reusable 模式与名字加载锁
#### 名字加载锁与 Reusable 模式
`Name` 名字的加载过程是单向且不可重复的。如果你试图对未执行 `load()` 的名字算属性/技能,对名字重复载入、`load()` 和 `calcskill()`,或进行其他非法操作,那么你使用的函数将拒绝操作并返回 `False`。`Name` 类型表现的这种行为在下文中简称为**名字加载锁**。
如果你想重复加载名字,可以在操作前将名字的 `reusable` 属性设置为 `True` 以启用 Reusable 模式。例如:
```python
name=sqrtools.Name()
name.reusable=True
```
Reusable 模式允许你重复使用一个 `Name` 变量,但名字加载锁仍然存在,非法操作会被自动阻止。