phaser - v4.0.0-rc.4
    Preparing search index...

    Type Alias PathConfig

    Settings for a PathFollower.

    type PathConfig = {
        duration?: number;
        from?: number;
        positionOnPath?: boolean;
        rotateToPath?: boolean;
        rotationOffset?: number;
        startAt?: number;
        to?: number;
    }
    Index

    Properties

    duration? from? positionOnPath? rotateToPath? rotationOffset? startAt? to?

    Properties

    duration?: number

    The duration of the path follow in ms. Must be > 0.

    from?: number

    The start position of the path follow, between 0 and 1. Must be less than to.

    positionOnPath?: boolean

    Whether to position the PathFollower on the Path using its path offset.

    rotateToPath?: boolean

    Should the PathFollower automatically rotate to point in the direction of the Path?

    rotationOffset?: number

    If the PathFollower is rotating to match the Path, this value is added to the rotation value. This allows you to rotate objects to a path but control the angle of the rotation as well.

    startAt?: number

    Current start position of the path follow, must be between from and to.

    to?: number

    The end position of the path follow, between 0 and 1. Must be more than from.

    Settings

    Member Visibility

    On This Page

    Properties