Class Preset

Base class for plugins that create pre-configured scene objects, assets, or components via the Add menu.

Hierarchy (View Summary)

IPlugin
- Preset

Index

Constructors

Properties

id pluginSystem

Methods

create createAsync getTypeName isOfType isSame

Constructors

constructor

new Preset(pluginSystem: PluginSystem, descriptor?: Descriptor): Preset
Constructs a new Preset instance for defining a custom editor preset that creates scene objects, assets, or components.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns Preset
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The plugin system instance used to resolve interface dependencies.

Methods

create

create(destination: Path | SceneObject, importSettings?: any): Entity
Synchronously creates and places a pre-configured entity at the given destination scene object or path.
Parameters
- destination: Path | SceneObject
- OptionalimportSettings: any
Returns Entity

createAsync

createAsync(
destination: Path | SceneObject,
importSettings?: any,
): Promise<Entity>
Asynchronously creates and places a pre-configured entity at the given destination scene object or path.
Parameters
- destination: Path | SceneObject
- OptionalimportSettings: any
Returns Promise<Entity>

getTypeName

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

Returns string
Inherited from IPlugin.getTypeName

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