de.ellpeck.naturesaura.api.internal

Class StubHooks

java.lang.Object

de.ellpeck.naturesaura.api.internal.StubHooks

All Implemented Interfaces:

NaturesAuraAPI.IInternalHooks

public class StubHooks
extends java.lang.Object
implements NaturesAuraAPI.IInternalHooks

Constructor Summary

Constructors

Constructor and Description
StubHooks()

Method Summary

Modifier and Type	Method and Description
boolean	extractAuraFromPlayer(net.minecraft.entity.player.EntityPlayer player, int amount, boolean simulate) Helper method to extract aura from an IAuraContainer in the supplied player's inventory or baubles slots.
int	getAuraInArea(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int radius)
void	getAuraSpotsInArea(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int radius, java.util.function.BiConsumer<net.minecraft.util.math.BlockPos,org.apache.commons.lang3.mutable.MutableInt> consumer)
net.minecraft.util.math.BlockPos	getHighestAuraDrainSpot(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int radius, net.minecraft.util.math.BlockPos defaultSpot)
net.minecraft.util.math.BlockPos	getLowestAuraDrainSpot(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, int radius, net.minecraft.util.math.BlockPos defaultSpot)
void	spawnMagicParticle(double posX, double posY, double posZ, double motionX, double motionY, double motionZ, int color, float scale, int maxAge, float gravity, boolean collision, boolean fade) This method can be used to spawn the magic particle effect used by Nature's Aura.
void	spawnParticleStream(float startX, float startY, float startZ, float endX, float endY, float endZ, float speed, int color, float scale) This method can be used to spawn the magic particle effect used by Nature's Aura.

Methods inherited from class java.lang.Object

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

Constructor Detail

StubHooks

public StubHooks()

Method Detail

extractAuraFromPlayer

public boolean extractAuraFromPlayer(net.minecraft.entity.player.EntityPlayer player,
                                     int amount,
                                     boolean simulate)

Description copied from interface: NaturesAuraAPI.IInternalHooks

Helper method to extract aura from an IAuraContainer in the supplied player's inventory or baubles slots. The method returns true if the aura could be extracted. Note that, if the player is in creative mode, this method will always return true and no extraction will take place.

Specified by:

extractAuraFromPlayer in interface NaturesAuraAPI.IInternalHooks

Parameters:

player - The player

amount - The amount to extract

simulate - If the extraction should be simulated

Returns:

If the extraction was successful

spawnMagicParticle

public void spawnMagicParticle(double posX,
                               double posY,
                               double posZ,
                               double motionX,
                               double motionY,
                               double motionZ,
                               int color,
                               float scale,
                               int maxAge,
                               float gravity,
                               boolean collision,
                               boolean fade)

Description copied from interface: NaturesAuraAPI.IInternalHooks

This method can be used to spawn the magic particle effect used by Nature's Aura. It will not have an effect on the client side, so if you want to send it from the server side, you need to create your own packet.

Specified by:

spawnMagicParticle in interface NaturesAuraAPI.IInternalHooks

Parameters:

posX - The x position

posY - The y position

posZ - The z position

motionX - The x motion

motionY - The y motion

motionZ - The z motion

color - The color the particle should have, in hex

scale - The scale of the particle

maxAge - The max age before the particle should die

gravity - The amount of gravity the particle should have, can be 0

collision - If the particle should collide with blocks

fade - If the particle should slowly fade out or suddenly disappear

spawnParticleStream

public void spawnParticleStream(float startX,
                                float startY,
                                float startZ,
                                float endX,
                                float endY,
                                float endZ,
                                float speed,
                                int color,
                                float scale)

Description copied from interface: NaturesAuraAPI.IInternalHooks

This method can be used to spawn the magic particle effect used by Nature's Aura. The particle will be created to spawn at the start position and move towards the end position, dying when it reaches it. It will not have an effect on the client side, so if you want to send it from the server side, you need to create your own packet.

Specified by:

spawnParticleStream in interface NaturesAuraAPI.IInternalHooks

Parameters:

startX - The start x

startY - The start y

startZ - The start z

endX - The end x

endY - The end y

endZ - The end z

speed - The speed at which the particle should go

color - The color of the particle

scale - The scale of the particle

getAuraSpotsInArea

public void getAuraSpotsInArea(net.minecraft.world.World world,
                               net.minecraft.util.math.BlockPos pos,
                               int radius,
                               java.util.function.BiConsumer<net.minecraft.util.math.BlockPos,org.apache.commons.lang3.mutable.MutableInt> consumer)

Specified by:

getAuraSpotsInArea in interface NaturesAuraAPI.IInternalHooks

See Also:

IAuraChunk.getSpotsInArea(World, BlockPos, int, BiConsumer)

getAuraInArea

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

Specified by:

getAuraInArea in interface NaturesAuraAPI.IInternalHooks

See Also:

IAuraChunk.getAuraInArea(World, BlockPos, int)

getLowestAuraDrainSpot

public net.minecraft.util.math.BlockPos getLowestAuraDrainSpot(net.minecraft.world.World world,
                                                               net.minecraft.util.math.BlockPos pos,
                                                               int radius,
                                                               net.minecraft.util.math.BlockPos defaultSpot)

Specified by:

getLowestAuraDrainSpot in interface NaturesAuraAPI.IInternalHooks

See Also:

IAuraChunk.getLowestSpot(World, BlockPos, int, BlockPos)

getHighestAuraDrainSpot

public net.minecraft.util.math.BlockPos getHighestAuraDrainSpot(net.minecraft.world.World world,
                                                                net.minecraft.util.math.BlockPos pos,
                                                                int radius,
                                                                net.minecraft.util.math.BlockPos defaultSpot)

Specified by:

getHighestAuraDrainSpot in interface NaturesAuraAPI.IInternalHooks

See Also:

IAuraChunk.getHighestSpot(World, BlockPos, int, BlockPos)