de.ellpeck.naturesaura.api

Class NaturesAuraAPI

java.lang.Object

de.ellpeck.naturesaura.api.NaturesAuraAPI

public final class NaturesAuraAPI
extends java.lang.Object

The main class of the Nature's Aura API. This is where you can find recipe lists and the NaturesAuraAPI.IInternalHooks instance, which can be used to hook into internal mod functions not exposed to the API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NaturesAuraAPI.IInternalHooks

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<net.minecraft.util.ResourceLocation,AltarRecipe>	ALTAR_RECIPES The list of all AltarRecipe instances which are the recipes used by the Natural Altar.
static java.util.Map<net.minecraft.util.ResourceLocation,AnimalSpawnerRecipe>	ANIMAL_SPAWNER_RECIPES A map of all AnimalSpawnerRecipe objects that are used with the animal spawner block.
static java.lang.String	API_ID
static java.util.Map<net.minecraft.util.ResourceLocation,IAuraType>	AURA_TYPES A map of all IAuraType instances which are types of Aura present in different types of worlds.
static java.util.Map<net.minecraft.block.state.IBlockState,net.minecraft.block.state.IBlockState>	BOTANIST_PICKAXE_CONVERSIONS A map of all of the block states that the Botanist's Pickaxe can convert into their mossy variations.
static net.minecraftforge.common.capabilities.Capability<IAuraChunk>	capAuraChunk The capability that any chunk in a world has to store Aura in it.
static net.minecraftforge.common.capabilities.Capability<IAuraContainer>	capAuraContainer The capability for any item or block that stores Aura in the form of an IAuraContainer
static net.minecraftforge.common.capabilities.Capability<IAuraRecharge>	capAuraRecharge The capability for any item that can be recharged from an Aura storage container like the Aura Cache in the form of IAuraRecharge by a player holding it in their hand
static java.util.Map<net.minecraft.util.ResourceLocation,java.util.function.Supplier<IDrainSpotEffect>>	DRAIN_SPOT_EFFECTS A map of all IDrainSpotEffect suppliers which are effects that happen passively at every spot that Aura has been drained from in the world.
static java.util.Map<net.minecraft.util.ResourceLocation,java.lang.Integer>	EFFECT_POWDERS A map of all effect powder type.
static java.util.List<net.minecraft.block.state.IBlockState>	FLOWERS The list of all types of blocks that several mechanics in the mod use as flowers.
static java.lang.String	MOD_ID
static java.util.Map<net.minecraft.util.ResourceLocation,IMultiblock>	MULTIBLOCKS A map of all IMultiblock objects which are multiblock structures that can easily be looped through and checked, and also easily created using the multiblock maker debug tool.
static java.util.Map<net.minecraft.util.ResourceLocation,OfferingRecipe>	OFFERING_RECIPES The list of all OfferingRecipe instances which are the recipes used by the Offering Table.
static java.util.Map<net.minecraft.util.ResourceLocation,TreeRitualRecipe>	TREE_RITUAL_RECIPES The list of all TreeRitualRecipe instances which are the recipes used in the Ritual of the Forest.
static BasicAuraType	TYPE_END
static BasicAuraType	TYPE_NETHER
static BasicAuraType	TYPE_OTHER
static BasicAuraType	TYPE_OVERWORLD
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
NaturesAuraAPI()

Method Summary

Modifier and Type	Method and Description
static NaturesAuraAPI.IInternalHooks	instance() This method returns the active NaturesAuraAPI.IInternalHooks instance which can be used to hook into the mod's internal functionalities.
static void	setInstance(NaturesAuraAPI.IInternalHooks inst) This is an internal function.

Methods inherited from class java.lang.Object

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

Field Detail

MOD_ID

public static final java.lang.String MOD_ID

See Also:

Constant Field Values

API_ID

public static final java.lang.String API_ID

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

ALTAR_RECIPES

public static final java.util.Map<net.minecraft.util.ResourceLocation,AltarRecipe> ALTAR_RECIPES

The list of all AltarRecipe instances which are the recipes used by the Natural Altar. Newly created recipes can be easily added using AltarRecipe.register().

TREE_RITUAL_RECIPES

public static final java.util.Map<net.minecraft.util.ResourceLocation,TreeRitualRecipe> TREE_RITUAL_RECIPES

The list of all TreeRitualRecipe instances which are the recipes used in the Ritual of the Forest. Newly created recipes can be easily added using TreeRitualRecipe.register().

OFFERING_RECIPES

public static final java.util.Map<net.minecraft.util.ResourceLocation,OfferingRecipe> OFFERING_RECIPES

The list of all OfferingRecipe instances which are the recipes used by the Offering Table. Newly created recipes can by easily added using OfferingRecipe.register().

FLOWERS

public static final java.util.List<net.minecraft.block.state.IBlockState> FLOWERS

The list of all types of blocks that several mechanics in the mod use as flowers. Right now, this includes the Herbivorous Absorber and the Offering Table. By default, all BlockFlower instances and all blocks specified in the config file are added

BOTANIST_PICKAXE_CONVERSIONS

public static final java.util.Map<net.minecraft.block.state.IBlockState,net.minecraft.block.state.IBlockState> BOTANIST_PICKAXE_CONVERSIONS

A map of all of the block states that the Botanist's Pickaxe can convert into their mossy variations. Contains mossy brick and mossy cobblestone by default, along with all blocks specified in the config file

AURA_TYPES

public static final java.util.Map<net.minecraft.util.ResourceLocation,IAuraType> AURA_TYPES

A map of all IAuraType instances which are types of Aura present in different types of worlds. BasicAuraType instances can be easily registered using BasicAuraType.register().

TYPE_OVERWORLD

public static final BasicAuraType TYPE_OVERWORLD

TYPE_NETHER

public static final BasicAuraType TYPE_NETHER

TYPE_END

public static final BasicAuraType TYPE_END

TYPE_OTHER

public static final BasicAuraType TYPE_OTHER

DRAIN_SPOT_EFFECTS

public static final java.util.Map<net.minecraft.util.ResourceLocation,java.util.function.Supplier<IDrainSpotEffect>> DRAIN_SPOT_EFFECTS

A map of all IDrainSpotEffect suppliers which are effects that happen passively at every spot that Aura has been drained from in the world. These effects include things like vegetational increase and natural decay. To register your own drain spot effects, just add a supplier for them to this map and they will automatically be executed once a second for every drain spot currently loaded.

EFFECT_POWDERS

public static final java.util.Map<net.minecraft.util.ResourceLocation,java.lang.Integer> EFFECT_POWDERS

A map of all effect powder type. The integer the effect is registered to is the color that the powder and its effect should have. To check if a powder is active in any given area, use NaturesAuraAPI.IInternalHooks.isEffectPowderActive(World, BlockPos, ResourceLocation)

MULTIBLOCKS

public static final java.util.Map<net.minecraft.util.ResourceLocation,IMultiblock> MULTIBLOCKS

A map of all IMultiblock objects which are multiblock structures that can easily be looped through and checked, and also easily created using the multiblock maker debug tool.

ANIMAL_SPAWNER_RECIPES

public static final java.util.Map<net.minecraft.util.ResourceLocation,AnimalSpawnerRecipe> ANIMAL_SPAWNER_RECIPES

A map of all AnimalSpawnerRecipe objects that are used with the animal spawner block. To register a recipe, use AnimalSpawnerRecipe.register().

capAuraContainer

public static net.minecraftforge.common.capabilities.Capability<IAuraContainer> capAuraContainer

The capability for any item or block that stores Aura in the form of an IAuraContainer

capAuraRecharge

public static net.minecraftforge.common.capabilities.Capability<IAuraRecharge> capAuraRecharge

The capability for any item that can be recharged from an Aura storage container like the Aura Cache in the form of IAuraRecharge by a player holding it in their hand

capAuraChunk

public static net.minecraftforge.common.capabilities.Capability<IAuraChunk> capAuraChunk

The capability that any chunk in a world has to store Aura in it. As this is only applicable to chunks and all chunks in the world automatically get assigned this capability, using it directly is not necessary for addon developers. To retrieve this capability from any chunk, use the helper method IAuraChunk.getAuraChunk(World, BlockPos).

Constructor Detail

NaturesAuraAPI

public NaturesAuraAPI()

Method Detail

instance

public static NaturesAuraAPI.IInternalHooks instance()

This method returns the active NaturesAuraAPI.IInternalHooks instance which can be used to hook into the mod's internal functionalities. This is instantiated as StubHooks by default which has no functionality, but, in the mod's preInit phase, this will be overriden to a proper implementation. If you want to use this instance, use it after Nature's Aura's preInit phase.

Returns:

The active NaturesAuraAPI.IInternalHooks instance

setInstance

public static void setInstance(NaturesAuraAPI.IInternalHooks inst)

This is an internal function. Do not use.