com.bergerkiller.bukkit.common.utils

Class MaterialUtil

java.lang.Object

com.bergerkiller.bukkit.common.utils.MaterialUtil

Direct Known Subclasses:

BlockUtil

public class MaterialUtil
extends Object

Contains material properties and helper functions

Field Summary

Fields

Modifier and Type	Field and Description
static MaterialProperty<Integer>	EMISSION Gets the amount of light a block material emits
static MaterialProperty<Boolean>	HASDATA The material has a data value that further defines the type of Item or Block
static MaterialTypeProperty	ISARMOR The material is a type of armor
static MaterialTypeProperty	ISBOOTS The material is a type of wearable boots
static MaterialTypeProperty	ISBUCKET The material is a type of bucket (milk bucket is excluded)
static MaterialTypeProperty	ISBUTTON The material is a type of button (item type excluded)
static MaterialTypeProperty	ISCHESTPLATE The material is a type of wearable chestplate
static MaterialTypeProperty	ISCOMPARATOR The material is a type of comparator (item type excluded)
static MaterialTypeProperty	ISDIODE The material is a type of diode (item type excluded)
static MaterialTypeProperty	ISDOOR The material is a type of door block.
static MaterialProperty<Boolean>	ISFUEL The material is a type of fuel that can be burned in a furnace
static MaterialProperty<Boolean>	ISHEATABLE The material is a type of heatable item that can be crafted using a furnace
static MaterialTypeProperty	ISHELMET The material is a type of wearable helmet
static MaterialTypeProperty	ISINTERACTABLE The material can be interacted with, such as buttons and levers.
static MaterialTypeProperty	ISLAVA The material is lava
static MaterialTypeProperty	ISLEATHERARMOR The material is a type of armor made of leather, such as leather boots or leather helmet.
static MaterialTypeProperty	ISLEAVES The material is a type of Leaves
static MaterialTypeProperty	ISLEGGINGS The material is a type of wearable leggings
static MaterialTypeProperty	ISLIQUID The material is a liquid like water or lava
static MaterialTypeProperty	ISMINECART The material is a type of Minecart item
static MaterialTypeProperty	ISPISTONBASE The material is a type of piston base
static MaterialTypeProperty	ISPOTION The material is a type of Potion.
static MaterialProperty<Boolean>	ISPOWERSOURCE The material can supply redstone power and redstone wire connects to it
static MaterialTypeProperty	ISPRESSUREPLATE The material is a type of pressure plate
static MaterialTypeProperty	ISRAILS The material is a type of rails
static MaterialTypeProperty	ISREDSTONETORCH The material is a type of redstone torch
static MaterialTypeProperty	ISSIGN The material is a type of sign (item type is excluded)
static MaterialTypeProperty	ISSWORD The material is a type of wieldable sword
static MaterialTypeProperty	ISWATER The material is water

Constructor Summary

Constructors

Constructor and Description
MaterialUtil()

Method Summary

Modifier and Type	Method and Description
static org.bukkit.material.MaterialData	getData(org.bukkit.Material type, int rawData) Deprecated.
static org.bukkit.Material	getFirst(String... names) Gets the very first material name in the list that matches a valid material.
static org.bukkit.Material	getMaterial(String name) Gets a Material by name. This assumes the 1.13 API, which means old legacy materials can be obtained by prefixing LEGACY_.
static int	getRawData(org.bukkit.block.Block block) Deprecated.
static int	getRawData(org.bukkit.inventory.ItemStack item)
static int	getRawData(org.bukkit.material.MaterialData materialData) Deprecated.
static int	getRawData(org.bukkit.TreeSpecies treeSpecies) Deprecated.
static boolean	isLegacyType(org.bukkit.Material type) Gets whether a particular Material type is legacy.
static boolean	isType(org.bukkit.block.Block block, org.bukkit.Material... types) Checks whether the material of a block is contained in the types
static boolean	isType(org.bukkit.inventory.ItemStack itemStack, org.bukkit.Material... types) Checks whether the material of the item is contained in the types
static boolean	isType(org.bukkit.Material material, org.bukkit.Material... types) Checks whether the material is contained in the types

Methods inherited from class java.lang.Object

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

Field Detail

ISDOOR

public static final MaterialTypeProperty ISDOOR

The material is a type of door block. Materials of this type are guaranteed to have a Door MaterialData.

ISPISTONBASE

public static final MaterialTypeProperty ISPISTONBASE

The material is a type of piston base

ISREDSTONETORCH

public static final MaterialTypeProperty ISREDSTONETORCH

The material is a type of redstone torch

ISDIODE

public static final MaterialTypeProperty ISDIODE

The material is a type of diode (item type excluded)

ISBUTTON

public static final MaterialTypeProperty ISBUTTON

The material is a type of button (item type excluded)

ISCOMPARATOR

public static final MaterialTypeProperty ISCOMPARATOR

The material is a type of comparator (item type excluded)

ISBUCKET

public static final MaterialTypeProperty ISBUCKET

The material is a type of bucket (milk bucket is excluded)

ISRAILS

public static final MaterialTypeProperty ISRAILS

The material is a type of rails

ISSIGN

public static final MaterialTypeProperty ISSIGN

The material is a type of sign (item type is excluded)

ISPRESSUREPLATE

public static final MaterialTypeProperty ISPRESSUREPLATE

The material is a type of pressure plate

ISMINECART

public static final MaterialTypeProperty ISMINECART

The material is a type of Minecart item

ISSWORD

public static final MaterialTypeProperty ISSWORD

The material is a type of wieldable sword

ISBOOTS

public static final MaterialTypeProperty ISBOOTS

The material is a type of wearable boots

ISLEGGINGS

public static final MaterialTypeProperty ISLEGGINGS

The material is a type of wearable leggings

ISCHESTPLATE

public static final MaterialTypeProperty ISCHESTPLATE

The material is a type of wearable chestplate

ISHELMET

public static final MaterialTypeProperty ISHELMET

The material is a type of wearable helmet

ISARMOR

public static final MaterialTypeProperty ISARMOR

The material is a type of armor

ISLEATHERARMOR

public static final MaterialTypeProperty ISLEATHERARMOR

The material is a type of armor made of leather, such as leather boots or leather helmet. Distinctive of this property is that the armor material can be painted because of it.

ISINTERACTABLE

public static final MaterialTypeProperty ISINTERACTABLE

The material can be interacted with, such as buttons and levers. Materials of this type suppress block placement upon interaction.

ISWATER

public static final MaterialTypeProperty ISWATER

The material is water

ISLAVA

public static final MaterialTypeProperty ISLAVA

The material is lava

ISLIQUID

public static final MaterialTypeProperty ISLIQUID

The material is a liquid like water or lava

ISLEAVES

public static final MaterialTypeProperty ISLEAVES

The material is a type of Leaves

ISPOTION

public static final MaterialTypeProperty ISPOTION

The material is a type of Potion. Distinctive is that this type of material allows the color of the liquid contents to be changed.

ISHEATABLE

public static final MaterialProperty<Boolean> ISHEATABLE

The material is a type of heatable item that can be crafted using a furnace

ISFUEL

public static final MaterialProperty<Boolean> ISFUEL

The material is a type of fuel that can be burned in a furnace

ISPOWERSOURCE

public static final MaterialProperty<Boolean> ISPOWERSOURCE

The material can supply redstone power and redstone wire connects to it

HASDATA

public static final MaterialProperty<Boolean> HASDATA

The material has a data value that further defines the type of Item or Block

EMISSION

public static final MaterialProperty<Integer> EMISSION

Gets the amount of light a block material emits

Constructor Detail

MaterialUtil

public MaterialUtil()

Method Detail

getRawData

@Deprecated
public static int getRawData(org.bukkit.TreeSpecies treeSpecies)

Deprecated.

getRawData

@Deprecated
public static int getRawData(org.bukkit.block.Block block)

Deprecated.

getRawData

public static int getRawData(org.bukkit.inventory.ItemStack item)

getRawData

@Deprecated
public static int getRawData(org.bukkit.material.MaterialData materialData)

Deprecated.

getData

@Deprecated
public static org.bukkit.material.MaterialData getData(org.bukkit.Material type,
                                                                   int rawData)

Deprecated.

Obtains the Material Data using the material type Id and data value specified

Parameters:

type - of the material

rawData - for the material

Returns:

new MaterialData instance for this type of material and data

isType

public static boolean isType(org.bukkit.inventory.ItemStack itemStack,
                             org.bukkit.Material... types)

Checks whether the material of the item is contained in the types

Parameters:

itemStack - containing the material type to check

types - to look in

Returns:

True if the material is contained

isType

public static boolean isType(org.bukkit.Material material,
                             org.bukkit.Material... types)

Checks whether the material is contained in the types

Parameters:

material - to check

types - to look in

Returns:

True if the material is contained

isType

public static boolean isType(org.bukkit.block.Block block,
                             org.bukkit.Material... types)

Checks whether the material of a block is contained in the types

Parameters:

block - to compare the types with

types - to look in

Returns:

True if the material is contained

isLegacyType

public static boolean isLegacyType(org.bukkit.Material type)

Gets whether a particular Material type is legacy. When run on versions of Minecraft before 1.13, this method always returns true.

Parameters:

type -

Returns:

True if the type is legacy

getFirst

public static org.bukkit.Material getFirst(String... names)

Gets the very first material name in the list that matches a valid material. Throws a runtime exception when none of the names could be found.

This assumes the 1.13 API, which means old legacy materials can be obtained by prefixing LEGACY_. The LEGACY_ prefix is also required on older versions of Minecraft.

Parameters:

names -

Returns:

first name in the list

getMaterial

public static org.bukkit.Material getMaterial(String name)

Gets a Material by name.

This assumes the 1.13 API, which means old legacy materials can be obtained by prefixing LEGACY_. The LEGACY_ prefix is also required on older versions of Minecraft.

Parameters:

name -

Returns:

Material