Interface UpdateEvent

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: ((arg1: this) => void)): void;
    getDeltaTime(): number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

enabled

Methods

bind getDeltaTime getTypeName isOfType isSame

Properties

enabled

enabled: boolean

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

Methods

bind

  • bind(evCallback): void

  • Binds a callback function to this event.

    Parameters

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

        • Parameters

          • arg1: this

          Returns void

    Returns void

getDeltaTime

  • getDeltaTime(): number

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

    Returns number

getTypeName

  • getTypeName(): string

  • Returns the typename of the SceneEvent.

    Returns string

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