Class Assets

The Assets Editor API

Hierarchy

  • Events
    • Assets

Internal

add clear loadAll loadAllAndSubscribe remove

Other

constructor defaultUploadCompletedCallback defaultUploadErrorCallback defaultUploadProgressCallback parseScriptCallback createAnimStateGraph createBundle createCss createCubemap createFolder createHtml createI18n createJson createMaterial createScript createShader createSprite createTemplate createText delete filter findOne get getAssetForScript getUnique instantiateTemplates list listByTag upload

Internal

add

clear

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>

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>

remove

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

defaultUploadCompletedCallback

  • get defaultUploadCompletedCallback(): (uploadId: number, asset: Asset) => any

  • Gets the default callback called when on asset upload succeeds.

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

  • 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

defaultUploadErrorCallback

  • get defaultUploadErrorCallback(): (uploadId: number, error: Error) => any

  • Gets the default callback called when on asset upload fails.

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

  • 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

defaultUploadProgressCallback

  • get defaultUploadProgressCallback(): (uploadId: number, progress: number) => any

  • Gets the default callback called when on asset upload progress.

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

  • 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

parseScriptCallback

  • get parseScriptCallback(): (asset: Asset) => any

  • Gets the callback which parses script assets.

    Returns (asset: Asset) => any

  • 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

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

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

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

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

createFolder

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

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

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

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

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

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

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

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

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

delete

filter

findOne

get

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

getUnique

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

list

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

upload

Settings

Member Visibility

On This Page

Internal
Other