Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Asset

Base class for handling assets used in Creator.

You may want to override:

  • createNode
  • getset functions of _nativeAsset
  • Object._serialize
  • Object._deserialize

Hierarchy

Index

Constructors

constructor

  • newAsset(...args: ConstructorParameters<typeof CCObject>): Asset

Properties

__asyncLoadAssets__

__asyncLoadAssets__: boolean = false

__depends__

__depends__: any = null

__nativeDepend__

__nativeDepend__: any = null

__onLoadedInvoked__

__onLoadedInvoked__: boolean = false

Private _file

_file: any = null

_native

_native: string = ""

Serializable url for native asset. For internal usage.

default

""

_nativeUrl

_nativeUrl: string = ""

Private _ref

_ref: number = 0

_uuid

_uuid: string

loaded

loaded: boolean = true

Whether the asset is loaded or not

Static preventDeferredLoadDependents

preventDeferredLoadDependents: boolean = false

Indicates whether its dependent native assets can support deferred load if the owner scene (or prefab) is marked as asyncLoadAssets.

default

false

Static preventPreloadNativeObject

preventPreloadNativeObject: boolean = false

Indicates whether its native object should be preloaded from native url.

default

false

Accessors

Private nativeAsset

  • get nativeAsset(): any
  • set nativeAsset(obj: any): void
  • The underlying native asset of this asset if one is available.
    This property can be used to access additional details or functionality releated to the asset.
    This property will be initialized by the loader if _native is available.

    default

    null

    Returns any

  • The underlying native asset of this asset if one is available.
    This property can be used to access additional details or functionality releated to the asset.
    This property will be initialized by the loader if _native is available.

    default

    null

    Parameters

    • obj: any

    Returns void

nativeDep

  • get nativeDep(): undefined | { __isNative__: boolean; ext: string; uuid: string }

nativeUrl

  • get nativeUrl(): string
  • Returns the url of this asset's native object, if none it will returns an empty string.

    readonly

    Returns string

refCount

  • get refCount(): number

Methods

Private setRawAsset

  • setRawAsset(filename: string, inLibrary?: boolean): void
  • Set native file name for this asset.

    seealso

    nativeUrl

    Parameters

    • filename: string
    • Default value inLibrary: boolean = true

    Returns void

addRef

Optional createNode

decRef

  • decRef(autoRelease?: boolean): Asset
  • Reduce references of asset and it will be auto released when refCount equals 0.

    Parameters

    • Default value autoRelease: boolean = true

    Returns Asset

    itself

onLoaded

  • onLoaded(): void

Private serialize

  • serialize(): void

toString

  • toString(): string
  • Returns the string representation of the object.
    The Asset object overrides the toString() method of the Object object.
    JavaScript calls the toString() method automatically
    when an asset is to be represented as a text value or when a texture is referred to in a string concatenation.

    For assets of the native type, it will return this.nativeUrl.
    Otherwise, an empty string is returned.
    This method may be overwritten by subclasses.

    method

    toString

    Returns string

Static deserialize

  • deserialize(data: any): any

Generated using TypeDoc