Class EntityGenerator

Plugin that generates a new Entity in the scene.

Hierarchy (View Summary)

IPlugin
- EntityGenerator

Index

Constructors

Properties

id pluginSystem

Methods

generate getTypeName isOfType isSame

Constructors

constructor

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

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The PluginSystem instance associated with this plugin.

Methods

generate

generate(): Promise<Entity>
Generates a new Entity and returns it as a Promise.

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