org.spongepowered.api.entity.vehicle

Interface Boat

All Superinterfaces:

CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, Entity, Identifiable, Locatable, PropertyHolder, Translatable, ValueContainer<DataHolder>

public interface Boat
extends Entity

Represents a Boat entity.

Method Summary

Modifier and Type	Method and Description
boolean	canMoveOnLand() Gets whether or not the boat is able to move freely on land.
double	getMaxSpeed() Gets the maximum speed that this boat is allowed to travel at.
double	getOccupiedDeceleration() Gets the rate at which occupied boats decelerate.
double	getUnoccupiedDeceleration() Gets the rate at which unoccupied boats decelerate.
boolean	isInWater() Gets whether this boat is currently in water.
void	setMaxSpeed(double maxSpeed) Sets the maximum speed that this boat is allowed to travel at.
void	setMoveOnLand(boolean moveOnLand) Gets whether or not the boat is able to move freely on land.
void	setOccupiedDeceleration(double occupiedDeceleration) Sets the rate at which occupied boats decelerate.
void	setUnoccupiedDeceleration(double unoccupiedDeceleration) Sets the rate at which unoccupied boats decelerate.

Methods inherited from interface org.spongepowered.api.entity.Entity

addPassenger, canSee, clearPassengers, createArchetype, createSnapshot, damage, getBaseVehicle, getBoundingBox, getCreator, getNearbyEntities, getNearbyEntities, getNotifier, getPassengers, getRandom, getRotation, getScale, getTransform, getType, getVehicle, getVelocity, gravity, hasPassenger, isLoaded, isOnGround, isRemoved, remove, removePassenger, setCreator, setLocation, setLocationAndRotation, setLocationAndRotation, setLocationAndRotationSafely, setLocationAndRotationSafely, setLocationSafely, setNotifier, setRotation, setScale, setTransform, setTransformSafely, setVehicle, setVelocity, transferToWorld, transferToWorld, transferToWorld, transferToWorld

Methods inherited from interface org.spongepowered.api.util.Identifiable

getUniqueId

Methods inherited from interface org.spongepowered.api.world.Locatable

getLocation, getWorld

Methods inherited from interface org.spongepowered.api.data.DataHolder

setRawData, validateRawData

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Methods inherited from interface org.spongepowered.api.text.translation.Translatable

getTranslation

Method Detail

isInWater

boolean isInWater()

Gets whether this boat is currently in water.

Returns:

If the boat is in water

getMaxSpeed

double getMaxSpeed()

Gets the maximum speed that this boat is allowed to travel at.

The Default value is 0.4.

Returns:

The maximum speed

setMaxSpeed

void setMaxSpeed(double maxSpeed)

Sets the maximum speed that this boat is allowed to travel at.

The Default value is 0.4.

Parameters:

maxSpeed - The new max speed

canMoveOnLand

boolean canMoveOnLand()

Gets whether or not the boat is able to move freely on land.

Returns:

If the boat can move on land

setMoveOnLand

void setMoveOnLand(boolean moveOnLand)

Gets whether or not the boat is able to move freely on land.

Parameters:

moveOnLand - If the boat can move on land

getOccupiedDeceleration

double getOccupiedDeceleration()

Gets the rate at which occupied boats decelerate.

Returns:

The occupied deceleration rate

setOccupiedDeceleration

void setOccupiedDeceleration(double occupiedDeceleration)

Sets the rate at which occupied boats decelerate.

Parameters:

occupiedDeceleration - The new occupied deceleration rate

getUnoccupiedDeceleration

double getUnoccupiedDeceleration()

Gets the rate at which unoccupied boats decelerate.

Returns:

The unoccupied deceleration rate

setUnoccupiedDeceleration

void setUnoccupiedDeceleration(double unoccupiedDeceleration)

Sets the rate at which unoccupied boats decelerate.

Parameters:

unoccupiedDeceleration - The new unoccupied deceleration rate