Editor Scripting API

    Class SceneBeta

    The entity which will be coverted into the Lens scene during project export. This scene will contan and own all objects and components in the Lens. This entity can be accessed via the current project’s model.project.scene.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    cacheFile fileMeta id layers mainCamera name renderOutput renderOverlayOutput renderPreviewOutput rootSceneObjects sceneObjects type

    Methods

    addSceneObject createSceneObject findComponents getDirectlyReferencedEntities getOwnedEntities getRootObjectIndex getTypeName instantiatePrefab isOfType isSame remapReferences reparentSceneObject

    Constructors

    Properties

    cacheFile: Path
    fileMeta: Editor.Model.AssetImportMetadata
    id: Uuid

    The unique id of the entity.

    layers: Layers

    This list of layers that exists within this scene.

    mainCamera: Camera

    The camera that renders renderOutput.

    name: string

    The name of the asset.

    renderOutput: RenderTarget

    The Editor.Assets.RenderTarget which this scene will be rendered to. See LensScripting.ScriptScene.

    renderOverlayOutput: RenderTarget

    The overlay Editor.Assets.RenderTarget which this scene will be rendered to. This will shown at full resolution to the device which opens the Lens.

    renderPreviewOutput: RenderTarget

    The preview Editor.Assets.RenderTarget which this scene will be rendered to. See LensScripting.ScriptScene.

    rootSceneObjects: SceneObject[]

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

    sceneObjects: SceneObject[]

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

    type: string

    The entity's type.

    Methods

    • Beta

      Parameters

      • type: string

      Returns boolean

    • 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

    • 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

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR