Interface Boat

All Superinterfaces:
net.kyori.adventure.audience.Audience, CommandSender, Entity, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowEntity>, Metadatable, Nameable, Permissible, PersistentDataHolder, net.kyori.adventure.pointer.Pointered, ServerOperator, Vehicle

public interface Boat extends Vehicle
Represents a boat entity.
  • Method Details

    • getWoodType

      Gets the wood type of the boat.
      Returns:
      the wood type
    • setWoodType

      void setWoodType(@NotNull @NotNull TreeSpecies species)
      Sets the wood type of the boat.
      Parameters:
      species - the new wood type
    • getMaxSpeed

      @Deprecated double getMaxSpeed()
      Deprecated.
      boats are complex and many of these methods do not work correctly across multiple versions.
      Gets the maximum speed of a boat. The speed is unrelated to the velocity.
      Returns:
      The max speed.
    • setMaxSpeed

      @Deprecated void setMaxSpeed(double speed)
      Deprecated.
      boats are complex and many of these methods do not work correctly across multiple versions.
      Sets the maximum speed of a boat. Must be nonnegative. Default is 0.4D.
      Parameters:
      speed - The max speed.
    • getOccupiedDeceleration

      @Deprecated double getOccupiedDeceleration()
      Deprecated.
      boats are complex and many of these methods do not work correctly across multiple versions.
      Gets the deceleration rate (newSpeed = curSpeed * rate) of occupied boats. The default is 0.2.
      Returns:
      The rate of deceleration
    • setOccupiedDeceleration

      @Deprecated void setOccupiedDeceleration(double rate)
      Deprecated.
      boats are complex and many of these methods do not work correctly across multiple versions.
      Sets the deceleration rate (newSpeed = curSpeed * rate) of occupied boats. Setting this to a higher value allows for quicker acceleration. The default is 0.2.
      Parameters:
      rate - deceleration rate
    • getUnoccupiedDeceleration

      @Deprecated double getUnoccupiedDeceleration()
      Deprecated.
      boats are complex and many of these methods do not work correctly across multiple versions.
      Gets the deceleration rate (newSpeed = curSpeed * rate) of unoccupied boats. The default is -1. Values below 0 indicate that no additional deceleration is imposed.
      Returns:
      The rate of deceleration
    • setUnoccupiedDeceleration

      @Deprecated void setUnoccupiedDeceleration(double rate)
      Deprecated.
      boats are complex and many of these methods do not work correctly across multiple versions.
      Sets the deceleration rate (newSpeed = curSpeed * rate) of unoccupied boats. Setting this to a higher value allows for quicker deceleration of boats when a player disembarks. The default is -1. Values below 0 indicate that no additional deceleration is imposed.
      Parameters:
      rate - deceleration rate
    • getWorkOnLand

      @Deprecated boolean getWorkOnLand()
      Deprecated.
      boats are complex and many of these methods do not work correctly across multiple versions.
      Get whether boats can work on land.
      Returns:
      whether boats can work on land
    • setWorkOnLand

      @Deprecated void setWorkOnLand(boolean workOnLand)
      Deprecated.
      boats are complex and many of these methods do not work correctly across multiple versions.
      Set whether boats can work on land.
      Parameters:
      workOnLand - whether boats can work on land
    • getBoatMaterial

      @NotNull @NotNull Material getBoatMaterial()
      Gets the Material that represents this Boat type.
      Returns:
      the boat material.