Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.entity.Boat Interface Reference
Inheritance diagram for org.bukkit.entity.Boat:
org.bukkit.entity.Vehicle org.bukkit.entity.Entity org.bukkit.metadata.Metadatable

Public Member Functions

double getMaxSpeed ()
 
void setMaxSpeed (double speed)
 
double getOccupiedDeceleration ()
 
void setOccupiedDeceleration (double rate)
 
double getUnoccupiedDeceleration ()
 
void setUnoccupiedDeceleration (double rate)
 
boolean getWorkOnLand ()
 
void setWorkOnLand (boolean workOnLand)
 
- Public Member Functions inherited from org.bukkit.entity.Vehicle
Vector getVelocity ()
 
void setVelocity (Vector vel)
 
- Public Member Functions inherited from org.bukkit.entity.Entity
Location getLocation ()
 
Location getLocation (Location loc)
 
boolean isOnGround ()
 
World getWorld ()
 
boolean teleport (Location location)
 
boolean teleport (Location location, TeleportCause cause)
 
boolean teleport (Entity destination)
 
boolean teleport (Entity destination, TeleportCause cause)
 
List< org.bukkit.entity.EntitygetNearbyEntities (double x, double y, double z)
 
int getEntityId ()
 
int getFireTicks ()
 
int getMaxFireTicks ()
 
void setFireTicks (int ticks)
 
void remove ()
 
boolean isDead ()
 
boolean isValid ()
 
Server getServer ()
 
abstract Entity getPassenger ()
 
abstract boolean setPassenger (Entity passenger)
 
abstract boolean isEmpty ()
 
abstract boolean eject ()
 
float getFallDistance ()
 
void setFallDistance (float distance)
 
void setLastDamageCause (EntityDamageEvent event)
 
EntityDamageEvent getLastDamageCause ()
 
UUID getUniqueId ()
 
int getTicksLived ()
 
void setTicksLived (int value)
 
void playEffect (EntityEffect type)
 
EntityType getType ()
 
boolean isInsideVehicle ()
 
boolean leaveVehicle ()
 
Entity getVehicle ()
 

Detailed Description

Represents a boat entity.

Definition at line 6 of file Boat.java.

Member Function Documentation

double org.bukkit.entity.Boat.getMaxSpeed ( )

Gets the maximum speed of a boat. The speed is unrelated to the velocity.

Returns
The max speed.
double org.bukkit.entity.Boat.getOccupiedDeceleration ( )

Gets the deceleration rate (newSpeed = curSpeed * rate) of occupied boats. The default is 0.2.

Returns
The rate of deceleration
double org.bukkit.entity.Boat.getUnoccupiedDeceleration ( )

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
boolean org.bukkit.entity.Boat.getWorkOnLand ( )

Get whether boats can work on land.

Returns
whether boats can work on land
void org.bukkit.entity.Boat.setMaxSpeed ( double  speed)

Sets the maximum speed of a boat. Must be nonnegative. Default is 0.4D.

Parameters
speedThe max speed.
void org.bukkit.entity.Boat.setOccupiedDeceleration ( double  rate)

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
ratedeceleration rate
void org.bukkit.entity.Boat.setUnoccupiedDeceleration ( double  rate)

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
ratedeceleration rate
void org.bukkit.entity.Boat.setWorkOnLand ( boolean  workOnLand)

Set whether boats can work on land.

Parameters
workOnLandwhether boats can work on land

The documentation for this interface was generated from the following file: