Interface ManipulateStartEvent

This event is triggered when manipulation on the object begins.

Example

// Creates events for Manipulate Start and Manipulate End events
var manipulating = true;

function manipStart(eventData)
{
    manipulating = true;
}
var manipStartEvent = script.createEvent("ManipulateStartEvent");
manipStartEvent.bind(manipStart);

function manipEnd(eventData)
{
    manipulating = false;
}
var manipEndEvent = script.createEvent("ManipulateEndEvent");
manipEndEvent.bind(manipEnd);
interface ManipulateStartEvent {
    enabled: boolean;
    bind(evCallback: ((arg1: this) => void)): void;
    getSceneObject(): SceneObject;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

enabled

Methods

bind getSceneObject 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

getSceneObject

getTypeName

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