Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Prefab

Prefab资源。

export

Hierarchy

  • PrefabLike<PrefabResourceDescription>
    • Prefab

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Prefab(description: DeepImmutableObject<IPrefabResourceDescription>): Prefab

  • 从资源配置中实例化Prefab资源。

    memberof

    Prefab

    Parameters

    • description: DeepImmutableObject<IPrefabResourceDescription>

      资源配置。

    Returns Prefab

Properties

Readonly description

description: DeepImmutableObject<IPrefabResourceDescription>

Optional groupID

groupID: string

Optional resourceID

resourceID: string

编辑器中使用的资源id。

memberof

BaseResource

Optional scripts

scripts: string[]

uuidToBufferMap

uuidToBufferMap: {} = {}

Type declaration

  • [uuid: string]: ArrayBuffer

Accessors

data

  • get data(): T

  • Returns T

meta

  • get meta(): T["meta"]

  • Prefab资源的额外描述。

    readonly
    memberof

    Prefab

    Returns T["meta"]

Methods

instantiate

  • instantiate(componentsOut?: any[]): Entity

  • 实例化Prefab资源。

    memberof

    Prefab

    Parameters

    • Optional componentsOut: any[]

    Returns Entity

instantiateWithPrefabInfo

  • instantiateWithPrefabInfo(prefabInstanceID?: string): Entity

  • 实例化一个prefab，并把__type、__prefab、__prefabInstanceLocalID等信息加到entity上
    一般用于工具中的addPrefab功能，若在runtime或game模式运行，则回退成instantiate的能力。

    Parameters

    • Optional prefabInstanceID: string

    Returns Entity

Static DeserializeResource

  • DeserializeResource(description: DeepImmutableObject<IPrefabResourceDescription>, loadContext: default, dependencies: string[]): Prefab

  • Parameters

    • description: DeepImmutableObject<IPrefabResourceDescription>
    • loadContext: default
    • dependencies: string[]

    Returns Prefab

Generated using TypeDoc