editor.browser

Content Browser navigation and operations

← API Reference

editor.browser.syncToAssets

Syncs the content browser to display specified assets.

Name Type Required Description
asset_pathsarrayYesArray of asset paths to sync to

Returns

Field Type Description
successboolWhether sync succeeded
synced_countnumberNumber of assets synced

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.browser.syncToAssets", "params": { "asset_paths": ["/Game/Materials/M_Gold"] } }

editor.browser.navigateToFolder

Navigates the content browser to a specific folder.

Name Type Required Description
folder_pathstringYesContent folder path (e.g. "/Game/Materials")

Returns

Field Type Description
successboolWhether navigation succeeded
folder_pathstringFolder path

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.browser.navigateToFolder", "params": { "folder_path": "/Game/Materials" } }

editor.browser.getSelection

Returns currently selected assets in the content browser.

No parameters.

Returns

Field Type Description
assetsarrayEach: {asset_path, asset_class, asset_name}
countnumberNumber of selected assets

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.browser.getSelection" }

editor.browser.search

Searches the content browser with a query string.

Name Type Required Description
querystringYesSearch query

Returns

Field Type Description
successboolWhether search was initiated
querystringSearch query

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.browser.search", "params": { "query": "M_Gold" } }

editor.browser.getCollections

Returns all available asset collections.

No parameters.

Returns

Field Type Description
collectionsarrayEach: {collection_name, collection_type}
countnumberNumber of collections

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.browser.getCollections" }

editor.browser.createCollection

Creates a new asset collection.

Name Type Required Description
namestringYesCollection name
typestringNo"local", "private", or "shared" (default "local")

Returns

Field Type Description
successboolWhether collection was created
collection_namestringCollection name
collection_typestringCollection type

Example Request

{ "jsonrpc": "2.0", "id": 1, "method": "editor.browser.createCollection", "params": { "name": "Hero Assets", "type": "local" } }

editor.browser.addToCollection

Adds assets to a collection.

Name Type Required Description
collection_namestringYesCollection name
asset_pathsarrayYesArray of asset paths to add
collection_typestringNo"local", "private", or "shared" (default "local")

Returns

Field Type Description
successboolWhether assets were added
assets_addednumberNumber of assets added

Example Request

{
  "jsonrpc": "2.0", "id": 1, "method": "editor.browser.addToCollection",
  "params": { "collection_name": "Hero Assets", "asset_paths": ["/Game/Meshes/SM_Hero", "/Game/Materials/M_Hero"] }
}

editor.browser.removeFromCollection

Removes assets from a collection.

Name Type Required Description
collection_namestringYesCollection name
asset_pathsarrayYesArray of asset paths to remove
collection_typestringNo"local", "private", or "shared" (default "local")

Returns

Field Type Description
successboolWhether assets were removed
assets_removednumberNumber of assets removed

Example Request

{
  "jsonrpc": "2.0", "id": 1, "method": "editor.browser.removeFromCollection",
  "params": { "collection_name": "Hero Assets", "asset_paths": ["/Game/Meshes/SM_Hero"] }
}