Interface ObjectPrefab`Beta`

A native asset that provides information for visual objects rendering. Learn more at "Lens Scripting".Built-In.ObjectPrefab. Import with Editor.Model.AssetManager.createNativeAsset.

interface ObjectPrefab {
    fileMeta: AssetImportMetadata;
    id: Uuid;
    lazyLoading: boolean;
    name: string;
    prefabInstances: Editor.Model.SceneObject[];
    retainAssets: boolean;
    rootSceneObjects: Editor.Model.SceneObject[];
    sceneObjects: Editor.Model.SceneObject[];
    type: string;
    addSceneObject(parent: Editor.Model.SceneObject): Editor.Model.SceneObject;
    createSceneObject(name: string): Editor.Model.SceneObject;
    findComponents(entityType: string): Editor.Components.Component[];
    getDirectlyReferencedEntities(): Entity[];
    getOwnedEntities(): Entity[];
    getRootObjectIndex(object: Editor.Model.SceneObject): number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    remapReferences(referenceMapping: object): void;
    reparentSceneObject(object: Editor.Model.SceneObject, newParent: Editor.Model.SceneObject, position?: number): void;
}

Hierarchy (view full)

ObjectOwner
- ObjectPrefab

Properties

`Readonly` `Beta`fileMeta

fileMeta: AssetImportMetadata

`Readonly` `Beta`id

id: Uuid

The unique id of the entity.

`Beta`lazyLoading

lazyLoading: boolean

`Readonly` `Beta`name

name: string

The name of the asset.

`Readonly` `Beta`prefabInstances

prefabInstances: Editor.Model.SceneObject[]

`Beta`retainAssets

retainAssets: boolean

`Readonly` `Beta`rootSceneObjects

rootSceneObjects: Editor.Model.SceneObject[]

A list of scene objects which is a direct child of this entity.

`Readonly` `Beta`sceneObjects

sceneObjects: Editor.Model.SceneObject[]

A list of scene objects which is a child of this entity.

`Readonly` `Beta`type

type: string

The entity's type.

Methods

addSceneObject

addSceneObject(parent): Editor.Model.SceneObject
Beta
Adds a scene object to the entity.
Parameters
- parent: Editor.Model.SceneObject
Returns Editor.Model.SceneObject
Inherited from ObjectOwner.addSceneObject

createSceneObject

createSceneObject(name): Editor.Model.SceneObject
Beta
Creates a scene object to the entity.
Parameters
- name: string
Returns Editor.Model.SceneObject
Inherited from ObjectOwner.createSceneObject

findComponents

findComponents(entityType): Editor.Components.Component[]
Beta
Find components on the entity.
Parameters
- entityType: string
Returns Editor.Components.Component[]
Inherited from ObjectOwner.findComponents

getDirectlyReferencedEntities

getDirectlyReferencedEntities(): Entity[]
Beta
A list of entities which this entity has a reference to.

Returns Entity[]
Inherited from ObjectOwner.getDirectlyReferencedEntities

getOwnedEntities

getOwnedEntities(): Entity[]
Beta
A list of entities which has a reference to this entity.

Returns Entity[]
Inherited from ObjectOwner.getOwnedEntities

getRootObjectIndex

getRootObjectIndex(object): number
Beta
Get the index of object within the list of all the root objects.
Parameters
- object: Editor.Model.SceneObject
Returns number
Inherited from ObjectOwner.getRootObjectIndex

getTypeName

getTypeName(): string
Beta
Returns string
Inherited from ObjectOwner.getTypeName

isOfType

isOfType(type): boolean
Beta
Parameters
- type: string
Returns boolean
Inherited from ObjectOwner.isOfType

isSame

isSame(other): boolean
Beta
Parameters
- other: ScriptObject
Returns boolean
Inherited from ObjectOwner.isSame

remapReferences

remapReferences(referenceMapping): void
Beta
Swap this entity for another one based on a JSON of the current entity id and the target entity id.
Parameters
- referenceMapping: object
Returns void
Inherited from ObjectOwner.remapReferences

reparentSceneObject

reparentSceneObject(object, newParent, position?): void
Beta
Reparent the scene object to another scene object. You can use this to reparent objects to the root (i.e. pass in null).
Parameters
- object: Editor.Model.SceneObject
- newParent: Editor.Model.SceneObject
- Optionalposition: number
Returns void
Inherited from ObjectOwner.reparentSceneObject