Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
Boat.java
1 package org.bukkit.entity;
2 
3 /**
4  * Represents a boat entity.
5  */
6 public interface Boat extends Vehicle {
7 
8  /**
9  * Gets the maximum speed of a boat. The speed is unrelated to the
10  * velocity.
11  *
12  * @return The max speed.
13  */
14  public double getMaxSpeed();
15 
16  /**
17  * Sets the maximum speed of a boat. Must be nonnegative. Default is 0.4D.
18  *
19  * @param speed The max speed.
20  */
21  public void setMaxSpeed(double speed);
22 
23  /**
24  * Gets the deceleration rate (newSpeed = curSpeed * rate) of occupied
25  * boats. The default is 0.2.
26  *
27  * @return The rate of deceleration
28  */
29  public double getOccupiedDeceleration();
30 
31  /**
32  * Sets the deceleration rate (newSpeed = curSpeed * rate) of occupied
33  * boats. Setting this to a higher value allows for quicker acceleration.
34  * The default is 0.2.
35  *
36  * @param rate deceleration rate
37  */
38  public void setOccupiedDeceleration(double rate);
39 
40  /**
41  * Gets the deceleration rate (newSpeed = curSpeed * rate) of unoccupied
42  * boats. The default is -1. Values below 0 indicate that no additional
43  * deceleration is imposed.
44  *
45  * @return The rate of deceleration
46  */
47  public double getUnoccupiedDeceleration();
48 
49  /**
50  * Sets the deceleration rate (newSpeed = curSpeed * rate) of unoccupied
51  * boats. Setting this to a higher value allows for quicker deceleration
52  * of boats when a player disembarks. The default is -1. Values below 0
53  * indicate that no additional deceleration is imposed.
54  *
55  * @param rate deceleration rate
56  */
57  public void setUnoccupiedDeceleration(double rate);
58 
59  /**
60  * Get whether boats can work on land.
61  *
62  * @return whether boats can work on land
63  */
64  public boolean getWorkOnLand();
65 
66  /**
67  * Set whether boats can work on land.
68  *
69  * @param workOnLand whether boats can work on land
70  */
71  public void setWorkOnLand(boolean workOnLand);
72 }
void setOccupiedDeceleration(double rate)
void setUnoccupiedDeceleration(double rate)
double getOccupiedDeceleration()
void setWorkOnLand(boolean workOnLand)
double getUnoccupiedDeceleration()
void setMaxSpeed(double speed)