@pixi/3d
    Preparing search index...

    Interface Container3DEvents

    Events a Container3D emits, with the same names and payloads as pixi's 2D Container

    Listen with on, once and off. The pointer events, such as pointerdown and click, are typed here too.

    level.on('childAdded', (child) => colliders.add(child));
    level.on('childRemoved', (child) => colliders.delete(child));
    interface Container3DEvents {
        added: [container: Container3D];
        childAdded: [child: Container3D, container: Container3D, index: number];
        childRemoved: [child: Container3D, container: Container3D, index: number];
        click: [event: Pointer3DEvent];
        clickcapture: [event: Pointer3DEvent];
        contextmenu: [event: Pointer3DEvent];
        contextmenucapture: [event: Pointer3DEvent];
        destroyed: [container: Container3D];
        globalmousemove: [event: Pointer3DEvent];
        globalpointermove: [event: Pointer3DEvent];
        globaltouchmove: [event: Pointer3DEvent];
        mousedown: [event: Pointer3DEvent];
        mousedowncapture: [event: Pointer3DEvent];
        mouseenter: [event: Pointer3DEvent];
        mouseentercapture: [event: Pointer3DEvent];
        mouseleave: [event: Pointer3DEvent];
        mouseleavecapture: [event: Pointer3DEvent];
        mousemove: [event: Pointer3DEvent];
        mousemovecapture: [event: Pointer3DEvent];
        mouseout: [event: Pointer3DEvent];
        mouseoutcapture: [event: Pointer3DEvent];
        mouseover: [event: Pointer3DEvent];
        mouseovercapture: [event: Pointer3DEvent];
        mouseup: [event: Pointer3DEvent];
        mouseupcapture: [event: Pointer3DEvent];
        mouseupoutside: [event: Pointer3DEvent];
        mouseupoutsidecapture: [event: Pointer3DEvent];
        pointercancel: [event: Pointer3DEvent];
        pointercancelcapture: [event: Pointer3DEvent];
        pointerdown: [event: Pointer3DEvent];
        pointerdowncapture: [event: Pointer3DEvent];
        pointerenter: [event: Pointer3DEvent];
        pointerentercapture: [event: Pointer3DEvent];
        pointerleave: [event: Pointer3DEvent];
        pointerleavecapture: [event: Pointer3DEvent];
        pointermove: [event: Pointer3DEvent];
        pointermovecapture: [event: Pointer3DEvent];
        pointerout: [event: Pointer3DEvent];
        pointeroutcapture: [event: Pointer3DEvent];
        pointerover: [event: Pointer3DEvent];
        pointerovercapture: [event: Pointer3DEvent];
        pointertap: [event: Pointer3DEvent];
        pointertapcapture: [event: Pointer3DEvent];
        pointerup: [event: Pointer3DEvent];
        pointerupcapture: [event: Pointer3DEvent];
        pointerupoutside: [event: Pointer3DEvent];
        pointerupoutsidecapture: [event: Pointer3DEvent];
        removed: [container: Container3D];
        rightclick: [event: Pointer3DEvent];
        rightclickcapture: [event: Pointer3DEvent];
        rightdown: [event: Pointer3DEvent];
        rightdowncapture: [event: Pointer3DEvent];
        rightup: [event: Pointer3DEvent];
        rightupcapture: [event: Pointer3DEvent];
        rightupoutside: [event: Pointer3DEvent];
        rightupoutsidecapture: [event: Pointer3DEvent];
        tap: [event: Pointer3DEvent];
        tapcapture: [event: Pointer3DEvent];
        touchcancel: [event: Pointer3DEvent];
        touchcancelcapture: [event: Pointer3DEvent];
        touchend: [event: Pointer3DEvent];
        touchendcapture: [event: Pointer3DEvent];
        touchendoutside: [event: Pointer3DEvent];
        touchendoutsidecapture: [event: Pointer3DEvent];
        touchmove: [event: Pointer3DEvent];
        touchmovecapture: [event: Pointer3DEvent];
        touchstart: [event: Pointer3DEvent];
        touchstartcapture: [event: Pointer3DEvent];
        visibleChanged: [visible: boolean];
        wheel: [event: Wheel3DEvent];
        wheelcapture: [event: Wheel3DEvent];
    }

    Hierarchy

    • Container3DEvents
      • Container3DEvents
    Index
    added childAdded childRemoved click clickcapture contextmenu contextmenucapture destroyed globalmousemove globalpointermove globaltouchmove mousedown mousedowncapture mouseenter mouseentercapture mouseleave mouseleavecapture mousemove mousemovecapture mouseout mouseoutcapture mouseover mouseovercapture mouseup mouseupcapture mouseupoutside mouseupoutsidecapture pointercancel pointercancelcapture pointerdown pointerdowncapture pointerenter pointerentercapture pointerleave pointerleavecapture pointermove pointermovecapture pointerout pointeroutcapture pointerover pointerovercapture pointertap pointertapcapture pointerup pointerupcapture pointerupoutside pointerupoutsidecapture removed rightclick rightclickcapture rightdown rightdowncapture rightup rightupcapture rightupoutside rightupoutsidecapture tap tapcapture touchcancel touchcancelcapture touchend touchendcapture touchendoutside touchendoutsidecapture touchmove touchmovecapture touchstart touchstartcapture visibleChanged wheel wheelcapture
    added: [container: Container3D]

    Emitted on a child after it joins a parent; passes the parent

    enemy.on('added', () => enemyCount++);
    childAdded: [child: Container3D, container: Container3D, index: number]

    Emitted on a parent after it gains a child; passes the child, this parent and the child's index

    level.on('childAdded', (child) => colliders.add(child));
    childRemoved: [child: Container3D, container: Container3D, index: number]

    Emitted on a parent after it loses a child; passes the child, this parent and an index

    From removeChild, the index is where the child was. From removeChildren, it is the child's place in the returned array, as in pixi.

    level.on('childRemoved', (child) => colliders.delete(child));
    click: [event: Pointer3DEvent]
    clickcapture: [event: Pointer3DEvent]
    contextmenu: [event: Pointer3DEvent]
    contextmenucapture: [event: Pointer3DEvent]
    destroyed: [container: Container3D]

    Emitted once Container3D.destroy has emptied and detached this container; passes the container

    crate.once('destroyed', () => colliders.delete(crate));
    globalmousemove: [event: Pointer3DEvent]

    Fired on every mouse move, wherever the pointer is on the page

    mesh.on('globalmousemove', (e) => {
      if (dragging) dragTo(e.global);
    });
    globalpointermove: [event: Pointer3DEvent]

    Fired on every pointer move on the page, whether or not the pointer is over this node

    mesh.on('globalpointermove', (e) => {
      if (dragging) dragTo(e.global);
    });
    globaltouchmove: [event: Pointer3DEvent]

    Fired on every touch move, wherever the touch is on the page

    mesh.on('globaltouchmove', (e) => {
      if (dragging) dragTo(e.global);
    });
    mousedown: [event: Pointer3DEvent]
    mousedowncapture: [event: Pointer3DEvent]
    mouseenter: [event: Pointer3DEvent]
    mouseentercapture: [event: Pointer3DEvent]
    mouseleave: [event: Pointer3DEvent]
    mouseleavecapture: [event: Pointer3DEvent]
    mousemove: [event: Pointer3DEvent]
    mousemovecapture: [event: Pointer3DEvent]
    mouseout: [event: Pointer3DEvent]
    mouseoutcapture: [event: Pointer3DEvent]
    mouseover: [event: Pointer3DEvent]
    mouseovercapture: [event: Pointer3DEvent]
    mouseup: [event: Pointer3DEvent]
    mouseupcapture: [event: Pointer3DEvent]
    mouseupoutside: [event: Pointer3DEvent]
    mouseupoutsidecapture: [event: Pointer3DEvent]
    pointercancel: [event: Pointer3DEvent]
    pointercancelcapture: [event: Pointer3DEvent]
    pointerdown: [event: Pointer3DEvent]
    pointerdowncapture: [event: Pointer3DEvent]
    pointerenter: [event: Pointer3DEvent]
    pointerentercapture: [event: Pointer3DEvent]
    pointerleave: [event: Pointer3DEvent]
    pointerleavecapture: [event: Pointer3DEvent]
    pointermove: [event: Pointer3DEvent]
    pointermovecapture: [event: Pointer3DEvent]
    pointerout: [event: Pointer3DEvent]
    pointeroutcapture: [event: Pointer3DEvent]
    pointerover: [event: Pointer3DEvent]
    pointerovercapture: [event: Pointer3DEvent]
    pointertap: [event: Pointer3DEvent]
    pointertapcapture: [event: Pointer3DEvent]
    pointerup: [event: Pointer3DEvent]
    pointerupcapture: [event: Pointer3DEvent]
    pointerupoutside: [event: Pointer3DEvent]
    pointerupoutsidecapture: [event: Pointer3DEvent]
    removed: [container: Container3D]

    Emitted on a child after it leaves its parent; passes the former parent

    enemy.on('removed', () => enemyCount--);
    rightclick: [event: Pointer3DEvent]
    rightclickcapture: [event: Pointer3DEvent]
    rightdown: [event: Pointer3DEvent]
    rightdowncapture: [event: Pointer3DEvent]
    rightup: [event: Pointer3DEvent]
    rightupcapture: [event: Pointer3DEvent]
    rightupoutside: [event: Pointer3DEvent]
    rightupoutsidecapture: [event: Pointer3DEvent]
    tap: [event: Pointer3DEvent]
    tapcapture: [event: Pointer3DEvent]
    touchcancel: [event: Pointer3DEvent]
    touchcancelcapture: [event: Pointer3DEvent]
    touchend: [event: Pointer3DEvent]
    touchendcapture: [event: Pointer3DEvent]
    touchendoutside: [event: Pointer3DEvent]
    touchendoutsidecapture: [event: Pointer3DEvent]
    touchmove: [event: Pointer3DEvent]
    touchmovecapture: [event: Pointer3DEvent]
    touchstart: [event: Pointer3DEvent]
    touchstartcapture: [event: Pointer3DEvent]
    visibleChanged: [visible: boolean]

    Emitted when Container3D.visible changes value; passes the new value

    door.on('visibleChanged', (visible) => {
      doorCollider.enabled = visible;
    });
    wheel: [event: Wheel3DEvent]
    wheelcapture: [event: Wheel3DEvent]

    Settings
    Member Visibility

    On This Page
    Properties
    addedchildAddedchildRemovedclickclickcapturecontextmenucontextmenucapturedestroyedglobalmousemoveglobalpointermoveglobaltouchmovemousedownmousedowncapturemouseentermouseentercapturemouseleavemouseleavecapturemousemovemousemovecapturemouseoutmouseoutcapturemouseovermouseovercapturemouseupmouseupcapturemouseupoutsidemouseupoutsidecapturepointercancelpointercancelcapturepointerdownpointerdowncapturepointerenterpointerentercapturepointerleavepointerleavecapturepointermovepointermovecapturepointeroutpointeroutcapturepointeroverpointerovercapturepointertappointertapcapturepointeruppointerupcapturepointerupoutsidepointerupoutsidecaptureremovedrightclickrightclickcapturerightdownrightdowncapturerightuprightupcapturerightupoutsiderightupoutsidecapturetaptapcapturetouchcanceltouchcancelcapturetouchendtouchendcapturetouchendoutsidetouchendoutsidecapturetouchmovetouchmovecapturetouchstarttouchstartcapturevisibleChangedwheelwheelcapture