de.ellpeck.naturesaura.api.aura.chunk

Interface IAuraChunk

All Superinterfaces:

net.minecraftforge.common.capabilities.ICapabilityProvider, net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.NBTTagCompound>

public interface IAuraChunk
extends net.minecraftforge.common.capabilities.ICapabilityProvider, net.minecraftforge.common.util.INBTSerializable<net.minecraft.nbt.NBTTagCompound>

A class whose instances hold information about the aura present in any given Chunk. To get an instance for a chunk, use getAuraChunk(World, BlockPos).

It is not intended for API users to create custom implementation of this class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_AURA The default amount of Aura that a chunk has stored

Method Summary

Modifier and Type	Method and Description
int	drainAura(net.minecraft.util.math.BlockPos pos, int amount) Convenience version of drainAura(BlockPos, int, boolean, boolean) with aimForZero and simulate set to false, as this is the most likely behavior you will want.
int	drainAura(net.minecraft.util.math.BlockPos pos, int amount, boolean aimForZero, boolean simulate) Drains the given amount of Aura from the given position.
static IAuraChunk	getAuraChunk(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) This method is used to get information about the Aura in any given chunk.
static int	getAuraInArea(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int radius) Convenience method that adds up all of the aura from each drain spot from getSpotsInArea(World, BlockPos, int, BiConsumer) and conveniently returns it.
int	getDrainSpot(net.minecraft.util.math.BlockPos pos)
static net.minecraft.util.math.BlockPos	getHighestSpot(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int radius, net.minecraft.util.math.BlockPos defaultSpot) This method returns the position of the highest drain spot (meaning the one that has the most Aura stored) in the given area.
static net.minecraft.util.math.BlockPos	getLowestSpot(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int radius, net.minecraft.util.math.BlockPos defaultSpot) This method returns the position of the lowest drain spot (meaning the one that has the least Aura stored) in the given area.
void	getSpotsInArea(net.minecraft.util.math.BlockPos pos, int radius, java.util.function.BiConsumer<net.minecraft.util.math.BlockPos,java.lang.Integer> consumer)
static void	getSpotsInArea(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int radius, java.util.function.BiConsumer<net.minecraft.util.math.BlockPos,java.lang.Integer> consumer) This method uses the supplied consumer to iterate over all the drain spots, represented as a position and the number of Aura in them, in any given area.
IAuraType	getType()
void	markDirty()
int	storeAura(net.minecraft.util.math.BlockPos pos, int amount) Convenience version of storeAura(BlockPos, int, boolean, boolean) with aimForZero set to true and simulate set to false, as this is the most likely behavior you will want.
int	storeAura(net.minecraft.util.math.BlockPos pos, int amount, boolean aimForZero, boolean simulate) Stores the given amount of Aura at the given position.
static int	triangulateAuraInArea(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int radius) Convenience method that adds up all of the aura from each drain spot from getSpotsInArea(World, BlockPos, int, BiConsumer), but multiplies their amount by the percentual distance to the supplied position.

Methods inherited from interface net.minecraftforge.common.capabilities.ICapabilityProvider

getCapability, hasCapability

Methods inherited from interface net.minecraftforge.common.util.INBTSerializable

deserializeNBT, serializeNBT

Field Detail

DEFAULT_AURA

static final int DEFAULT_AURA

The default amount of Aura that a chunk has stored

See Also:

Constant Field Values

Method Detail

getAuraChunk

static IAuraChunk getAuraChunk(net.minecraft.world.World world,
                               net.minecraft.util.math.BlockPos pos)

This method is used to get information about the Aura in any given chunk. This is a convenience method.

Parameters:

world - The world

pos - A position that the chunk contains

Returns:

The IAuraChunk instance belonging to the chunk

getSpotsInArea

static void getSpotsInArea(net.minecraft.world.World world,
                           net.minecraft.util.math.BlockPos pos,
                           int radius,
                           java.util.function.BiConsumer<net.minecraft.util.math.BlockPos,java.lang.Integer> consumer)

This method uses the supplied consumer to iterate over all the drain spots, represented as a position and the number of Aura in them, in any given area.

Notice that this is different from getSpotsInArea(BlockPos, int, BiConsumer) because this method iterates over several chunks while the former only uses the current aura chunk instance. Most of the time, you will want to use this method.

Parameters:

world - The world

pos - The center position

radius - The radius around the center to search for spots in

consumer - A consumer that gets given the position and amount of aura in each drain spot found

getAuraInArea

static int getAuraInArea(net.minecraft.world.World world,
                         net.minecraft.util.math.BlockPos pos,
                         int radius)

Convenience method that adds up all of the aura from each drain spot from getSpotsInArea(World, BlockPos, int, BiConsumer) and conveniently returns it. For a better visual display with a more gradual increase, use triangulateAuraInArea(World, BlockPos, int).

Parameters:

world - The world

pos - The center position

radius - The radius around the center to search for spots in

Returns:

The amount of Aura present in that area, based on the drain spots that are found

triangulateAuraInArea

static int triangulateAuraInArea(net.minecraft.world.World world,
                                 net.minecraft.util.math.BlockPos pos,
                                 int radius)

Convenience method that adds up all of the aura from each drain spot from getSpotsInArea(World, BlockPos, int, BiConsumer), but multiplies their amount by the percentual distance to the supplied position. This will cause for a lot more gradual of an increase and decrease of Aura when moving closer to actual spots. This should be used for visual purposes as it is more performance intensive than getAuraInArea(World, BlockPos, int).

Parameters:

world - The world

pos - The center position

radius - The radius around the center to search for spots in

Returns:

The amount of Aura presetn in that area, based on the drain spots that are found and their distance to the center

getLowestSpot

static net.minecraft.util.math.BlockPos getLowestSpot(net.minecraft.world.World world,
                                                      net.minecraft.util.math.BlockPos pos,
                                                      int radius,
                                                      net.minecraft.util.math.BlockPos defaultSpot)

This method returns the position of the lowest drain spot (meaning the one that has the least Aura stored) in the given area. This should be used with any machines that fill up Aura in an area, so that the most drained spots get selected first. Note that, when there is no drain spot with an amount lower than 0, the default will always be returned.

Parameters:

world - The world

pos - The center position

radius - The radius around the center to search for spots in

defaultSpot - A position that will be used to create a new drain spot when none are found

Returns:

The position of the lowest drain spot

getHighestSpot

static net.minecraft.util.math.BlockPos getHighestSpot(net.minecraft.world.World world,
                                                       net.minecraft.util.math.BlockPos pos,
                                                       int radius,
                                                       net.minecraft.util.math.BlockPos defaultSpot)

This method returns the position of the highest drain spot (meaning the one that has the most Aura stored) in the given area. This should be used with any machines that use up Aura so that the spots with the highest amount are drained first. Note that, when there is no drain spot with an amount greater than 0, the defautl will always be returned.

Parameters:

world - The world

pos - The center position

radius - The radius around the center to search for spots in

defaultSpot - A position that will be used to create a new drain spot when none are found

Returns:

The position of the highest drain spot

getSpotsInArea

void getSpotsInArea(net.minecraft.util.math.BlockPos pos,
                    int radius,
                    java.util.function.BiConsumer<net.minecraft.util.math.BlockPos,java.lang.Integer> consumer)

See Also:

getSpotsInArea(World, BlockPos, int, BiConsumer)

drainAura

int drainAura(net.minecraft.util.math.BlockPos pos,
              int amount,
              boolean aimForZero,
              boolean simulate)

Drains the given amount of Aura from the given position. Returns the amount of Aura that was drained.

Parameters:

pos - The position

amount - The amount to drain

aimForZero - If true, and draining the given amount would make the level go from positive to negative, an amount will be drained instead that will cause the spot's amount to be 0.

Returns:

The amount of Aura drained. Will only be different from the supplied amount if stopAtZero is true

drainAura

int drainAura(net.minecraft.util.math.BlockPos pos,
              int amount)

Convenience version of drainAura(BlockPos, int, boolean, boolean) with aimForZero and simulate set to false, as this is the most likely behavior you will want. Notice that storeAura(BlockPos, int) has aimForZero set to true.

storeAura

int storeAura(net.minecraft.util.math.BlockPos pos,
              int amount,
              boolean aimForZero,
              boolean simulate)

Stores the given amount of Aura at the given position. Returns the amount of Aura that was stored.

Parameters:

pos - The position

amount - The amount to store

aimForZero - If true, and storing the given amount would make the level go from negative to positive, an amount will be stored instead that will cause the spot's amount to be 0.

Returns:

The amount of Aura stored. Will only be different from the supplied amount if stopAtZero is true

storeAura

int storeAura(net.minecraft.util.math.BlockPos pos,
              int amount)

Convenience version of storeAura(BlockPos, int, boolean, boolean) with aimForZero set to true and simulate set to false, as this is the most likely behavior you will want. Notice that drainAura(BlockPos, int) has aimForZero set to false.

getDrainSpot

int getDrainSpot(net.minecraft.util.math.BlockPos pos)

getType

IAuraType getType()

markDirty

void markDirty()