Package io.rhythmknights.coreapi.modal.builder.item

Class MapBuilder

java.lang.Object

io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder<MapBuilder>

io.rhythmknights.coreapi.modal.builder.item.MapBuilder

public class MapBuilder
extends BaseItemBuilder<MapBuilder>

Item builder for Material.MAP only

Since:

3.0.1

Method Summary

Modifier and Type	Method	Description
@NotNull MapBuilder	color(@Nullable org.bukkit.Color color)	Sets the map color.
@NotNull MapBuilder	locationName(@Nullable String name)	Sets the location name.
@NotNull MapBuilder	scaling(boolean scaling)	Sets if this map is scaling or not.
@NotNull MapBuilder	view(@NotNull org.bukkit.map.MapView view)	Sets the associated map.

Methods inherited from class io.rhythmknights.coreapi.modal.builder.item.BaseItemBuilder

amount, asModalItem, asModalItem, build, deserializeComponent, disenchant, enchant, enchant, enchant, enchant, enchant, flags, getItemStack, getMeta, glow, glow, lore, lore, lore, model, name, pdc, removeNBT, serializeComponent, setItemStack, setMeta, setNBT, setNBT, unbreakable, unbreakable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

color

@NotNull
@Contract("_ -> this")
public @NotNull MapBuilder color(@Nullable
 @Nullable org.bukkit.Color color)

Sets the map color. A custom map color will alter the display of the map in an inventory slot.

Overrides:

color in class BaseItemBuilder<MapBuilder>

Parameters:

color - the color to set

Returns:

MapBuilder

Since:

3.0.1

See Also:

• LeatherArmorMeta.setColor(Color)
• MapMeta.setColor(Color)

locationName

@NotNull
@Contract("_ -> this")
public @NotNull MapBuilder locationName(@Nullable
 @Nullable String name)

Sets the location name. A custom map color will alter the display of the map in an inventory slot.

Parameters:

name - the name to set

Returns:

MapMeta

Since:

3.0.1

scaling

@NotNull
@Contract("_ -> this")
public @NotNull MapBuilder scaling(boolean scaling)

Sets if this map is scaling or not.

Parameters:

scaling - true to scale

Returns:

MapMeta

Since:

3.0.1

view

@NotNull
@Contract("_ -> this")
public @NotNull MapBuilder view(@NotNull
 @NotNull org.bukkit.map.MapView view)

Sets the associated map. This is used to determine what map is displayed.

The implementation may allow null to clear the associated map, but this is not required and is liable to generate a new (undefined) map when the item is first used.

Parameters:

view - the map to set

Returns:

MapBuilder

Since:

3.0.1