pixi-viewport
    Preparing search index...

    Interface IMouseEdgesOptions

    Options for MouseEdges.

    use IEdgeScrollOptions with viewport.edgeScroll() instead

    interface IMouseEdgesOptions {
        allowButtons?: boolean;
        bottom?: number | null;
        distance?: number | null;
        left?: number | null;
        linear?: boolean;
        noDecelerate?: boolean;
        radius?: number | null;
        reverse?: boolean;
        right?: number | null;
        speed?: number;
        top?: number | null;
    }

    Hierarchy (View Summary)

    Index
    allowButtons? bottom? distance? left? linear? noDecelerate? radius? reverse? right? speed? top?
    allowButtons?: boolean

    Allows plugin to continue working even when there's a mousedown event.

    bottom?: number | null

    Alternatively, set bottom distance (leave unset for no top scroll)

    distance?: number | null

    Distance from all sides in screen pixels

    left?: number | null

    Alternatively, set left distance (leave unset for no top scroll)

    linear?: boolean

    If using radius, use linear movement (+/- 1, +/- 1) instead of angled movement.

    (Math.cos(angle from center), Math.sin(angle from center))

    noDecelerate?: boolean

    Don't use decelerate plugin even if it's installed

    radius?: number | null

    Distance from center of screen in screen pixels

    reverse?: boolean

    Reverse direction of scroll

    right?: number | null

    Alternatively, set right distance (leave unset for no top scroll)

    speed?: number

    Controls how fast the viewport scrolls. This is not pixels per frame.

    Each update moves the viewport's center by speed * speed * 0.06 world pixels, so scrolling grows with the square of speed: 4 → about 1, 8 (default) → about 3.8, 16 → about 15.4 world pixels per update. The amount is per update (not per millisecond), so it also depends on frame rate.

    8
    top?: number | null

    Alternatively, set top distance (leave unset for no top scroll)

    Settings
    Member Visibility

    On This Page
    Properties