Class Assets

The Assets Editor API

Hierarchy

Events
- Assets

Internal

add

add(asset: Asset): void
Adds asset to the list
Parameters
- asset: Asset
  The asset
Returns void
- Defined in src/assets.ts:329

clear

clear(): void
Removes all assets from the list

Returns void
- Defined in src/assets.ts:406

loadAll

loadAll(options?: { view?: string }): Promise<void>
Loads all assets in the current project / branch. Does not subscribe to realtime changes.
Parameters
- options: { view?: string } = {}
  - Optionalview?: string
    The desired view for the REST API e.g 'designer', 'shader-editor'. This might limit the assets returned to a smaller subset depending on the view.
Returns Promise<void>
- Defined in src/assets.ts:451

loadAllAndSubscribe

loadAllAndSubscribe(options?: { view?: string }): Promise<void>
Loads all assets in the current project / branch and subscribes to changes.
Parameters
- options: { view?: string } = {}
  - Optionalview?: string
    The desired view for the REST API e.g 'designer', 'shader-editor'. This might limit the assets returned to a smaller subset depending on the view.
Returns Promise<void>
- Defined in src/assets.ts:503

remove

remove(asset: Asset): void
Removes asset from the list
Parameters
- asset: Asset
  The asset
Returns void
- Defined in src/assets.ts:385

Other

constructor

new Assets(options?: { autoSubscribe?: boolean }): Assets
Constructor
Parameters
- options: { autoSubscribe?: boolean } = {}
  - OptionalautoSubscribe?: boolean
    Whether to auto subscribe to asset changes when assets are loaded.
Returns Assets
Overrides Events.constructor
- Defined in src/assets.ts:170

defaultUploadCompletedCallback

get defaultUploadCompletedCallback(): (uploadId: number, asset: Asset) => any
Gets the default callback called when on asset upload succeeds.

Returns (uploadId: number, asset: Asset) => any
- Defined in src/assets.ts:1055
set defaultUploadCompletedCallback(
value: (uploadId: number, asset: Asset) => any,
): void
Sets the default callback called when on asset upload succeeds. The function takes 2 arguments: the upload id, and the new asset.
Parameters
- value: (uploadId: number, asset: Asset) => any
Returns void
- Defined in src/assets.ts:1048

defaultUploadErrorCallback

get defaultUploadErrorCallback(): (uploadId: number, error: Error) => any
Gets the default callback called when on asset upload fails.

Returns (uploadId: number, error: Error) => any
- Defined in src/assets.ts:1085
set defaultUploadErrorCallback(
value: (uploadId: number, error: Error) => any,
): void
Sets the default callback called when on asset upload progress. The function takes 2 arguments: the upload id, and the error.
Parameters
- value: (uploadId: number, error: Error) => any
Returns void
- Defined in src/assets.ts:1078

defaultUploadProgressCallback

get defaultUploadProgressCallback(): (uploadId: number, progress: number) => any
Gets the default callback called when on asset upload progress.

Returns (uploadId: number, progress: number) => any
- Defined in src/assets.ts:1070
set defaultUploadProgressCallback(
value: (uploadId: number, progress: number) => any,
): void
Sets the default callback called when on asset upload progress. The function takes 2 arguments: the upload id and the progress.
Parameters
- value: (uploadId: number, progress: number) => any
Returns void
- Defined in src/assets.ts:1063

parseScriptCallback

get parseScriptCallback(): (asset: Asset) => any
Gets the callback which parses script assets.

Returns (asset: Asset) => any
- Defined in src/assets.ts:1102
set parseScriptCallback(value: (asset: Asset) => any): void
Sets the callback which parses script assets. When this callback is set, new script assets will be parsed after they are created. The function takes the asset as a parameter and returns a promise with a list of script names when it is done parsing.
Parameters
- value: (asset: Asset) => any
Returns void
- Defined in src/assets.ts:1095

createAnimStateGraph

createAnimStateGraph(
    options?: {
        data?: object;
        folder?: Asset;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
    },
): Promise<Asset>
Creates new anim state graph asset.
Parameters
- options: {
      data?: object;
      folder?: Asset;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
  } = {}
  - Optionaldata?: object
    The asset data. See Asset for Animstategraph data.
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:623

createBundle

createBundle(
    options?: {
        assets?: any[];
        folder?: Asset;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
    },
): Promise<Asset>
Creates new bundle asset
Parameters
- options: {
      assets?: any[];
      folder?: Asset;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
  } = {}
  - Optionalassets?: any[]
    The assets that the bundle will contain
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:643

createCss

createCss(
    options?: {
        folder?: Asset;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
        text?: string;
    },
): Promise<Asset>
Creates new CSS asset
Parameters
- options: {
      folder?: Asset;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
      text?: string;
  } = {}
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
  - Optionaltext?: string
    The CSS
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:665

createCubemap

createCubemap(
    options?: {
        anisotropy?: number;
        folder?: Asset;
        magFilter?: number;
        minFilter?: number;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
        textures?: any[];
    },
): Promise<Asset>
Creates new cubemap asset
Parameters
- options: {
      anisotropy?: number;
      folder?: Asset;
      magFilter?: number;
      minFilter?: number;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
      textures?: any[];
  } = {}
  - Optionalanisotropy?: number
    Cubemap anisotropy value. Defaults to 1.
  - Optionalfolder?: Asset
    The parent folder asset
  - OptionalmagFilter?: number
    Cubemap magFilter value. Defaults to pc.FILTER_LINEAR.
  - OptionalminFilter?: number
    Cubemap minFilter value. Defaults to pc.FILTER_LINEAR_MIPMAP_LINEAR.
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
  - Optionaltextures?: any[]
    The textures for each cubemap face in this order: right, left, up, down, front, back
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:690

createFolder

createFolder(
options: { folder?: Asset; name?: string; onProgress?: Function },
): Promise<Asset>
Creates a new folder asset
Parameters
- options: { folder?: Asset; name?: string; onProgress?: Function }
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:719

createHtml

createHtml(
    options?: {
        folder?: Asset;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
        text?: string;
    },
): Promise<Asset>
Creates new HTML asset
Parameters
- options: {
      folder?: Asset;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
      text?: string;
  } = {}
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
  - Optionaltext?: string
    The HTML
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:737

createI18n

createI18n(
    options?: {
        folder?: Asset;
        localizationData?: object;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
    },
): Promise<Asset>
Creates new localization JSON asset
Parameters
- options: {
      folder?: Asset;
      localizationData?: object;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
  } = {}
  - Optionalfolder?: Asset
    The parent folder asset
  - OptionallocalizationData?: object
    The localization data. If null then default data will be used.
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:784

createJson

createJson(
    options?: {
        folder?: Asset;
        json?: object;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
        spaces?: number;
    },
): Promise<Asset>
Creates new JSON asset
Parameters
- options: {
      folder?: Asset;
      json?: object;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
      spaces?: number;
  } = {}
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionaljson?: object
    The JSON
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
  - Optionalspaces?: number
    The number of spaces used for indentation. Defaults to 0 (tightly packed output).
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:760

createMaterial

createMaterial(
    options?: {
        data?: Record<string, any>;
        folder?: Asset;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
    },
): Promise<Asset>
Creates new material asset
Parameters
- options: {
      data?: Record<string, any>;
      folder?: Asset;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
  } = {}
  - Optionaldata?: Record<string, any>
    The material data. Default values will be used for missing fields. See Asset for material data.
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:818

createScript

createScript(
    options?: {
        data?: object;
        filename?: string;
        folder?: Asset;
        onProgress?: Function;
        preload?: boolean;
        text?: string;
    },
): Promise<Asset>
Creates new script asset
Parameters
- options: {
      data?: object;
      filename?: string;
      folder?: Asset;
      onProgress?: Function;
      preload?: boolean;
      text?: string;
  } = {}
  - Optionaldata?: object
    The script data. See Asset for Script data.
  - Optionalfilename?: string
    The filename of the script. This will also be the name of the script asset. If not defined it will be generated from the name of the script.
  - Optionalfolder?: Asset
    The parent folder asset
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
  - Optionaltext?: string
    The contents of the script. If none then boilerplate code will be used.
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:849

createShader

createShader(
    options?: {
        folder?: Asset;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
        text?: string;
    },
): Promise<Asset>
Creates new shader asset
Parameters
- options: {
      folder?: Asset;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
      text?: string;
  } = {}
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
  - Optionaltext?: string
    The GLSL
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:908

createSprite

createSprite(
    options?: {
        folder?: Asset;
        frameKeys?: any[];
        name?: string;
        onProgress?: Function;
        pixelsPerUnit?: number;
        preload?: boolean;
        renderMode?: number;
        textureAtlas?: Asset;
    },
): Promise<Asset>
Creates new sprite asset
Parameters
- options: {
      folder?: Asset;
      frameKeys?: any[];
      name?: string;
      onProgress?: Function;
      pixelsPerUnit?: number;
      preload?: boolean;
      renderMode?: number;
      textureAtlas?: Asset;
  } = {}
  - Optionalfolder?: Asset
    The parent folder asset
  - OptionalframeKeys?: any[]
    The sprite's frame keys
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - OptionalpixelsPerUnit?: number
    The sprite's pixels per unit value. Defaults to 100.
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
  - OptionalrenderMode?: number
    The sprite's render mode. Defaults to pc.SPRITE_RENDERMODE_SIMPLE.
  - OptionaltextureAtlas?: Asset
    The sprite's texture atlas asset
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:932

createTemplate

createTemplate(
    options: {
        entity: Entity;
        folder?: Asset;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
    },
): Promise<void>
Creates new template asset
Parameters
- options: {
      entity: Entity;
      folder?: Asset;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
  }
  - entity: Entity
    The entity to create the template from
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
Returns Promise<void>
The new asset
- Defined in src/assets.ts:979

createText

createText(
    options?: {
        folder?: Asset;
        name?: string;
        onProgress?: Function;
        preload?: boolean;
        text?: string;
    },
): Promise<Asset>
Creates new text asset
Parameters
- options: {
      folder?: Asset;
      name?: string;
      onProgress?: Function;
      preload?: boolean;
      text?: string;
  } = {}
  - Optionalfolder?: Asset
    The parent folder asset
  - Optionalname?: string
    The asset name
  - OptionalonProgress?: Function
    Function to report progress
  - Optionalpreload?: boolean
    Whether to preload the asset. Defaults to true.
  - Optionaltext?: string
    The text
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:958

delete

delete(assets: Asset[]): Promise<void>
Deletes specified assets
Parameters
- assets: Asset[]
  The assets
Returns Promise<void>
- Defined in src/assets.ts:1005

filter

filter(fn: Function): any[]
Gets assets that satisfy function
Parameters
- fn: Function
  The function (takes an asset as an argument and returns boolean).
Returns any[]
The assets
- Defined in src/assets.ts:426

findOne

findOne(fn: Function): any
Finds first asset that satisfies function
Parameters
- fn: Function
  A function that takes an asset as an argument and returns boolean.
Returns any
The asset
- Defined in src/assets.ts:438

get

get(id: number): Asset
Gets asset by id
Parameters
- id: number
  The asset id
Returns Asset
The asset
- Defined in src/assets.ts:263

getAssetForScript

getAssetForScript(script: string): any
Gets the first script asset that contains the specified script
Parameters
- script: string
  The script name
Returns any
The script asset
- Defined in src/assets.ts:561

getUnique

getUnique(uniqueId: number): Asset
Gets asset by its unique id
Parameters
- uniqueId: number
  The unique id
Returns Asset
The asset
- Defined in src/assets.ts:274

instantiateTemplates

instantiateTemplates(
    assets: Asset[],
    parent: Entity,
    options?: {
        extraData?: object;
        history?: boolean;
        index?: number;
        select?: boolean;
    },
): Promise<Entity[]>
Instantiates the specified template assets under the specified parent entity.
Parameters
- assets: Asset[]
  The template assets.
- parent: Entity
  The parent entity
- options: { extraData?: object; history?: boolean; index?: number; select?: boolean } = {}
  - OptionalextraData?: object
    Extra data passed to the backend. Used by the Editor on specific cases.
  - Optionalhistory?: boolean
    Whether to record a history action.
  - Optionalindex?: number
    The desired index under the parent to instantiate the templates.
  - Optionalselect?: boolean
    Whether to select the new entities.
Returns Promise<Entity[]>
The new entities
- Defined in src/assets.ts:1036

list

list(): Asset[]
Returns array of all assets

Returns Asset[]
The assets
- Defined in src/assets.ts:284

listByTag

listByTag(...tags: any[]): any[]
Finds all assets with specified tags
Parameters
- ...tags: any[]
  The tags. If multiple tags are specified then assets that contain ANY of the specified tags will be included. If an argument is an array of tags then assets that contain ALL of the tags in the array will be included.
Returns any[]
The assets
- Defined in src/assets.ts:295

upload

upload(
    data: AssetUploadArguments,
    settings?: TextureImportSettings | SceneImportSettings,
    onProgress?: Function,
): Promise<Asset>
Creates new asset
Parameters
- data: AssetUploadArguments
  The asset fields
- settings: TextureImportSettings | SceneImportSettings = {}
  Import settings
- onProgress: Function = null
  Function to report progress
Returns Promise<Asset>
The new asset
- Defined in src/assets.ts:576

Class Assets

Hierarchy

Index

Internal

Other

Internal

add

Parameters

Returns void

clear

Returns void

loadAll

Parameters

Optionalview?: string

Returns Promise<void>

loadAllAndSubscribe

Parameters

Optionalview?: string

Returns Promise<void>

remove

Parameters

Returns void

Other

constructor

Parameters

OptionalautoSubscribe?: boolean

Returns Assets

defaultUploadCompletedCallback

Returns (uploadId: number, asset: Asset) => any

Parameters

Returns void

defaultUploadErrorCallback

Returns (uploadId: number, error: Error) => any

Parameters

Returns void

defaultUploadProgressCallback

Returns (uploadId: number, progress: number) => any

Parameters

Returns void

parseScriptCallback

Returns (asset: Asset) => any

Parameters

Returns void

createAnimStateGraph

Parameters

Optionaldata?: object

Optionalfolder?: Asset

Optionalname?: string

OptionalonProgress?: Function

Optionalpreload?: boolean

Returns Promise<Asset>

createBundle

Parameters

Optionalassets?: any[]

Optionalfolder?: Asset

Optionalname?: string

OptionalonProgress?: Function

Optionalpreload?: boolean

Returns Promise<Asset>

createCss

Parameters

Optionalfolder?: Asset

Optionalname?: string

OptionalonProgress?: Function

Optionalpreload?: boolean

Optionaltext?: string

Returns Promise<Asset>

createCubemap

Parameters

Optionalanisotropy?: number

Optionalfolder?: Asset

OptionalmagFilter?: number

OptionalminFilter?: number

Optionalname?: string

OptionalonProgress?: Function

Optionalpreload?: boolean

Optionaltextures?: any[]

Returns Promise<Asset>

createFolder

Parameters

`Optional`view?: string

`Optional`view?: string

`Optional`autoSubscribe?: boolean

`Optional`data?: object

`Optional`folder?: Asset

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`assets?: any[]

`Optional`folder?: Asset

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`folder?: Asset

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`text?: string

`Optional`anisotropy?: number

`Optional`folder?: Asset

`Optional`magFilter?: number

`Optional`minFilter?: number

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`textures?: any[]

`Optional`folder?: Asset

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`folder?: Asset

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`text?: string

`Optional`folder?: Asset

`Optional`localizationData?: object

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`folder?: Asset

`Optional`json?: object

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`spaces?: number

`Optional`data?: Record<string, any>

`Optional`folder?: Asset

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`data?: object

`Optional`filename?: string

`Optional`folder?: Asset

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`text?: string

`Optional`folder?: Asset

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`preload?: boolean

`Optional`text?: string

`Optional`folder?: Asset

`Optional`frameKeys?: any[]

`Optional`name?: string

`Optional`onProgress?: Function

`Optional`pixelsPerUnit?: number

`Optional`preload?: boolean

`Optional`renderMode?: number

`Optional`textureAtlas?: Asset

`Optional`folder?: Asset

`Optional`name?: string