pixi.js
    Preparing search index...

    Interface MeshRopeOptions

    Constructor options used for MeshRope instances. Allows configuration of a rope-like mesh that follows a series of points with a texture applied.

    // Create a basic rope with two points
    const rope = new MeshRope({
        texture: Texture.from('snake.png'),
        points: [
            new Point(0, 0),
            new Point(100, 0)
        ]
    });

    // Create a rope with high-quality texture scaling
    const highQualityRope = new MeshRope({
        texture: Texture.from('rope-hd.png'),
        points: [
            new Point(0, 0),
            new Point(50, 25),
            new Point(100, 0)
        ],
        textureScale: 0.5  // Downscale HD texture for better quality
    });
    interface MeshRopeOptions {
        points: PointData[];
        texture: Texture;
        textureScale?: number;
        width?: number;
    }

    Hierarchy

    Index

    Properties

    points texture textureScale? width?

    Properties

    points: PointData[]

    An array of points that determine the rope's shape and path

    texture: Texture

    The texture to use on the rope

    textureScale?: number

    Controls how the texture is scaled along the rope.

    • If 0 (default), the texture stretches to fit between points
    • If > 0, texture repeats with preserved aspect ratio
    • Larger textures with textureScale < 1 can reduce artifacts
    0
    width?: number

    The width (i.e., thickness) of the rope. If not specified, defaults back to texture's height.

    Settings

    Member Visibility

    On This Page

    Properties