Class BaseScriptComponentAbstract

Used to bind custom JavaScript or TypeScript code to specific Lens events for dynamic interactivity.

Remarks

These Script Components are attached to SceneObjects, providing the ability to modify properties and behaviors of those objects or others within the scene. Script Components expose input fields in the Inspector panel, allowing for customization of script behavior without altering code. Any script can access the ScriptComponent executing them through the variable script.

See

Example

// Bind a function to the MouthOpened event
function onMouthOpen(eventData)
{
    print("mouth was opened");
}
var event = script.createEvent("MouthOpenedEvent");
event.bind(onMouthOpen);

Hierarchy (View Summary, Expand)

Implements

Constructors

constructor

Properties

api enabled name sceneObject uniqueIdentifier updatePriority

Methods

__initialize createEvent destroy getReferencedEvents getSceneObject getTransform getTypeName getTypeName isOfType isSame removeEvent

Constructors

constructor

Properties

api

api: Record<string, any>

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

name

name: string

ReadonlysceneObject

sceneObject: SceneObject

The scene object this component is on.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

updatePriority

updatePriority: number

Methods

Private__initialize

  • __initialize(): any

    Returns any

createEvent

destroy

getReferencedEvents

getSceneObject

getTransform

StaticgetTypeName

getTypeName

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

removeEvent

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR