Class AssetInstantiator

Plugin that instantiates assets into a scene by placing them as scene objects.

Hierarchy (View Summary)

IPlugin
- AssetInstantiator

Index

Constructors

Properties

id pluginSystem

Methods

getTypeName instantiate isOfType isSame prepareDependencies

Constructors

constructor

new AssetInstantiator(
pluginSystem: PluginSystem,
descriptor?: Descriptor,
): AssetInstantiator
Constructs an AssetInstantiator plugin instance with the given plugin system and optional descriptor.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns AssetInstantiator
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The plugin system instance this instantiator is registered with.

Methods

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPlugin.getTypeName

instantiate

instantiate(
    asset: Editor.Assets.Asset,
    scene: Scene,
    target: SceneObject,
): Prefabable[]
Instantiates an asset into a scene under the given target scene object, returning the created prefabable objects.
Parameters
- asset: Editor.Assets.Asset
- scene: Scene
- target: SceneObject
Returns Prefabable[]

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPlugin.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPlugin.isSame

prepareDependencies

prepareDependencies(
asset: Editor.Assets.Asset,
manager: AssetManager,
): Promise<Editor.Assets.Asset[]>
Resolves and prepares all asset dependencies required before instantiation, returning them as a promise.
Parameters
- asset: Editor.Assets.Asset
- manager: AssetManager
Returns Promise<Editor.Assets.Asset[]>