Type alias GameplayTestRelativePosition

GameplayTestRelativePosition: {
    distance: float;
    dominantAxis: "x" | "y";
    horizontalDistance: float;
    pitchDiff: float;
    reached: boolean;
    relativeX: float;
    relativeY: float;
    relativeZ?: float;
    targetX: float;
    targetY: float;
    targetZ?: float;
    yawDiff: float;
}

The position of a target relative to a reference object (2D and 3D). How to move toward the target (which keys, when to jump...) is up to the test script - see resetSceneAndProbeControls to discover the controls and makeProgressTracker to detect a lack of progress.

Type declaration

  • distance: float

    Full distance to the target (3D when Z is available).

  • dominantAxis: "x" | "y"
  • horizontalDistance: float

    Distance to the target ignoring Z (equals distance in 2D).

  • pitchDiff: float

    Vertical aim difference in degrees (3D only, 0 in 2D).

  • reached: boolean

    True when the target is within reachRadius (default: 30).

  • relativeX: float
  • relativeY: float
  • Optional relativeZ?: float
  • targetX: float
  • targetY: float
  • Optional targetZ?: float
  • yawDiff: float

    Difference between the reference object's angle (yaw) and the direction of the target, in degrees, normalized to [-180, 180].

Settings

Member Visibility

Theme