Skip to main content

Editor.Model.InspectableMeta

Class

Metadata for an inspectable object, providing display caption and icon for use in the Editor UI.

Index

Example

// InspectableMeta exposes a human-readable caption and an icon for any
// inspectable entity. Look it up via IEntityRegistry.getMeta(typeName).
const registry = this.pluginSystem.findInterface(
Editor.Model.IEntityRegistry
) as Editor.Model.IEntityRegistry;

const meta = registry.getMeta('SceneObject') as Editor.Model.InspectableMeta;
console.log(`SceneObject caption: ${meta.caption}`);
console.log(`Has icon: ${!Editor.isNull(meta.icon)}`);

Extends

Extended by

Properties

caption

readonly caption: string

Read-only string label displayed for this inspectable in the Editor.


icon

readonly icon: Icon

Read-only icon associated with this inspectable in the Editor UI.


isAbstract

readonly isAbstract: boolean

Whether the entity can be created.

Inherited from

Meta.isAbstract

Methods

getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Meta.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Meta.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Meta.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

Meta.isSame