《开发文档》

《垃圾去哪儿》开发文档

1. 开发平台及运行环境

开发软件：Unity3D
使用语言：C#、Lua、PHP等
运行平台：Windows7及以上
硬件设备：主机、显示器、投影仪、红外雷达

2. 项目或功能- 需求文档

• 系统流程图

3. 编写目的

• 用户：幼儿园小中大班学生及老师。
• 目标：本课件目标是教会小朋友认识到垃圾分类的重要性及如何正确的区分垃圾。在进行游戏的过程中，玩家可以通过与地幕进行交互来增加游戏体验感以及更好的领会到“垃圾分类”这一生活常识
• 次目标：略。

4. 项目背景

4.1 产品相关

• 产品名称：《垃圾去哪儿》。
• 产品代码：无。
• 产品介绍:《垃圾去哪儿》是一款基于Unity3D引擎开发的2D平面软件，运行平台为Windows。
• 产品关联:该产品依附于《游戏大厅》,为本公司系列产品之一，定位为（科常）。

4.2 人员相关

• 任务发起者:顾总、校方
• 策划负责人:孙希伟、施瑞靖
• 项目负责人:张蕾、Bruce
• 美术负责人：符立
• 程序负责人:汤胜、贺基业

5. 模块与关系

5.1 项目模块

• 知识点1--了解乱扔垃圾对环境的危害，通过语音动画和简单的互动讲解方式呈现。
• 知识点2--分2个环节，第一个环节嵌套找茬小游戏，主要讲垃圾分类对应垃圾桶。第二个环节以流程动画+小游戏，共同讲述垃圾在集中分类后如何通过对应工厂处理变废为宝。
• 知识点3--提供1个游戏，要求学生从获得垃圾到完成分类投掷，到最终控制垃圾车到达垃圾厂，来检测学生知识的全面掌握情况。

5.2 课件流程结构

• 首页
• 知识点1 — 心声
• 知识点2 — 分类
• 知识点3 — 去哪儿

课件按照以上流程顺序进行，用户也可以通过直接操作主UI来进行模块切换。

知识点1 — 心声

a.流程图

b.主要实现逻辑

1.入场待机画面，美术提供Spine动画，循环播放。
2.点击通用开始按钮后进入游戏，播放一段动画，美术提供视频。考虑到与UI的层级问题，使用VideoPalyer的RawImage渲染模式完成。
3.视频结束衔接地面垃圾的淡入动画，动画由程序控制Spire图片透明度的方式实现。
4.动画结束后出现【表盘】与【对比】两个按钮。（以上两个按钮在游戏过程中所有的出现与消失都应为从屏幕滑入或滑出的显示方式。）

• 4.1【表盘】功能为控制当前画面中所有景物的加速播放，点击加速，再次点击为暂停。加速过程中画面中垃圾与云要做相应的变化效果。
• 4.2【对比】点击效果为，画面一分为二。左边为无垃圾公园场景，右边为有垃圾公园场景。通过控制UI的像素实现画面一分为二的效果。

5.表盘点击时钟旋转结束时，垃圾应从腐败状态变回正常状态，同时出现【实景】按钮和【下一步】事件。

• 5.1【实景】按钮功能为点击后出现【实景】弹窗，弹窗中包含多张实景环保图，通过操作用户可以查看图片。另外弹框与鼠标有特定的交互事件，大概实现方式为，判定鼠标当前所在坐标是否在弹框范围内，然后进行相应的事件。

6.点击下一步后，画面右下脚淡入出现有害垃圾桶，并且此时场景中的有害垃圾以特定的曲线方式飞入到垃圾桶中，待所有的有害垃圾都飞入后，垃圾桶由【空】状态渐变为【满】状态，第一环节游戏结束。

• 6.1垃圾分入垃圾桶的曲线动画可以用Dotween插件中的Dopath方式完成，按照特定公式给每个垃圾动态设置好一个折中点，垃圾会先弧线飞向折中点最后再弧线飞入垃圾桶，这样能实现一个比较完美的曲线动画。

知识点2 — 分类

略。

知识点3 — 去哪儿

略。

6. 类或术语说明

6.1 类

• GameBase.cs(游戏模块基类)
• TUIOComponentManager.cs(地幕控件控制类)
• CommonResources.cs(通用资源类)
• MainUIController.cs(通用主UI管理类)
• ToolBarManager.cs(通用工具条类)

GameBase.cs

该类为游戏模块基类，主要规范了每个游戏模块下的通用属性及事件。
属性有模块ID，模块名称，是否可重玩，是否可新建等。
事件有开始游戏，重玩游戏，新建游戏等。

TUIOComponentManager.cs

该类为地幕控件总控制类，负责监听和管理地幕中交互的按钮与图片等。

CommonResources.cs

通用资源类，负责统一项目中所有用到的通用资源，方便管理。

MainUIController.cs

略。

ToolBarManager.cs

略。

7. 参考资料

• 策划文档
• 项目原型

8. 项目用时预估

• 功能版：起2020-1-1 止2020-2-1
  TK1:40h
  TK2:40h
  TK3:40h
• 美术优化版：略。
• 上线版：略。

9. 难点预估（条件与限制）

• TK3中游戏地图层级渲染问题。
• TK2、3中车子行驶路径为曲线，程序需要找到相应实现方案。

10. 功能与所计划采用的技术

根据项目或者功能需求，在代码层面所使用的技术或者实现方案。
比如说曲线路径的实现方式。

11. 用户界面与交互

根据用户界面和入口说明交互与使用步骤并

11.1屏幕布局示意图：

11.2.Loading界面:
游戏入口，点击屏幕任意位置进入游戏

12. 编码规范及路径规范等

在开发过程中注所要注意的一些规范等。

13. 后台接口文档

若使用到后台数据，需说明所使用的接口对应的参数，字段和返回值，也可以是数据模型层对应的模型属性和方法的说明。

14. 问题与修复说明 - Bug修复文档

开发或者测试的过程中出现了重要BUG的记录。

15. 性能分析与优化

时间特性

• 响应时间；
• 更新处理时间；
• 数据转换与传输时间；
• 运行时间等。

适应性

• 在操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时，软件的适应能力。