Interface TokenConstrainMovementPathWaypoint

interface TokenConstrainMovementPathWaypoint {
    action?: string;
    checkpoint?: boolean;
    elevation?: number;
    explicit?: boolean;
    height?: number;
    intermediate?: boolean;
    shape?: TokenShapeType;
    snapped?: boolean;
    terrain?: null | DataModel<object, DataModelConstructionContext>;
    width?: number;
    x?: number;
    y?: number;
}

Properties

action? checkpoint? elevation? explicit? height? intermediate? shape? snapped? terrain? width? x? y?

Properties

Optionalaction

action?: string

The movement action from the previous to this waypoint. Default: the previous or prepared movement action.

Optionalcheckpoint

checkpoint?: boolean

Is this waypoint a checkpoint? Default: false.

Optionalelevation

elevation?: number

The elevation in grid units. Default: the previous or source elevation.

Optionalexplicit

explicit?: boolean

Was this waypoint explicitly placed by the user? Default: false.

Optionalheight

height?: number

The height in grid spaces (positive). Default: the previous or source height.

Optionalintermediate

intermediate?: boolean

Is this waypoint intermediate? Default: false.

Optionalshape

shape?: TokenShapeType

The shape type (see CONST.TOKEN_SHAPES). Default: the previous or source shape.

Optionalsnapped

snapped?: boolean

Was this waypoint snapped to the grid? Default: false.

Optionalterrain

terrain?: null | DataModel<object, DataModelConstructionContext>

The terrain data of this segment. Default: null.

Optionalwidth

width?: number

The width in grid spaces (positive). Default: the previous or source width.

Optionalx

x?: number

The top-left x-coordinate in pixels (integer). Default: the previous or source x-coordinate.

Optionaly

y?: number

The top-left y-coordinate in pixels (integer). Default: the previous or source y-coordinate.

Settings

Member Visibility

On This Page

Properties