net.minecraftforge.common

Enum PlantType

java.lang.Object

java.lang.Enum<PlantType>

net.minecraftforge.common.PlantType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PlantType>, IExtensibleEnum

public enum PlantType
extends java.lang.Enum<PlantType>
implements IExtensibleEnum

Enum Constant Summary

Enum Constants

Enum Constant and Description
Beach
Cave
Crop
Desert
Nether
Plains
Water

Method Summary

Modifier and Type	Method and Description
static PlantType	create(java.lang.String name) Getting a custom PlantType, or an existing one if it has the same name as that one.
static PlantType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PlantType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.minecraftforge.common.IExtensibleEnum

init

Enum Constant Detail

Plains

public static final PlantType Plains

Desert

public static final PlantType Desert

Beach

public static final PlantType Beach

Cave

public static final PlantType Cave

Water

public static final PlantType Water

Nether

public static final PlantType Nether

Crop

public static final PlantType Crop

Method Detail

values

public static PlantType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PlantType c : PlantType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PlantType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

create

public static PlantType create(java.lang.String name)

Getting a custom PlantType, or an existing one if it has the same name as that one. Your plant should implement IPlantable and return this custom type in IPlantable#getPlantType(IBlockAccess, BlockPos).

If your new plant grows on blocks like any one of them above, never create a new PlantType. This enumeration is only functioning in net.minecraft.block.Block#canSustainPlant(IBlockState, IWorldReader, BlockPos, EnumFacing, IPlantable), which you are supposed to override this function in your new block and create a new plant type to grow on that block.

You can create an instance of your plant type in your API and let your/others mods access it. It will be faster than calling this method.

Parameters:

name - the name of the type of plant, you had better follow the style above

Returns:

the acquired PlantType, a new one if not found.