Package net.minecraftforge.common

Class PlantType

java.lang.Object

net.minecraftforge.common.PlantType

public final class PlantType
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final PlantType	BEACH
static final PlantType	CAVE
static final PlantType	CROP
static final PlantType	DESERT
private static final Pattern	INVALID_CHARACTERS
private final String	name
static final PlantType	NETHER
static final PlantType	PLAINS
private static final Map<String,PlantType>	VALUES
static final PlantType	WATER

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PlantType(String name)

Method Summary

Modifier and Type	Method	Description
static PlantType	get(String name)	Getting a custom PlantType, or an existing one if it has the same name as that one.
String	getName()

Methods inherited from class java.lang.Object

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

Field Details

INVALID_CHARACTERS

private static final Pattern INVALID_CHARACTERS

VALUES

private static final Map<String,PlantType> VALUES

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

name

private final String name

Constructor Details

PlantType

private PlantType(String name)

Method Details

get

public static PlantType get(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(BlockGetter, BlockPos).

If your new plant grows on blocks like any one of them above, never create a new PlantType. This Type is only functioning in Block.canSustainPlant(BlockState, BlockGetter, BlockPos, Direction, IPlantable), which you are supposed to override this function in your new block and create a new plant type to grow on that block. This method can be called during parallel loading

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.

getName

public String getName()