Interface UpdateEvent

Description

Triggered every frame.

Example

// 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);
});
interface UpdateEvent {
    enabled: boolean;
    bind(evCallback): void;
    getDeltaTime(): number;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

enabled

Methods

bind getDeltaTime getTypeName isOfType isSame

Properties

enabled

enabled: boolean

Description

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

Methods

bind

  • bind(evCallback): void

  • Parameters

    • evCallback: ((arg1) => void)
        • (arg1): void

        • Parameters

          • arg1: this

          Returns void

    Returns void

    Description

    Binds a callback function to this event.

getDeltaTime

  • getDeltaTime(): number

  • Returns number

    Description

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

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the typename of the SceneEvent.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc