Interface ObjectPrefab

A reusable object hierarchy stored as a resource. Can be instantiated through script or brought into the scene through Lens Studio. For more information, see the 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);
interface ObjectPrefab {
    name: string;
    uniqueIdentifier: string;
    getTypeName(): string;
    instantiate(parent: SceneObject): SceneObject;
    instantiateAsync(parent: SceneObject, onSuccess: ((sceneObject: SceneObject) => void), onFailure: ((error: string) => void), onProgress: ((progress: number) => void)): void;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

name uniqueIdentifier

Methods

getTypeName instantiate instantiateAsync isOfType isSame

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

  • 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, onSuccess, onFailure, onProgress): void

  • Parameters

    • parent: SceneObject
    • onSuccess: ((sceneObject: SceneObject) => void)
        • (sceneObject): void

        • Parameters

          Returns void

    • onFailure: ((error: string) => void)
        • (error): void

        • Parameters

          • error: string

          Returns void

    • onProgress: ((progress: number) => void)
        • (progress): void

        • Parameters

          • progress: number

          Returns void

    Returns void

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): 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

Properties
Methods