org.bukkit.entity

Interface Minecart

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, ServerOperator, Vehicle

All Known Subinterfaces:

CommandMinecart, ExplosiveMinecart, HopperMinecart, PoweredMinecart, RideableMinecart, SpawnerMinecart, StorageMinecart

public interface Minecart
extends Vehicle

Represents a minecart entity.

Nested Class Summary

Nested classes/interfaces inherited from interface org.bukkit.entity.Entity

Entity.Spigot

Method Summary

Modifier and Type	Method and Description
double	getDamage() Gets a minecart's damage.
@NotNull Vector	getDerailedVelocityMod() Gets the derailed velocity modifier.
@NotNull MaterialData	getDisplayBlock() Gets the display block for this minecart.
@NotNull BlockData	getDisplayBlockData() Gets the display block for this minecart.
int	getDisplayBlockOffset() Gets the offset of the display block.
@NotNull Vector	getFlyingVelocityMod() Gets the flying velocity modifier.
double	getMaxSpeed() Gets the maximum speed of a minecart.
@NotNull Material	getMinecartMaterial() Gets the Material that represents this Minecart type.
boolean	isSlowWhenEmpty() Returns whether this minecart will slow down faster without a passenger occupying it
void	setDamage(double damage) Sets a minecart's damage.
void	setDerailedVelocityMod(@NotNull Vector derailed) Sets the derailed velocity modifier.
void	setDisplayBlock(@Nullable MaterialData material) Sets the display block for this minecart.
void	setDisplayBlockData(@Nullable BlockData blockData) Sets the display block for this minecart.
void	setDisplayBlockOffset(int offset) Sets the offset of the display block.
void	setFlyingVelocityMod(@NotNull Vector flying) Sets the flying velocity modifier.
void	setMaxSpeed(double speed) Sets the maximum speed of a minecart.
void	setSlowWhenEmpty(boolean slow) Sets whether this minecart will slow down faster without a passenger occupying it

Methods inherited from interface org.bukkit.entity.Vehicle

getVelocity, setVelocity

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, asHoverEvent, eject, fromMobSpawner, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getTicksLived, getType, getUniqueId, getVehicle, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isGlowing, isInBubbleColumn, isInLava, isInRain, isInsideVehicle, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isOnGround, isPersistent, isSilent, isTicking, isValid, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, spigot, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.command.CommandSender

getName, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface net.kyori.adventure.audience.Audience

audience, audience, clearTitle, empty, hideBossBar, openBook, openBook, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, showBossBar, showTitle, stopSound, toAudience

Methods inherited from interface org.bukkit.permissions.Permissible

addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Methods inherited from interface org.bukkit.Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent, unbox

Method Detail

setDamage

void setDamage(double damage)

Sets a minecart's damage.

Parameters:

damage - over 40 to "kill" a minecart

getDamage

double getDamage()

Gets a minecart's damage.

Returns:

The damage

getMaxSpeed

double getMaxSpeed()

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

Returns:

The max speed

setMaxSpeed

void setMaxSpeed(double speed)

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

Parameters:

speed - The max speed

isSlowWhenEmpty

boolean isSlowWhenEmpty()

Returns whether this minecart will slow down faster without a passenger occupying it

Returns:

Whether it decelerates faster

setSlowWhenEmpty

void setSlowWhenEmpty(boolean slow)

Sets whether this minecart will slow down faster without a passenger occupying it

Parameters:

slow - Whether it will decelerate faster

getFlyingVelocityMod

@NotNull
@NotNull Vector getFlyingVelocityMod()

Gets the flying velocity modifier. Used for minecarts that are in mid-air. A flying minecart's velocity is multiplied by this factor each tick.

Returns:

The vector factor

setFlyingVelocityMod

void setFlyingVelocityMod(@NotNull
                          @NotNull Vector flying)

Sets the flying velocity modifier. Used for minecarts that are in mid-air. A flying minecart's velocity is multiplied by this factor each tick.

Parameters:

flying - velocity modifier vector

getDerailedVelocityMod

@NotNull
@NotNull Vector getDerailedVelocityMod()

Gets the derailed velocity modifier. Used for minecarts that are on the ground, but not on rails.

A derailed minecart's velocity is multiplied by this factor each tick.

Returns:

derailed visible speed

setDerailedVelocityMod

void setDerailedVelocityMod(@NotNull
                            @NotNull Vector derailed)

Sets the derailed velocity modifier. Used for minecarts that are on the ground, but not on rails. A derailed minecart's velocity is multiplied by this factor each tick.

Parameters:

derailed - visible speed

setDisplayBlock

void setDisplayBlock(@Nullable
                     @Nullable MaterialData material)

Sets the display block for this minecart. Passing a null value will set the minecart to have no display block.

Parameters:

material - the material to set as display block.

getDisplayBlock

@NotNull
@NotNull MaterialData getDisplayBlock()

Gets the display block for this minecart. This function will return the type AIR if none is set.

Returns:

the block displayed by this minecart.

setDisplayBlockData

void setDisplayBlockData(@Nullable
                         @Nullable BlockData blockData)

Sets the display block for this minecart. Passing a null value will set the minecart to have no display block.

Parameters:

blockData - the material to set as display block.

getDisplayBlockData

@NotNull
@NotNull BlockData getDisplayBlockData()

Gets the display block for this minecart. This function will return the type AIR if none is set.

Returns:

the block displayed by this minecart.

setDisplayBlockOffset

void setDisplayBlockOffset(int offset)

Sets the offset of the display block.

Parameters:

offset - the block offset to set for this minecart.

getDisplayBlockOffset

int getDisplayBlockOffset()

Gets the offset of the display block.

Returns:

the current block offset for this minecart.

getMinecartMaterial

@NotNull
@NotNull Material getMinecartMaterial()

Gets the Material that represents this Minecart type.

Returns:

the minecart material.