这是一个h5前端项目,基于白鹭引擎实现,提供底层功能实现,不设计到网络交换层面,优势是可以用里面的很多现成工具,搭建出来一个新的产品,单机游戏网游都可以,兔宝框架提供了一个产品最基础的功能,让整个研发过程都变的轻松简单。
一般情况直接在白鹭引擎egretProperties.json文件添加配置目录,指向包含bin文件夹内容的工程目录
{
"name": "tubao",
"path": "../tubao"
}
兔宝框架需要初始化,egret引擎入口又在main函数启动,所以兔宝作为main函数某个父类存在其名字叫tubaoInit兔宝框架从这里启动,上层可以任意的扩展,只不过需要保证最终通向main就可以了。
一般情况下tubao.xxx就可以使用框架了,我们提供了一些很重要的功能方便直接使用,tubao.height视窗的高度tubao.width视窗的宽度,tubao.stage代表舞台,tubao.open浏览器打开网页,tubao.reload刷新页面
tubao代表引擎的根目录,一般情况不会扩展到外面,兔宝的能力也从这里开始。
加粗代表文件夹,普通代表类名、文件名,类名和文件名我这边都保证统一
建立于eui,白鹭引擎的布局资源解析器,遵循eui标准实现。
名字 | 描述 |
---|---|
adapter | 布局资源解析 |
asset | 素材解析器 |
theme | eui主题解析器 |
包含了所有常用的算法,开箱即用。
名字 | 描述 | 备注 |
---|---|---|
algo | 算法 | |
algo | 常用的算法 | |
Astar | A*寻路算法 | |
bit | 比特级算法 | ArrayBuffer和字符串互转 |
color | 颜色的各种算法 | |
disSort | 场景排序算法 | 传入一个显示列表自动进行层级排序 |
moveMath | 移动方向算法 | |
tool | 常用算法 | 和服务端通用 |
xxtea | 资源安全算法 |
这些是兔宝框架最基础的能力,有这个就可以和用户做基础交互了。
名字 | 描述 |
---|---|
base | 框架基础能力 |
buttonCore | 按钮效果基础类 |
hint | 屏幕上提示条,过一会就消失了 |
notice | 公告面板 |
panel | 面板基础类,提供面板窗口实现逻辑 |
paper | 图片面板,只包含一张图片的面板,仅一个图片 |
plot | 消息情节记录面板,图文并茂 |
popup | 弹窗提示 |
sceneHint | 场景提示 |
select | 双项选择器 |
selectS | 三项选择器 |
提供骨架,骨节,插槽的显示对象获取,活动状态的设置,操作对象的获取
名字 | 描述 | 备注 |
---|---|---|
DB | 龙骨系统 | |
DBbasice | 龙骨功能基类 | 提供底层支持功能 |
dbEvent | 龙骨事件类 | |
DBuse | 龙骨应用类 | 提供上层应用功能 |
名字 | 描述 |
---|---|
downList | 下拉列表类 |
downListNape | 下拉列表的单个项 |
这是一个建立在框架上的运行时编辑器,可以给玩家使用编辑显示对象。
名字 | 描述 |
---|---|
editor | 编辑器 |
tubaoDisplayObjectEditorBase | 兔宝玩家显示对象编辑组件基础底层 |
tubaoDisplayObjectEditor | 兔宝玩家显示对象编辑组件 |
translation | 处理过程对应,用于编辑器和引擎实际转换的过程 |
特效是游戏里面重要的部分,这里包含了基础的特效,提供上层引用
名字 | 描述 |
---|---|
effect | 特效包 |
button | 按钮特效 |
Effect | 各种各样方法给显示对象设置颜色 |
flash | 闪光效果,发光效果 |
popup | 面板弹窗特效 |
MovieStart | 场景切换特效 |
mvc框架适合应用在游戏中的大型系统中,如果小型系统就可以继承tubao.base.panel吧
名字 | 描述 |
---|---|
mvc | mvc框架 |
BaseController | Controller基类 |
BaseModel | Model基类 |
BaseProxy | Proxy基类 |
view | 视图 |
BaseEuiView | View基类,继承自eui.Component |
BaseSpriteView | View基类,继承自egret.Sprite |
IBaseView | View基类接口 |
manager | 框架管理类 |
controller | Controller管理类 |
view | 视图管理类 |
涂鸦绘画,是一套绘画的基础功能,并没有提供ui,可以满足用户绘画需求。
名字 | 描述 |
---|---|
paint | 画笔 |
history | 绘画工具箱,历史记录功能 |
paint | 绘画工具箱 |
brush | 笔刷 |
brush | 位图笔刷 |
sprite | 矢量图笔刷 |
config | 笔刷配置 |
argBaseBuild | 画笔基础配置构建接口 |
paintData | 记录每一笔数据接口 |
富文本在聊天中非常重要,这套是简单的带图片固定富文本内容
名字 | 描述 |
---|---|
richTextFiled | 富文本 |
EmojiBitmap | 表情位图 |
EmojiConfig | 表情配置类底层 |
EmojiPlugin | 表情管理插件 |
IEmojiConfig | 表情配置接口 |
RichTextField | 兔宝富文本 |
richTextFiledBase | 富文本包装器 |
场景在游戏中占到了很大的比重,这是一切场景显示内容的基本,系统上,先有场景管理器,然后管理场景,场景之内有层的管理,每个层又都是不同是显示列表,显示列表也有管理。
名字 | 描述 |
---|---|
scene | 场景系统类 |
layer | EUI层 |
LayerManager | 游戏层级类 |
scene | 层级场景基类 |
sceneManager | 场景管理类 |
音乐底层支持,支持各种各样的音乐基础功能
名字 | 描述 |
---|---|
sound | 音乐 |
BaseSound | Sound基类 |
bg | 背景音乐类 |
bgWx | 音效类(微信小游戏专用) |
effect | 音效类 |
effectWx | 音效类(微信小游戏专用) |
ISoundBg | 背景音乐接口 |
ISoundEffect | 特效音乐接口 |
manager | 音乐管理类 |
外部不通用的工具箱,但是在egret里面可以通用
名字 | 描述 | 备注 |
---|---|---|
utils | 工具箱 | |
disPlay | 移动到顶层,1/4定位 | |
drage | 让显示对象可以拖动 | |
playAnimation | 循环播放tween | |
verTrigger | 验证按下点是否是抬起点 | 验证式触发 |
wait | 指定对象为真运行函数否则一直等待功能块 | 被动运行 |
在产品中播放视频,注意微信native,qq上不能用
名字 | 描述 |
---|---|
video | 兔宝世界视频播放 |
videoEvent | 视频事件类 |
其他能力也很重要
名字 | 描述 |
---|---|
Appli | 应用运行载入基础模块 |
charStep | 文字逐步显示 |
charTag | 金底棕字标签 |
cookie | cookie操作 |
date | 时间日期工具 |
deBug | 调试工具类 |
device | 设备信息 |
dot | 一个点 |
grayImg | 灰度图片类 |
joyStick | 遥感 |
model | 缩放模式设置 |
music | 智能播放音乐 |
Platform | 平台数据接口。运行环境native配置 |
RedPioxyImg | 带红点的按钮 |
res | 资源加载与管理 |
roleLable | 人物标签类 |
sensitive | 敏感词过滤检测 |
sysTimer | 系统时间核心类,手动每秒时间添加一秒 |
toggleTubao | 兔宝单项选择器 |
tubaoInit | 兔宝初始化,最终通往Main函数 |
tubaoLabel | 兔宝文本框增强,适用密码等特殊用途 |