import type { JSONSupport } from "../core/JSONSupport.js";

/** @since 5.0 */
export interface NavigationConstraintProperties extends Partial<Pick<NavigationConstraint, "type">> {}

/** @since 5.0 */
export default class NavigationConstraint extends JSONSupport {
  constructor(properties: NavigationConstraintProperties);
  /**
   * The type of the constraint. It can be one of the following:
   *
   * Value      | Description
   * -----------|--------------------
   * stay-above | User can only navigate above ground surface
   * none       | User can navigate above and below the ground surface
   *
   * Default value: stay-above
   *
   * @default "none"
   * @since 5.0
   */
  accessor type: "none" | "stay-above";
}