获取和加载资源

Cocos Creator 有一套统一的资源管理机制 ,在本篇教程,我们将介绍

  • 资源的分类
  • 如何在 属性检查器 里设置资源
  • 动态加载 Asset
  • 动态加载 Raw Asset

资源的分类

目前的资源分成两种,一种叫做 Asset,一种叫做 Raw Asset

Asset

Creator 提供了名为 “Asset” 的资源类型,cc.SpriteFrame, cc.AnimationClip, cc.Prefab 等资源都属于 Asset。Asset 的加载是统一并且自动化的,相互依赖的 Asset 能够被自动预加载。

例如,当引擎在加载场景时,会先自动加载场景关联到的资源,这些资源如果再关联其它资源,其它也会被先被加载,等加载全部完成后,场景加载才会结束。

因此只要你拿到了一个 Asset 对象,这个对象一定是已经加载结束的,可以直接通过对象上的属性访问到资源的所有数据。当你要在引擎中使用这些资源,引擎的 API 接收的都必须是一个加载好的 Asset 对象。

脚本中可以这样定义一个 Asset 属性:

  1. // NewScript.js
  2. cc.Class({
  3. extends: cc.Component,
  4. properties: {
  5. spriteFrame: {
  6. default: null,
  7. type: cc.SpriteFrame
  8. },
  9. }
  10. });

Raw Asset

为了兼容 Cocos2d 的一些既有 API,我们把保留原始资源文件扩展名资源叫做 “Raw Asset”。图片(cc.Texture2D),声音(cc.AudioClip),粒子(cc.ParticleAsset)等资源都是 Raw Asset。Raw Asset 在脚本里由一个 url 字符串来表示,当你要在引擎中使用 Raw Asset,只要把 url 传给引擎的 API,引擎内部会自动加载这个 url 对应的资源。

当你在脚本里声明一个类型是 cc.Texture2D 的 Raw Asset,一开始可能会想这样定义:

  1. cc.Class({
  2. extends: cc.Component,
  3. properties: {
  4. textureURL: {
  5. default: null,
  6. type: cc.Texture2D
  7. }
  8. }
  9. });

这样写的问题在于,在代码中 textureURL 实际上是一个字符串,而不是 cc.Texture2D 的实例。为了不混淆 type 的语义,在 CCClass 中声明 Raw Asset 的属性时,要用 url: cc.Texture2D 而不是 type: cc.Texture2D

  1. cc.Class({
  2. extends: cc.Component,
  3. properties: {
  4. textureURL: {
  5. default: "",
  6. url: cc.Texture2D
  7. }
  8. }
  9. });

如何在属性检查器里设置资源

不论是 Asset 还是 Raw Asset,只要在脚本中定义好类型,就能直接在 属性检查器 很方便地设置资源。假设我们有这样一个组件:

  1. // NewScript.js
  2. cc.Class({
  3. extends: cc.Component,
  4. properties: {
  5. textureURL: {
  6. default: "",
  7. url: cc.Texture2D
  8. },
  9. spriteFrame: {
  10. default: null,
  11. type: cc.SpriteFrame
  12. },
  13. }
  14. });

将它添加到场景后,属性检查器 里是这样的:

asset-in-properties-null

接下来我们从 资源管理器 里面分别将一张贴图和一个 SpriteFrame 拖到 属性检查器 的对应属性中:

asset-in-properties-dnd

结果如下:

asset-in-properties-dnd

这样就能在脚本里直接拿到设置好的资源:

  1. onLoad: function () {
  2. var spriteFrame = this.spriteFrame;
  3. var textureURL = this.textureURL;
  4. spriteFrame.setTexture(textureURL);
  5. }

属性检查器 里设置资源虽然很直观,但资源只能在场景里预先设好,没办法动态切换。如果需要动态切换,你需要看看下面的内容。

动态加载

所有需要通过脚本动态加载的资源,都必须放置在 resources 文件夹或它的子文件夹下。resources 需要在 assets 文件夹中手工创建,并且必须位于 assets 的根目录,就像这样:

asset-in-properties-null

这里的 image/image, prefab, anim, font 都是常见的 Asset,而 image, audio 则是常见的 Raw Asset。

resources 文件夹里面的资源,可以关联依赖到文件夹外部的其它资源,同样也可以被外部场景或资源引用到。项目构建时,除了已在 构建发布 面板勾选的场景外,resources 文件夹里面的所有资源,连同它们关联依赖的 resources 文件夹外部的资源,都会被导出。所以如果一份资源不需要由脚本直接动态加载,那么不用放在 resources 文件夹里。

动态加载 Asset

Creator 提供了 cc.loader.loadRes 这个 API 来专门加载那些位于 resources 目录下的 Asset。和 cc.loader.load 不同的是,loadRes 一次只能加载单个 Asset。调用时,你只要传入相对 resources 的路径即可,并且路径的结尾处不能包含文件扩展名。

  1. // 加载 Prefab
  2. cc.loader.loadRes("test assets/prefab", function (err, prefab) {
  3. var newNode = cc.instantiate(prefab);
  4. cc.director.getScene().addChild(newNode);
  5. });
  6. // 加载 AnimationClip
  7. var self = this;
  8. cc.loader.loadRes("test assets/anim", function (err, clip) {
  9. self.node.getComponent(cc.Animation).addClip(clip, "anim");
  10. });
  11. // 加载 SpriteAtlas(图集),并且获取其中的一个 SpriteFrame
  12. // 注意 atlas 资源文件(plist)通常会和一个同名的图片文件(png)放在一个目录下, 所以需要在第二个参数指定资源类型
  13. cc.loader.loadRes("test assets/sheep", cc.SpriteAtlas, function (err, atlas) {
  14. var frame = atlas.getSpriteFrame('sheep_down_0');
  15. sprite.spriteFrame = frame;
  16. });

加载独立的 SpriteFrame

图片设置为 Sprite 后,将会在 资源管理器 中生成一个对应的 SpriteFrame。但如果直接加载 test assets/image,得到的类型将会是 cc.Texture2D。你必须指定第二个参数为资源的类型,才能加载到图片生成的 cc.SpriteFrame:

  1. // 加载 SpriteFrame
  2. var self = this;
  3. cc.loader.loadRes("test assets/image", cc.SpriteFrame, function (err, spriteFrame) {
  4. self.node.getComponent(cc.Sprite).spriteFrame = spriteFrame;
  5. });

如果指定了类型参数,就会在路径下查找指定类型的资源。当你在同一个路径下同时包含了多个重名资源(例如同时包含 player.clip 和 player.psd),或者需要获取“子资源”(例如获取 Texture2D 生成的 SpriteFrame),就需要声明类型。

资源释放

loadRes 加载进来的单个资源如果需要释放,可以调用 cc.loader.releaseResreleaseRes 只能传入一个和 loadRes 相同的路径,不支持类型参数。

  1. cc.loader.releaseRes("test assets/anim");

此外,你也可以使用 cc.loader.releaseAsset 来释放一个具体的 Asset 实例。

  1. cc.loader.releaseAsset(spriteFrame);

动态加载 Raw Asset

Raw Asset 可以直接使用 url 从远程服务器上加载,也可以从项目中动态加载。对远程加载而言,原先 Cocos2d 的加载方式不变,使用 cc.loader.load 即可。对项目里的 Raw Asset,加载方式和 Asset 一样:

  1. // 加载 Texture,不需要后缀名
  2. cc.loader.loadRes("test assets/image", function (err, texture) {
  3. ...
  4. });

cc.url.raw

Raw Asset 加载成功后,如果需要传给一些 url 形式的 API,还是需要给出完整路径才行。你需要用 cc.url.raw 进行一次 url 的转换:

  1. // 原 url 会报错!文件找不到
  2. var texture = cc.textureCache.addImage("resources/test assets/image.png");
  3. // 用 cc.url.raw,此时需要声明 resources 目录和文件后缀名
  4. var realUrl = cc.url.raw("resources/test assets/image.png");
  5. var texture = cc.textureCache.addImage(realUrl);

资源批量加载

cc.loader.loadResAll 可以加载相同路径下的多个资源:

  1. // 加载 test assets 目录下所有资源
  2. cc.loader.loadResAll("test assets", function (err, assets) {
  3. // ...
  4. });
  5. // 加载 sheep.plist 图集中的所有 SpriteFrame
  6. cc.loader.loadResAll("test assets/sheep", cc.SpriteFrame, function (err, assets) {
  7. // assets 是一个 SpriteFrame 数组,已经包含了图集中的所有 SpriteFrame。
  8. // 而 loadRes('test assets/sheep', cc.SpriteAtlas, function (err, atlas) {...}) 获得的则是整个 SpriteAtlas 对象。
  9. });