52 lines
2.1 KiB
Java
52 lines
2.1 KiB
Java
/*
|
|
* Minecraft Forge
|
|
* Copyright (c) 2016-2018.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation version 2.1
|
|
* of the License.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
package net.minecraftforge.common;
|
|
|
|
import net.minecraft.block.state.IBlockState;
|
|
import net.minecraft.util.EnumFacing;
|
|
import net.minecraft.util.math.BlockPos;
|
|
import net.minecraft.world.IWorldReader;
|
|
|
|
public enum EnumPlantType
|
|
{
|
|
Plains,
|
|
Desert,
|
|
Beach,
|
|
Cave,
|
|
Water,
|
|
Nether,
|
|
Crop;
|
|
|
|
/**
|
|
* Getting a custom {@link EnumPlantType}, or an existing one if it has the same name as that one. Your plant should implement {@link IPlantable}
|
|
* and return this custom type in {@link IPlantable#getPlantType(IBlockAccess, BlockPos)}.
|
|
*
|
|
* <p>If your new plant grows on blocks like any one of them above, never create a new {@link EnumPlantType}.
|
|
* This enumeration is only functioning in
|
|
* {@link 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.
|
|
*
|
|
* <p>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.
|
|
* @param name the name of the type of plant, you had better follow the style above
|
|
* @return the acquired {@link EnumPlantType}, a new one if not found.
|
|
*/
|
|
public static EnumPlantType create(String name){ return null; }
|
|
}
|