Lens Scripting API
    Preparing search index...

    Class UpdateEvent

    Event that runs during each frame, only if a Component and its SceneObject is enabled. A Component will not get an UpdateEvent that frame if it constructed after UpdateEvents have started to be processed. Relative ordering between UpdateEvents is not guaranteed.

    // Move this SceneObject up every frame with a speed of 5 units per second
    var transform = script.getTransform();
    var event = script.createEvent("UpdateEvent");
    event.bind(function (eventData)
    {
    	var pos = transform.getLocalPosition();
    	pos.y += eventData.getDeltaTime() * 5.0;
    	transform.setLocalPosition(pos);
    });

    Hierarchy (View Summary)

    Index

    Properties

    enabled

    Methods

    bind getDeltaTime getTypeName getTypeName isOfType isSame

    Properties

    enabled: boolean

    If true, the event is able to trigger. If false, the event will not trigger.

    true

    Methods

    • Binds a callback function to this event.

      Parameters

      • evCallback: (arg1: this) => void

      Returns void

    • Returns the time elapsed (in seconds) between the current frame and previous frame.

      Returns number

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Returns string

    • Returns the typename of the SceneEvent.

      Returns string

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

      Parameters

      • type: string

      Returns 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