2.6

docs/mconline/30-网络服插件教程/4-插件制作/设计文档示例.md

@@ -0,0 +1,54 @@
+## 示例文档：随身仓库插件
+
+### 1、功能描述
+
+​	1）点击界面入口可打开随身仓库。（作为本需求的示例，入口可通过官方的主菜单插件打开即可）
+​	2）仓库的列数固定为7，行数可动态适配，最多32行，超出显示的部分通过翻页或滚动实现。
+​	3）随身仓库的界面示意，可参考下图。
+​		a、配置为初始行的仓库格子，状态是已解锁。其余格子是上锁状态。
+​		b、点击任意上锁状态的格子，弹出二次确认弹窗，弹窗内容通过本行解锁提示配置获取。
+​		c、上述弹窗选择确认，但物品、货币不足的情况下，用官方插件neteaseAlert进行弹窗提示“解锁所需物品或货币不足！”
+​		d、上述弹窗选择确认且物品、货币足够的情况下，扣除响应物品、货币并开启下一行格子。用官方插件neteaseAlert进行弹窗
+​		提示“成功解锁第%s行仓库格子”
+
+
+
+![](./images/img01.png)
+
+
+
+### 2、配置说明
+
+​	1）随身仓库初始行数，最小值是0。
+​	2）随身仓库最大行数。
+​	3）非初始行的解锁消耗：支持物品+货币两种形式，其中货币需要将官方的经济插件作为前置。若解锁配置设为 -1，则由开发者根据自己写的判断进行解锁。
+​		配置说明举例：
+​		初始行数	0
+​		最大行数	10
+​		解锁配置	[行数区间]:(货币dough_id,货币数量，[(物品1identifier：aux，物品数量1),(物品2identifier：aux，物品数量2),...],"本行解锁提示")
+
+### 3、API需求
+
+​	1）服务端API：某uid玩家打开随身仓库。
+​	2）服务端API：设置某uid玩家随身仓库解锁多少行。（假如当前已解锁3行，调用这个API，解锁行数设为3，则第4~6行进行解锁）
+​	3）服务端API：查询某uid玩家随身仓库已解锁的行数。
+​	4）服务端API：删除仓库中某一格的物品。
+​	5）服务端API：删除仓库中所有的物品。
+
+
+
+### 4、事件需求
+
+​	1）服务端事件：点击任意上锁状态格子时抛出，参数包含：玩家uid、
+​	2）服务端事件：成功解锁时抛出，参数包含：玩家uid、当前解锁的行数集合
+
+
+
+### 5、运营指令
+
+​	1）某uid玩家打开随身仓库。
+​	2）设置某uid玩家随身仓库解锁多少行。
+​	3）查询某uid玩家随身仓库已解锁的行数。
+​	4）设置某uid玩家随身仓库上锁多少行。原来已解锁格子中的物品，设为上锁状态后将无法放入但可以取出，直到重新解锁。
+​	5）删除仓库中某一格的物品。
+​	6）删除仓库中所有的物品。