Package nl.sbdeveloper.vehiclesplus.api.vehicles.parts.impl

Class Wheel

java.lang.Object

nl.sbdeveloper.vehiclesplus.api.vehicles.parts.Part

nl.sbdeveloper.vehiclesplus.api.vehicles.parts.EquipablePart

nl.sbdeveloper.vehiclesplus.api.vehicles.parts.impl.Wheel

All Implemented Interfaces:

Cloneable

public class Wheel
extends EquipablePart

The Wheel part, placed on the vehicle.

Note: The item of the wheel is based on the RimDesign.

Field Summary

Fields inherited from class nl.sbdeveloper.vehiclesplus.api.vehicles.parts.Part

holder, rotationOffset, xOffset, yOffset, zOffset

Constructor Summary

Constructors

Constructor	Description
Wheel()	Construct a new default Wheel part.
Wheel(double xOffset, double yOffset, double zOffset, @NotNull RimDesign rimDesign, @NotNull org.bukkit.Color color)	Construct a new Wheel part.
Wheel(double xOffset, double yOffset, double zOffset, @NotNull RimDesign rimDesign, @NotNull org.bukkit.Color color, boolean steering, int rotationOffset)	Construct a new Wheel part.

Method Summary

Modifier and Type	Method	Description
org.bukkit.Location	applyExtraOffset(org.bukkit.Location loc)	Override this method to apply extra offset.
String	asString()	Get the part as string, for the info command.
void	despawnStand()	Despawn the stand of this wheel.
org.bukkit.inventory.ItemStack	getItem()	Overrides the item getter to ignore it for JSON serialization.
org.bukkit.inventory.ItemStack	getPartGUIItem()	The Configuration and Addon GUI will call this method to get the item to display.
HolderItemPosition	getPosition()	Overrides the position getter to ignore it for JSON serialization.
String	getRimDesignId()	The rimdesign of the wheel.
float	getSteeringOffset()	The steering rotation offset.
boolean	isSteering()	Is this wheel moving to left/right?
void	setRimDesignId(String rimDesignId)	Change the rim design of this wheel.
void	setSteering(boolean steering)	Is this wheel moving to left/right?
void	setSteeringOffset(float steeringOffset)	The steering rotation offset.

Methods inherited from class nl.sbdeveloper.vehiclesplus.api.vehicles.parts.EquipablePart

canEqual, clone, equals, getColor, hashCode, isColorable, setColor, setItem, spawnStand, toString, updateHolder

Methods inherited from class nl.sbdeveloper.vehiclesplus.api.vehicles.parts.Part

getHolder, getOwningVehicle, getRotationOffset, getXOffset, getYOffset, getZOffset, isAddon, isSpawned, refresh, setAddon, setRotationOffset, setXOffset, setYOffset, setZOffset

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Wheel

public Wheel()

Construct a new default Wheel part.

Wheel

public Wheel(double xOffset,
 double yOffset,
 double zOffset,
 @NotNull
 @NotNull RimDesign rimDesign,
 @NotNull
 @NotNull org.bukkit.Color color)

Construct a new Wheel part.

Parameters:

xOffset - The x-offset

yOffset - The y-offset

zOffset - The z-offset

rimDesign - The rim design

color - The color of the wheel

Wheel

public Wheel(double xOffset,
 double yOffset,
 double zOffset,
 @NotNull
 @NotNull RimDesign rimDesign,
 @NotNull
 @NotNull org.bukkit.Color color,
 boolean steering,
 int rotationOffset)

Construct a new Wheel part.

Parameters:

xOffset - The x-offset

yOffset - The y-offset

zOffset - The z-offset

rimDesign - The rim design

color - The color of the wheel

steering - Is this wheel moving to left/right?

rotationOffset - The rotation offset

Method Details

asString

public String asString()

Description copied from class: Part

Get the part as string, for the info command.

Specified by:

asString in class Part

Returns:

The part as string.

applyExtraOffset

public org.bukkit.Location applyExtraOffset(org.bukkit.Location loc)

Description copied from class: Part

Override this method to apply extra offset.

Overrides:

applyExtraOffset in class Part

Parameters:

loc - The input location.

Returns:

The output location, with the extra offset applied.

setRimDesignId

public void setRimDesignId(String rimDesignId)

Change the rim design of this wheel. This will also update the holder if spawned.

Parameters:

rimDesignId - The rim design id

getItem

public org.bukkit.inventory.ItemStack getItem()

Overrides the item getter to ignore it for JSON serialization. This is because the item is already stored in the RimDesign.

Overrides:

getItem in class EquipablePart

getPosition

public HolderItemPosition getPosition()

Overrides the position getter to ignore it for JSON serialization. This is because the position is already stored in the RimDesign.

Overrides:

getPosition in class EquipablePart

getPartGUIItem

public org.bukkit.inventory.ItemStack getPartGUIItem()

Description copied from class: Part

The Configuration and Addon GUI will call this method to get the item to display.

Specified by:

getPartGUIItem in class Part

Returns:

The item to display.

despawnStand

public void despawnStand()

Despawn the stand of this wheel.

Overrides:

despawnStand in class Part

getRimDesignId

public String getRimDesignId()

The rimdesign of the wheel.

isSteering

public boolean isSteering()

Is this wheel moving to left/right?

getSteeringOffset

public float getSteeringOffset()

The steering rotation offset.

setSteering

public void setSteering(boolean steering)

Is this wheel moving to left/right?

setSteeringOffset

public void setSteeringOffset(float steeringOffset)

The steering rotation offset.