Skip to main content

Editor.Model.EntityStructure

Class

Entity subclass representing the structural organization of entities within a scene.

Index

Example

// EntityStructure is the base class for structural sub-objects owned by
// components and assets (e.g. CameraClearColor, SurfaceOptions, AnimationClip).
// You don't construct one — you read/mutate it through its owner.
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;

const obj = scene.createSceneObject('CameraObj');
const camera = obj.addComponent('Camera') as Editor.Components.Camera;

// camera.clearColor is a CameraClearColor, which extends EntityStructure.
const clearColor: Editor.Model.EntityStructure = camera.clearColor;
console.log('EntityStructure typeName:', clearColor.getTypeName());

Extends

Extended by

Properties

id

readonly id: Uuid

The unique id of the entity.

Inherited from

Entity.id


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


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