Editor.Model.InspectableMeta
ClassMetadata for an inspectable object, providing display caption and icon for use in the Editor UI.
Index
Properties
Methods
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
readonlycaption:string
Read-only string label displayed for this inspectable in the Editor.
icon
readonlyicon:Icon
Read-only icon associated with this inspectable in the Editor UI.
isAbstract
readonlyisAbstract:boolean
Whether the entity can be created.
Inherited from
Methods
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean