Class ObjectPrefab

Represents reusable SceneObject hierarchy stored as a resource.

Remarks

Can be instantiated through script or brought into the scene by dragging from Asset Browser to Scene Hierarchy panel.

See

Prefabs guide.

Example

// Instantiate a prefab under a parent scene object
// @input Asset.ObjectPrefab prefab
// @input SceneObject parentObject
var newObject = script.prefab.instantiate(script.parentObject);
print("Prefab Instantiated: " + newObject.name);

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

name uniqueIdentifier

Methods

getTypeName instantiate instantiateAsync isOfType isSame

Constructors

Protectedconstructor

Properties

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

instantiate

  • instantiate(parent: SceneObject): SceneObject

    Creates and returns a new instance of this object hierarchy underneath the specified parent object. If parent is null, the object will be created with no parent.

    Parameters

    Returns SceneObject

instantiateAsync

  • instantiateAsync(
        parent: SceneObject,
        onSuccess: (sceneObject: SceneObject) => void,
        onFailure: (error: string) => void,
        onProgress: (progress: number) => void,
    ): void

    Instantiate a prefab asynchronously.

    Parameters

    • parent: SceneObject
    • onSuccess: (sceneObject: SceneObject) => void
    • onFailure: (error: string) => void
    • onProgress: (progress: number) => void

    Returns void

isOfType

  • isOfType(type: string): boolean

    Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR