Class ObjectPrefab

A native asset that provides information for visual objects rendering. Learn more at LensScripting.ObjectPrefab. Import with Editor.Model.AssetManager#createNativeAsset.

Hierarchy (View Summary)

ObjectOwner
- ObjectPrefab

Properties

`Readonly`cacheFile

cacheFile: Path

`Readonly`fileMeta

fileMeta: Editor.Model.AssetImportMetadata

`Readonly`id

id: Uuid

The unique id of the entity.

lazyLoading

lazyLoading: boolean

`Readonly`meta

meta: Meta

`Readonly`name

name: string

The name of the asset.

`Readonly`prefabInstances

prefabInstances: SceneObject[]

retainAssets

retainAssets: boolean

`Readonly`rootSceneObjects

rootSceneObjects: SceneObject[]

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

`Readonly`sceneObjects

sceneObjects: SceneObject[]

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

`Readonly`type

type: string

The entity's type.

Methods

addSceneObject

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

createSceneObject

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

findComponents

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

getDirectlyReferencedEntities

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

Returns Entity[]
Inherited from ObjectOwner.getDirectlyReferencedEntities

`Static`getMeta

getMeta(): Meta
Returns Meta
Inherited from ObjectOwner.getMeta

getOwnedEntities

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

Returns Entity[]
Inherited from ObjectOwner.getOwnedEntities

getRootObjectIndex

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

`Static`getTypeName

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

getTypeName

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

isOfType

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

isSame

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

reparentSceneObject

reparentSceneObject(
    object: SceneObject,
    newParent: SceneObject,
    position?: number,
): void
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: SceneObject
- newParent: SceneObject
- Optionalposition: number
Returns void
Inherited from ObjectOwner.reparentSceneObject