AssetDB

Editor.assetdb

urlToUuid

Return uuid by url. if uuid not found, it will return null. Parameters

• url **

fspathToUuid

Return uuid by file path. if uuid not found, it will return null. Parameters

• fspath **

uuidToFspath

Return file path by uuid. if file path not found, it will return null. Parameters

• uuid **

uuidToUrl

Return url by uuid. if url not found, it will return null. Parameters

• uuid **

fspathToUrl

Return url by file path. if file path not found, it will return null. Parameters

• fspath **

urlToFspath

Return file path by url. if url not found, it will return null. Parameters

• url **

exists

Check existance by url. Parameters

• url **

existsByUuid

Check existance by uuid. Parameters

• uuid **

existsByPath

Check existance by path. Parameters

• fspath **

isSubAsset

Check whether asset for a given url is a sub asset. Parameters

• url **

isSubAssetByUuid

Check whether asset for a given uuid is a sub asset. Parameters

• uuid **

isSubAssetByPath

Check whether asset for a given path is a sub asset. Parameters

• fspath **

containsSubAssets

Check whether asset contains sub assets for a given url. Parameters

• url **

containsSubAssetsByUuid

Check whether asset contains sub assets for a given uuid. Parameters

• uuid **

containsSubAssetsByPath

Check whether asset contains sub assets for a given path. Parameters

• path **
• fspath

assetInfo

Return asset info by a given url. Parameters

• url { uuid, path, url, type, isSubAsset }

  assetInfoByUuid

  Return asset info by a given uuid. Parameters
• uuid { uuid, path, url, type, isSubAsset }

  assetInfoByPath

  Return asset info by a given file path. Parameters
• fspath { uuid, path, url, type, isSubAsset }

  subAssetInfos

  Return all sub assets info by url if the url contains sub assets. Parameters
• url [{ uuid, path, url, type, isSubAsset }]

  subAssetInfosByUuid

  Return all sub assets info by uuid if the uuid contains sub assets. Parameters
• uuid [{ uuid, path, url, type, isSubAsset }]

  subAssetInfosByPath

  Return all sub assets info by path if the path contains sub assets. Parameters
• fspath [{ uuid, path, url, type, isSubAsset }]

  loadMeta

  Return meta instance by a given url. Parameters
• url **

loadMetaByUuid

Return meta instance by a given uuid. Parameters

• uuid **

loadMetaByPath

Return meta instance by a given path. Parameters

• fspath **

isMount

Return whether a given url is reference to a mount Parameters

• url **

isMountByPath

Return whether a given path is reference to a mount Parameters

• fspath **

isMountByUuid

Return whether a given uuid is reference to a mount Parameters

• uuid **

mountInfo

Return mount info by url Parameters

• url { path, name, type }

  mountInfoByUuid

  Return mount info by uuid Parameters
• uuid { path, name, type }

  mountInfoByPath

  Return mount info by path Parameters
• fspath { path, name, type }

  mount

  mount a directory to assetdb, and give it a name. if you don’t provide a name, it will mount to root. Parameters
• path ** file system path
• mountPath ** the mount path (relative path)
• opts ** options
• opts.hide ** if the mount hide in assets browser
• opts.virtual ** if this is a virtual mount point
• opts.icon ** icon for the mount
• cb ** a callback function Examples**

    ```js    Editor.assetdb.mount('path/to/mount', 'assets', function (err) {      // mounted, do something ...    });

  ```

  attachMountPath

  attach the specified mount path Parameters
• mountPath ** the mount path (relative path)
• cb ** a callback function Examples**

    ```js    Editor.assetdb.attachMountPath('assets', function (err, results) {      // mount path attached, do something ...      // results are the assets created    });

  ```

  unattachMountPath

  unattach the specified mount path Parameters
• mountPath ** the mount path (relative path)
• cb ** a callback function Examples**

    ```js    Editor.assetdb.unattachMountPath('assets', function (err, results) {      // mount path unattached, do something ...      // results are the assets deleted    });

  ```

  unmount

  Unmount by name Parameters
• mountPath ** the mount path
• cb ** Examples**

    ```js    Editor.assetdb.unmount('assets', function (err) {      // unmounted, do something ...    });

  ```

  init

  Init assetdb, it will scan the mounted directories, and import unimported assets. Parameters
• cb ** Examples**

    ```js    Editor.assetdb.init(function (err, results) {      // assets that imported during init      results.forEach(function ( result ) {        // result.uuid        // result.parentUuid        // result.url        // result.path        // result.type      });    });

  ```

  refresh

  Refresh the assets in url, and return the results Parameters
• url **
• cb ** Examples**

    ```js    Editor.assetdb.refresh('db://assets/foo/bar/', function (err, results) {      // assets that imported during init      results.forEach(function ( result ) {        if ( result.command === 'delete' ) {          // result.uuid          // result.url          // result.path          // result.type        } else if ( result.command === 'change' || result.command === 'create' ) {          // result.uuid          // result.parentUuid          // result.url          // result.path          // result.type        } else if ( result.command === 'uuid-change' ) {          // result.oldUuid          // result.uuid          // result.parentUuid          // result.url          // result.path          // result.type        }      });    });

  ```

  deepQuery

  deepQuery Parameters
• cb ** Examples**

    ```js    Editor.assetdb.deepQuery(function ( err, results ) {      results.forEach(function ( result ) {        // result.name        // result.extname        // result.uuid        // result.type        // result.isSubAsset        // result.children - the array of children result      });    });

  ```

  queryAssets

  queryAssets Parameters
• pattern ** The url pattern
• assetTypes ( The asset type(s)
• cb ** The callback function
• urlPattern Examples

    ```js    Editor.assetdb.queryAssets( 'db://assets/**\/*', 'texture', function ( err, results ) {      results.forEach(function ( result ) {        // result.url        // result.path        // result.uuid        // result.type        // result.isSubAsset      });    });

  ```

  queryMetas

  queryMetas Parameters
• pattern ** The url pattern
• type ** The asset type
• cb ** The callback function
• urlPattern
• assetType Examples

    ```js    Editor.assetdb.queryAssets( 'db://assets/**\/*', 'texture', function ( err, results ) {      results.forEach(function ( meta ) {        // the meta instance      });    });

  ```

  move

  move Parameters
• srcUrl **
• destUrl **
• cb ** Examples**

    ```js    Editor.assetdb.move( 'db://assets/foo/foobar.png', 'db://assets/bar/foobar.png', function ( err, results ) {      results.forEach(function ( result ) {        // result.srcPath        // result.destPath        // result.uuid        // result.parentUuid      });    });

  ```

  delete

  delete Parameters
• urls **
• cb ** Examples**

    ```js    Editor.assetdb.delete( [ 'db://assets/foo/bar.png', 'db://assets/foo/bar.plist' ], function ( err, results ) {      results.forEach(function ( result ) {        // result.srcPath        // result.destPath        // result.uuid        // result.parentUuid      });    });

  ```

  create

  Create asset at url with data Parameters
• url **
• data **
• cb ** Examples**

    ```js    Editor.assetdb.create( 'db://assets/foo/bar.js', data, function ( err, results ) {      results.forEach(function ( result ) {        // result.uuid        // result.parentUuid        // result.url        // result.path        // result.type      });    });

  ```

  saveExists

  Save data to the exists asset at url Parameters
• url **
• data **
• cb ** Examples**

    ```js    Editor.assetdb.saveExists( 'db://assets/foo/bar.js', data, function ( err, meta ) {      // do something    });

  ```

  import

  Import raw files to url Parameters
• rawfiles **
• url **
• cb ** Examples**

    ```js    Editor.assetdb.import( ['/User/user/foo.js', '/User/user/bar.js'], 'db://assets/foobar', function ( err, results ) {      results.forEach(function ( result ) {        // result.uuid        // result.parentUuid        // result.url        // result.path        // result.type      });    });

  ```

  saveMeta

  Overwrite the meta by loading it through uuid Parameters
• uuid **
• jsonString **
• cb ** Examples**

    ```js    Editor.assetdb.saveMeta( uuid, jsonString, function ( err, meta ) {      // do something    });

  ```

  exchangeUuid

  Exchange uuid for two assets Parameters
• urlA **
• urlB **
• cb **

  clearImports

  Clear imports Parameters
• url **
• cb ** Examples**

    ```js    Editor.assetdb.clearImports( 'db://assets/foo/bar.js', function ( err, results ) {      results.forEach(function ( result ) {        // result.uuid        // result.url        // result.path        // result.type      });    });

  ```

  register

  Register meta type Parameters
• extname **
• folder ** Whether it’s a folder type
• metaCtor ** Examples**

    ```js    Editor.assetdb.register( '.png', false, PngMeta );

  ```

  unregister

  Unregister meta type Parameters
• metaCtor ** Examples**

    ```js    Editor.assetdb.unregister( PngMeta );

  ```

  getRelativePath

  Get the relative path from mount path to the asset by fspath Parameters
• fspath the relative path from mount path to the asset

  getAssetBackupPath

  get the backup file path of asset file Parameters
• filePath ** asset file path