Skip to main content

Editor.Model.Prefabable

Class

An entity which can be turned into a prefab, such as Editor.Model.SceneObject.

Index

Example

const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

// Prefabable is the base class for SceneObject and Component.
// Walk scene objects — each is a Prefabable.
const allObjects = scene.sceneObjects;
for (const obj of allObjects) {
const components = obj.getComponentsCount();
console.log(`SceneObject "${obj.name}" has ${components} component(s)`);
}

// Static helpers
const typeName = Editor.Model.Prefabable.getTypeName();
console.log('Prefabable typeName:', typeName);

Extends

Extended by

Properties

hasPrefabChanges

readonly hasPrefabChanges: boolean

Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Entity.id


isPrefabInstanceRoot

readonly isPrefabInstanceRoot: boolean

Whether this entity is the root of a prefab instance.


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

Entity.meta


type

readonly type: string

The entity's type.

Inherited from

Entity.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

Entity.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

Entity.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

Entity.getOwnedEntities


getPrefabInstanceRoot()

getPrefabInstanceRoot(): Prefabable

Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.

Returns

Prefabable


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Entity.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Entity.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Entity.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Entity.isSame