类 PrefabImpl

En

This class is used to import prefabs.

Zh

该类用于导入预制体。

层级 (查看层级一览)

构造函数

constructor

属性

_id api data destroyedImmediately lock? name? url uuid DEBUG legacySceneOrPrefab v2 v3

访问器

cpuMemory deps destroyed gpuMemory id obsolute referenceCount cpuMemory gpuMemory

方法

_addReference _clearReference _removeReference _setCPUMemory _setCreateURL _setGPUMemory addDep addDeps create destroy event hasListener isCreateFromURL off offAll offAllCaller on once onLoad destroyUnusedResources

构造函数

constructor

属性

_id

_id: number = 0

api

api: IHierarchyParserAPI

En

The hierarchy parser API used to parse the prefab data.

Zh

用于解析预制体数据的层次结构 API。

data

data: any

En

The prefab data.

Zh

预制体数据。

destroyedImmediately

destroyedImmediately: boolean

En

Whether to delete the resource immediately when the reference count is 0.

Zh

是否在引用计数为0的时候立马删除他

可选lock

lock?: boolean

En

Whether to lock the resource, if true, the resource cannot be automatically released.

Zh

是否加锁，如果true为不能使用自动释放机制。

可选name

name?: string

En

The name of the resource.

Zh

资源名称。

url

url: string

En

The URL of the resource.

Zh

获取资源的URL地址。

uuid

uuid: string

En

The UUID of the resource.

Zh

获取资源的UUID。

静态DEBUG

DEBUG: boolean = false

En

Whether the debug mode is enabled.

Zh

是否开启调试模式。

静态legacySceneOrPrefab

legacySceneOrPrefab: IHierarchyParserAPI & {
    createByData(root: Sprite, uiView: any): Sprite;
    createComp(
        uiView: any,
        comp: Sprite,
        view: Sprite,
        dataMap: any[],
        initTool?: any,
    ): any;
}

静态v2

v2: IHierarchyParserAPI = null

静态v3

v3: IHierarchyParserAPI = HierarchyParser

访问器

cpuMemory

deps

destroyed

gpuMemory

id

obsolute

  • get obsolute(): boolean

    返回 boolean

    En

    If a cached resource observer is set to true, then:

      1. getRes will still return this resource;
      1. next time loading will ignore this cached resource and reload it.

    Zh

    如果设置一个已缓存的资源obsolute为true，则

    • 1）getRes仍然可以返回这个资源；
    • 2）下次加载时会忽略这个缓存而去重新加载。。
  • set obsolute(value: boolean): void

    参数

    • value: boolean

    返回 void

referenceCount

静态cpuMemory

静态gpuMemory

方法

_addReference

  • _addReference(count?: number): void

    参数

    • count: number = 1

      The amount by which to increment the reference count, default is 1.

    返回 void

    En

    Increments the reference count of the resource by the specified amount.

    Zh

    按指定数量增加资源的引用计数。

_clearReference

_removeReference

  • _removeReference(count?: number): void

    参数

    • count: number = 1

      The amount by which to decrement the reference count, default is 1.

    返回 void

    En

    Decrements the reference count of the resource by the specified amount. If the reference count reaches zero and certain conditions are met, the resource may be destroyed.

    Zh

    按指定数量减少资源的引用计数。如果引用计数达到零并且满足特定条件，资源可能会被销毁。

_setCPUMemory

_setCreateURL

  • _setCreateURL(url: string, uuid?: string): void

    参数

    • url: string

      The URL used to create the resource.

    • 可选uuid: string

      The optional UUID of the resource.

    返回 void

    En

    Sets the URL and UUID used to create this resource.

    Zh

    设置用于创建此资源的 URL 和 UUID。

_setGPUMemory

addDep

addDeps

create

  • create(options?: Record<string, any>, errors?: any[]): Node

    参数

    • 可选options: Record<string, any>

      Optional parameters for instance creation.

    • 可选errors: any[]

      Array to store any errors encountered during instance creation.

    返回 Node

    The prefab instance.

    En

    Create an instance of the prefab.

    Zh

    创建预制体的实例。

destroy

event

  • event(type: string, data?: any): boolean

    参数

    • type: string

      The type of event.

    • 可选data: any

      (Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.

    返回 boolean

    True if there are listeners for this event type, false otherwise.

    En

    Dispatch an event.

    Zh

    派发事件。

hasListener

  • hasListener(type: string): boolean

    参数

    • type: string

      The type of event.

    返回 boolean

    True if a listener of the specified type is registered, false otherwise.

    En

    Check if the EventDispatcher object has any listeners registered for a specific type of event.

    Zh

    检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

isCreateFromURL

  • isCreateFromURL(url: string): boolean

    参数

    • url: string

      The URL to check against the resource's creation URL.

    返回 boolean

    True if the resource is created from the specified URL, otherwise false.

    En

    Checks if the resource is created from the specified URL.

    Zh

    检查资源是否从指定的 URL 创建。

off

  • off(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

  • off(
        type: string,
        caller: any,
        listener?: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • 可选listener: Function

      The listener function.

    • 可选args: any[]

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove a listener from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除侦听器。

offAll

  • offAll(type?: string): EventDispatcher

    参数

    • 可选type: string

      (Optional) The type of event. If the value is null, all types of listeners on this object are removed.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Remove all listeners of the specified event type from the EventDispatcher object.

    Zh

    从 EventDispatcher 对象中删除指定事件类型的所有侦听器。

offAllCaller

on

  • on(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

  • on(type: string, caller: any, listener: Function, args?: any[]): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

once

  • once(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

  • once(
        type: string,
        caller: any,
        listener: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

onLoad

  • onLoad(): this

    返回 this

    En

    If the prefab is loaded from a url, call this method to enable management of the prefab by the resource manager.

    Zh

    如果预制体是从 URL 加载的，则调用此方法以启用资源管理器对预制体的管理。

静态destroyUnusedResources

显示设置

成员可见性

目录

构造函数
属性
访问器
方法