Class SceneObject`Beta`

The same entity as in Lens Scripting. Can contain one or more Editor.Components.Component. Additionally, it can have zero or more scene objects which is a child of it.

See

LensScripting.SceneObject.

Hierarchy (View Summary, Expand)

Prefabable
- SceneObject

Constructors

`Protected`constructor

new SceneObject(): SceneObject
Beta
Returns SceneObject
Overrides Prefabable.constructor

Properties

`Beta`children

children: SceneObject[]

A list of scene objects that is a child of this scene object.

`Beta`components

components: Component[]

A list of components that is a child of this scene object.

`Beta`enabled

enabled: boolean

Whether this scene object is enabled or disabled.

`Readonly` `Beta`hasVisuals

hasVisuals: boolean

Whether this scene object contains any component which is of type Editor.Components.Visual.

`Readonly` `Beta`id

id: Uuid

The unique id of the entity.

`Beta`layer

layer: LayerId

The layer that this scene object is on.

`Beta`layers

layers: LayerSet

The layerSet this scene object is on.

`Beta`localTransform

localTransform: Transform

The transform of this scene object relative to its parent.

`Beta`name

name: string

The name of the scene object.

`Readonly` `Beta`topOwner

topOwner: ObjectOwner

`Readonly` `Beta`type

type: string

The entity's type.

`Beta`worldTransform

worldTransform: Transform

The transform of this scene object relative to the scene its in.

Methods

addChildAt

addChildAt(value: SceneObject, pos?: number): void
Beta
Add a scene object as a child of this object at a specified pos.
Parameters
- value: SceneObject
- Optionalpos: number
Returns void

addComponent

addComponent(entityType: string): Component
Beta
Add a new Editor.Components.Component by entityType to this object..
Parameters
- entityType: string
Returns Component

addComponentAt

addComponentAt(value: Component, pos?: number): void
Beta
Add the component value at the specified pos.
Parameters
- value: Component
- Optionalpos: number
Returns void

clearChildren

clearChildren(): void
Beta
Remove all children from this object.

Returns void

clearComponents

clearComponents(): void
Beta
Remove all components from this scene object.

Returns void

`Static`commonParent

commonParent(sceneObjects: SceneObject[]): SceneObject
Beta
Parameters
- sceneObjects: SceneObject[]
Returns SceneObject

copy

copy(): SceneObject
Beta
Returns SceneObject

destroy

destroy(): void
Beta
Destroy this scene object. All references to it becomes invalid.

Returns void

getChildAt

getChildAt(pos: number): SceneObject
Beta
Get a specific object at the specified pos.
Parameters
- pos: number
Returns SceneObject

getChildrenCount

getChildrenCount(): number
Beta
Get the number of children on this object.

Returns number

getComponent

getComponent<K extends keyof ComponentNameMap>(
entityType: string,
): ComponentNameMap[K]
Beta
Get the first component of entityType.
Type Parameters
- K extends keyof ComponentNameMap
Parameters
- entityType: string
Returns ComponentNameMap[K]

getComponentAt

getComponentAt(pos: number): Component
Beta
Get the component at the specified pos.
Parameters
- pos: number
Returns Component

getComponents

getComponents<K extends keyof ComponentNameMap>(
entityType: string,
): ComponentNameMap[K][]
Beta
Get all the components of entityType on this object.
Type Parameters
- K extends keyof ComponentNameMap
Parameters
- entityType: string
Returns ComponentNameMap[K][]

getComponentsCount

getComponentsCount(): number
Beta
Get the number of components on this object.

Returns number

getDirectlyReferencedEntities

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

Returns Entity[]
Inherited from Prefabable.getDirectlyReferencedEntities

getOwnedEntities

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

Returns Entity[]
Inherited from Prefabable.getOwnedEntities

getParent

getParent(): SceneObject
Beta
Get the parent of this scene object.

Returns SceneObject

getTypeName

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

indexOfChild

indexOfChild(value: SceneObject): number
Beta
Get the position of a specific object, if the object is a child of this object.
Parameters
- value: SceneObject
Returns number

indexOfComponent

indexOfComponent(value: Component): number
Beta
Get the position of a specific component value on this object.
Parameters
- value: Component
Returns number

isOfType

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

isSame

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

moveChild

moveChild(child: SceneObject, destination: number): void
Beta
Move child in the order of children on this object.
Parameters
- child: SceneObject
- destination: number
Returns void

moveComponent

moveComponent(origin: number, destination: number): void
Beta
Move the component value to a specified pos.
Parameters
- origin: number
- destination: number
Returns void

remapReferences

remapReferences(referenceMapping: object): 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 Prefabable.remapReferences

removeChild

removeChild(child: SceneObject): void
Beta
Remove a child from this from this scene object.
Parameters
- child: SceneObject
Returns void

removeChildAt

removeChildAt(pos: number): void
Beta
Remove a child at the specified pos.
Parameters
- pos: number
Returns void

removeComponent

removeComponent(entityType: string): boolean
Beta
Remove the first component of entityType from this object.
Parameters
- entityType: string
Returns boolean

removeComponentAt

removeComponentAt(pos: number): void
Beta
Remove the components at the specified pos.
Parameters
- pos: number
Returns void

setChildAt

setChildAt(pos: number, value: SceneObject): void
Beta
Set the child scene object value to be at the specified pos.
Parameters
- pos: number
- value: SceneObject
Returns void

setComponentAt

setComponentAt(pos: number, value: Component): void
Beta
Set the component value to be at the specified pos.
Parameters
- pos: number
- value: Component
Returns void

setParent

setParent(newParent: SceneObject, position?: number): void
Beta
Set the parent of this scene object.
Parameters
- newParent: SceneObject
- Optionalposition: number
Returns void

`Static`topLevel

topLevel(sceneObjects: SceneObject[]): SceneObject[]
Beta
Parameters
- sceneObjects: SceneObject[]
Returns SceneObject[]

Class SceneObjectBeta

See

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Returns SceneObject

Properties

Betachildren

Betacomponents

Betaenabled

Readonly BetahasVisuals

Readonly Betaid

Betalayer

Betalayers

BetalocalTransform

Betaname

Readonly BetatopOwner

Readonly Betatype

BetaworldTransform

Methods

addChildAt

Parameters

Returns void

addComponent

Parameters

Returns Component

addComponentAt

Parameters

Returns void

clearChildren

Returns void

clearComponents

Returns void

StaticcommonParent

Parameters

Returns SceneObject

copy

Returns SceneObject

destroy

Returns void

getChildAt

Parameters

Returns SceneObject

getChildrenCount

Returns number

getComponent

Type Parameters

Parameters

Returns ComponentNameMap[K]

getComponentAt

Parameters

Returns Component

getComponents

Type Parameters

Parameters

Returns ComponentNameMap[K][]

getComponentsCount

Returns number

getDirectlyReferencedEntities

Returns Entity[]

getOwnedEntities

Returns Entity[]

getParent

Returns SceneObject

getTypeName

Returns string

indexOfChild

Parameters

Returns number

indexOfComponent

Parameters

Returns number

isOfType

Parameters

Returns boolean

isSame

Class SceneObject`Beta`

`Protected`constructor

`Beta`children

`Beta`components

`Beta`enabled

`Readonly` `Beta`hasVisuals

`Readonly` `Beta`id

`Beta`layer

`Beta`layers

`Beta`localTransform

`Beta`name

`Readonly` `Beta`topOwner

`Readonly` `Beta`type

`Beta`worldTransform

`Static`commonParent

`Static`topLevel