me.desht.pneumaticcraft.common.util

Class PneumaticCraftUtils

java.lang.Object

me.desht.pneumaticcraft.common.util.PneumaticCraftUtils

public class PneumaticCraftUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	CIRCLE_POINTS
static double[]	cos
static double[]	sin

Constructor Summary

Constructors

Constructor and Description
PneumaticCraftUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.List<net.minecraft.util.text.ITextComponent>	asStringComponent(java.util.List<java.lang.String> l)
static boolean	canPlayerReach(net.minecraft.entity.player.PlayerEntity player, net.minecraft.util.math.BlockPos pos)
static void	collectNonEmptyItems(net.minecraftforge.items.IItemHandler handler, net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> items) Add all of the non-empty items in the given item handler to the given list.
static boolean	consumeInventoryItem(net.minecraft.entity.player.PlayerInventory inv, net.minecraft.item.Item item) Convenience method, ported from 1.8.
static boolean	consumeInventoryItem(net.minecraft.entity.player.PlayerInventory inv, net.minecraft.item.ItemStack stack) Convenience method, ported from 1.8.
static java.lang.String	convertAmountToString(int amount) Takes in any integer, and converts it into a string with a additional postfix if needed.
static java.lang.String	convertTicksToMinutesAndSeconds(long ticks, boolean fraction) Takes in the amount of ticks, and converts it into a time notation.
static void	copyItemHandler(net.minecraftforge.items.IItemHandler source, net.minecraftforge.items.ItemStackHandler dest)
static void	copyItemHandler(net.minecraftforge.items.IItemHandler source, net.minecraftforge.items.ItemStackHandler dest, int maxSlots)
static net.minecraft.nbt.CompoundNBT	copyNBTWithout(net.minecraft.nbt.CompoundNBT nbt, java.lang.String skip)
static net.minecraft.entity.MobEntity	createDummyEntity(net.minecraft.entity.player.PlayerEntity player) A little hack needed here; in 1.8 players were a subclass of EntityLiving and could be used as entities for pathfinding purposes.
static double	distBetween(double x1, double y1, double x2, double y2)
static double	distBetween(double x1, double y1, double z1, double x2, double y2, double z2)
static double	distBetween(net.minecraft.util.math.vector.Vector3i pos, double x, double y, double z)
static double	distBetween(net.minecraft.util.math.vector.Vector3i pos1, net.minecraft.util.math.vector.Vector3i pos2)
static double	distBetweenSq(net.minecraft.util.math.BlockPos pos1, net.minecraft.util.math.BlockPos pos2)
static double	distBetweenSq(double x1, double y1, double x2, double y2)
static double	distBetweenSq(double x1, double y1, double z1, double x2, double y2, double z2)
static double	distBetweenSq(net.minecraft.util.math.vector.Vector3i pos, double x, double y, double z)
static boolean	doesItemMatchFilter(net.minecraft.item.ItemStack filterStack, net.minecraft.item.ItemStack stack, boolean checkDurability, boolean checkNBT, boolean checkModSimilarity)
static void	dropItemOnGround(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos)
static void	dropItemOnGround(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, double x, double y, double z)
static void	dropItemOnGroundPrecisely(net.minecraft.item.ItemStack stack, net.minecraft.world.World world, double x, double y, double z)
static net.minecraft.util.text.ITextComponent	dyeColorDesc(int c)
static boolean	epsilonEquals(double d1, double d2)
static boolean	epsilonEquals(double d1, double d2, double maxDifference)
static boolean	epsilonEquals(float f1, float f2) Compare two floats which are tested for having (almost) the same value.
static boolean	epsilonEquals(float f1, float f2, float maxDifference)
static boolean	fillTankWithOrb(net.minecraftforge.fluids.capability.IFluidHandler handler, net.minecraft.entity.item.ExperienceOrbEntity orb, net.minecraftforge.fluids.capability.IFluidHandler.FluidAction action) Try to transfer the XP from the given XP orb entity into the given fluid handler.
static net.minecraft.util.Direction	getDirectionFacing(net.minecraft.entity.LivingEntity entity, boolean includeUpAndDown) Returns the EnumFacing of the given entity.
static int	getMinHeight(net.minecraft.world.World world) In 1.17 this will become non-trivial.
static java.lang.String	getPage(java.lang.String urlString) Retrieve a web page from the given URL.
static net.minecraft.entity.player.PlayerEntity	getPlayerFromId(java.util.UUID uuid)
static net.minecraft.entity.player.PlayerEntity	getPlayerFromName(java.lang.String name)
static double	getPlayerReachDistance(net.minecraft.entity.player.PlayerEntity player)
static net.minecraft.util.math.BlockPos	getPosForEntity(net.minecraft.entity.Entity e)
static <T extends net.minecraft.tileentity.TileEntity> java.util.Optional<T>	getTileEntityAt(net.minecraft.world.IBlockReader w, net.minecraft.util.math.BlockPos pos, java.lang.Class<T> cls)
static int	getYawFromFacing(net.minecraft.util.Direction facing) Get a yaw angle from an EnumFacing
static boolean	isBlockLiquid(net.minecraft.block.Block block)
static boolean	isInteger(java.lang.String str) Check if a given string encodes a valid integer (negative included).
static boolean	isNumber(java.lang.String str) Check if a given string encodes a valid number (negative & decimal point included).
static boolean	isPlayerOp(net.minecraft.entity.player.PlayerEntity player)
static net.minecraft.util.ResourceLocation	modDefaultedRL(java.lang.String str) Get a resource location from the given string, defaulting to "pneumaticcraft:" namespace
static java.lang.String	modDefaultedString(net.minecraft.util.ResourceLocation rl) Stringify a resource location, omitting the namespace if it's "pneumaticcraft:"
static java.lang.String	posToString(net.minecraft.util.math.BlockPos pos)
static java.lang.String	roundNumberTo(double value, int decimals) Rounds numbers (round-nearest) to the given number of decimal places.
static double	roundNumberToDouble(double value, int decimals) Rounds numbers to the given number of decimal places.
static java.util.List<java.lang.String>	splitString(java.lang.String text)
static java.util.List<java.lang.String>	splitString(java.lang.String text, int maxCharPerLine)
static java.util.List<net.minecraft.util.text.ITextComponent>	splitStringComponent(java.lang.String text)
static java.util.List<net.minecraft.util.text.ITextComponent>	splitStringComponent(java.lang.String text, int maxCharPerLine)
static void	summariseItemStacks(java.util.List<net.minecraft.util.text.ITextComponent> textList, net.minecraft.item.ItemStack[] originalStacks) Sorts the stacks given alphabetically, combines them (so 2x64 will become 1x128), and adds the strings into the given string list.
static void	summariseItemStacks(java.util.List<net.minecraft.util.text.ITextComponent> textList, net.minecraft.item.ItemStack[] originalStacks, java.lang.String prefix) Sort the given array of itemstacks alphabetically by display name, then combine them (so e.g.
static boolean	tryPlaceBlock(net.minecraft.world.World w, net.minecraft.util.math.BlockPos pos, net.minecraft.entity.player.PlayerEntity player, net.minecraft.util.Direction face, net.minecraft.block.BlockState newState) Attempt to place a block in the world, respecting BlockEvent.PlaceEvent results.
static net.minecraft.util.text.TranslationTextComponent	xlate(java.lang.String s, java.lang.Object... args) Get a translation string for the given key.

Methods inherited from class java.lang.Object

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

Field Detail

sin

public static final double[] sin

cos

public static final double[] cos

CIRCLE_POINTS

public static final int CIRCLE_POINTS

See Also:

Constant Field Values

Constructor Detail

PneumaticCraftUtils

public PneumaticCraftUtils()

Method Detail

getDirectionFacing

public static net.minecraft.util.Direction getDirectionFacing(net.minecraft.entity.LivingEntity entity,
                                                              boolean includeUpAndDown)

Returns the EnumFacing of the given entity.

Parameters:

entity - the entity

includeUpAndDown - false when UP/DOWN should not be included.

Returns:

the entity's facing direction

getYawFromFacing

public static int getYawFromFacing(net.minecraft.util.Direction facing)

Get a yaw angle from an EnumFacing

Parameters:

facing - the facing direction

Returns:

the yaw angle

splitStringComponent

public static java.util.List<net.minecraft.util.text.ITextComponent> splitStringComponent(java.lang.String text)

splitStringComponent

public static java.util.List<net.minecraft.util.text.ITextComponent> splitStringComponent(java.lang.String text,
                                                                                          int maxCharPerLine)

splitString

public static java.util.List<java.lang.String> splitString(java.lang.String text,
                                                           int maxCharPerLine)

splitString

public static java.util.List<java.lang.String> splitString(java.lang.String text)

asStringComponent

public static java.util.List<net.minecraft.util.text.ITextComponent> asStringComponent(java.util.List<java.lang.String> l)

convertTicksToMinutesAndSeconds

public static java.lang.String convertTicksToMinutesAndSeconds(long ticks,
                                                               boolean fraction)

Takes in the amount of ticks, and converts it into a time notation. 40 ticks will become "2s", while 2400 will result in "2m".

Parameters:

ticks - number of ticks

fraction - When true, 30 ticks will show as '1.5s' instead of '1s'.

Returns:

a formatted time

convertAmountToString

public static java.lang.String convertAmountToString(int amount)

Takes in any integer, and converts it into a string with a additional postfix if needed. 23000 will convert into 23k for instance.

Parameters:

amount - an integer quantity

Returns:

a formatted string representation

roundNumberTo

public static java.lang.String roundNumberTo(double value,
                                             int decimals)

Rounds numbers (round-nearest) to the given number of decimal places. E.g. 1.234 with decimal 1 will result in a string holding "1.2" but 1.26 with decimal 1 will result in "1.3"

Parameters:

value - a double-precision quantity

decimals - number of digits to the right of the decimal point

Returns:

a formatted string representation

roundNumberToDouble

public static double roundNumberToDouble(double value,
                                         int decimals)

Rounds numbers to the given number of decimal places. E.g. 1.234 with decimal 1 will result in a string holding "1.2"

Parameters:

value - a double-precision quantity

decimals - number of digits to the right of the decimal point

Returns:

the rounded value as a double-precision quantity

epsilonEquals

public static boolean epsilonEquals(float f1,
                                    float f2)

Compare two floats which are tested for having (almost) the same value. There are methods in MathHelper to do this but at least one of them is client-only.

epsilonEquals

public static boolean epsilonEquals(float f1,
                                    float f2,
                                    float maxDifference)

epsilonEquals

public static boolean epsilonEquals(double d1,
                                    double d2)

epsilonEquals

public static boolean epsilonEquals(double d1,
                                    double d2,
                                    double maxDifference)

summariseItemStacks

public static void summariseItemStacks(java.util.List<net.minecraft.util.text.ITextComponent> textList,
                                       net.minecraft.item.ItemStack[] originalStacks)

Sorts the stacks given alphabetically, combines them (so 2x64 will become 1x128), and adds the strings into the given string list. This method is aware of inventory items implementing the IInventoryItem interface.

Parameters:

textList - string list to add information to

originalStacks - array of item stacks to sort & combine

summariseItemStacks

public static void summariseItemStacks(java.util.List<net.minecraft.util.text.ITextComponent> textList,
                                       net.minecraft.item.ItemStack[] originalStacks,
                                       java.lang.String prefix)

Sort the given array of itemstacks alphabetically by display name, then combine them (so e.g. 2x64 becomes 1x128), and add the display name to the given text component list. This method is aware of inventory items implementing the IInventoryItem interface.

Parameters:

textList - text component list to add information to

originalStacks - array of item stacks to sort & combine

prefix - prefix string to prepend to each line of output

getPage

public static java.lang.String getPage(java.lang.String urlString)
                                throws java.io.IOException

Retrieve a web page from the given URL.

Parameters:

urlString - the URL

Returns:

the web page

Throws:

java.io.IOException - if there are any problems

distBetween

public static double distBetween(double x1,
                                 double y1,
                                 double z1,
                                 double x2,
                                 double y2,
                                 double z2)

distBetweenSq

public static double distBetweenSq(double x1,
                                   double y1,
                                   double z1,
                                   double x2,
                                   double y2,
                                   double z2)

distBetweenSq

public static double distBetweenSq(net.minecraft.util.math.vector.Vector3i pos,
                                   double x,
                                   double y,
                                   double z)

distBetweenSq

public static double distBetweenSq(net.minecraft.util.math.BlockPos pos1,
                                   net.minecraft.util.math.BlockPos pos2)

distBetween

public static double distBetween(double x1,
                                 double y1,
                                 double x2,
                                 double y2)

distBetweenSq

public static double distBetweenSq(double x1,
                                   double y1,
                                   double x2,
                                   double y2)

distBetween

public static double distBetween(net.minecraft.util.math.vector.Vector3i pos,
                                 double x,
                                 double y,
                                 double z)

distBetween

public static double distBetween(net.minecraft.util.math.vector.Vector3i pos1,
                                 net.minecraft.util.math.vector.Vector3i pos2)

doesItemMatchFilter

public static boolean doesItemMatchFilter(@Nonnull
                                          net.minecraft.item.ItemStack filterStack,
                                          @Nonnull
                                          net.minecraft.item.ItemStack stack,
                                          boolean checkDurability,
                                          boolean checkNBT,
                                          boolean checkModSimilarity)

isBlockLiquid

public static boolean isBlockLiquid(net.minecraft.block.Block block)

dropItemOnGround

public static void dropItemOnGround(net.minecraft.item.ItemStack stack,
                                    net.minecraft.world.World world,
                                    net.minecraft.util.math.BlockPos pos)

dropItemOnGround

public static void dropItemOnGround(net.minecraft.item.ItemStack stack,
                                    net.minecraft.world.World world,
                                    double x,
                                    double y,
                                    double z)

dropItemOnGroundPrecisely

public static void dropItemOnGroundPrecisely(net.minecraft.item.ItemStack stack,
                                             net.minecraft.world.World world,
                                             double x,
                                             double y,
                                             double z)

getPlayerFromId

public static net.minecraft.entity.player.PlayerEntity getPlayerFromId(java.util.UUID uuid)

getPlayerFromName

public static net.minecraft.entity.player.PlayerEntity getPlayerFromName(java.lang.String name)

isPlayerOp

public static boolean isPlayerOp(net.minecraft.entity.player.PlayerEntity player)

tryPlaceBlock

public static boolean tryPlaceBlock(net.minecraft.world.World w,
                                    net.minecraft.util.math.BlockPos pos,
                                    net.minecraft.entity.player.PlayerEntity player,
                                    net.minecraft.util.Direction face,
                                    net.minecraft.block.BlockState newState)

Attempt to place a block in the world, respecting BlockEvent.PlaceEvent results.

Parameters:

w - the world

pos - the position in the world

player - the player who is placing the block

face - the face against which the block is placed

newState - the blockstate to change the position to

Returns:

true if the block could be placed, false otherwise

createDummyEntity

public static net.minecraft.entity.MobEntity createDummyEntity(net.minecraft.entity.player.PlayerEntity player)

A little hack needed here; in 1.8 players were a subclass of EntityLiving and could be used as entities for pathfinding purposes. But now they extend EntityLivingBase, and pathfinder methods only work for subclasses of EntityLiving. So create a temporary living entity at the player's location and pathfind from that.

Parameters:

player - the player to mimic

Returns:

a dummy player-sized living entity

consumeInventoryItem

public static boolean consumeInventoryItem(net.minecraft.entity.player.PlayerInventory inv,
                                           net.minecraft.item.Item item)

Convenience method, ported from 1.8. Consume one item from the player's inventory.

Parameters:

inv - player's inventory

item - item to consume

Returns:

true if an item was consumed

collectNonEmptyItems

public static void collectNonEmptyItems(net.minecraftforge.items.IItemHandler handler,
                                        net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> items)

Add all of the non-empty items in the given item handler to the given list.

Parameters:

handler - the item handler

items - the list

consumeInventoryItem

public static boolean consumeInventoryItem(net.minecraft.entity.player.PlayerInventory inv,
                                           net.minecraft.item.ItemStack stack)

Convenience method, ported from 1.8. Try to consume one item from the player's inventory.

Parameters:

inv - player's inventory

stack - item to consume

Returns:

true if an item was consumed

xlate

public static net.minecraft.util.text.TranslationTextComponent xlate(java.lang.String s,
                                                                     java.lang.Object... args)

Get a translation string for the given key. This has support for The One Probe which runs server-side.

Parameters:

s - the translation key

Returns:

the translated string (if called server-side, a string which The One Probe will handle client-side)

dyeColorDesc

public static net.minecraft.util.text.ITextComponent dyeColorDesc(int c)

copyItemHandler

public static void copyItemHandler(net.minecraftforge.items.IItemHandler source,
                                   net.minecraftforge.items.ItemStackHandler dest,
                                   int maxSlots)

copyItemHandler

public static void copyItemHandler(net.minecraftforge.items.IItemHandler source,
                                   net.minecraftforge.items.ItemStackHandler dest)

getPosForEntity

public static net.minecraft.util.math.BlockPos getPosForEntity(net.minecraft.entity.Entity e)

posToString

public static java.lang.String posToString(net.minecraft.util.math.BlockPos pos)

getTileEntityAt

public static <T extends net.minecraft.tileentity.TileEntity> java.util.Optional<T> getTileEntityAt(net.minecraft.world.IBlockReader w,
                                                                                                    net.minecraft.util.math.BlockPos pos,
                                                                                                    java.lang.Class<T> cls)

fillTankWithOrb

public static boolean fillTankWithOrb(net.minecraftforge.fluids.capability.IFluidHandler handler,
                                      net.minecraft.entity.item.ExperienceOrbEntity orb,
                                      net.minecraftforge.fluids.capability.IFluidHandler.FluidAction action)

Try to transfer the XP from the given XP orb entity into the given fluid handler. If the handler has enough room to store only part of the orb's XP, it will reduce the orb's XP by the amount taken (assuming the action is execute). Does not remove the entity; the caller should do that iff this returns true.

Parameters:

handler - the fluid handler

orb - the XP orb

action - whether or not to simulate the action

Returns:

true if the XP orb was (or could be) fully absorbed into the fluid handler

getPlayerReachDistance

public static double getPlayerReachDistance(net.minecraft.entity.player.PlayerEntity player)

canPlayerReach

public static boolean canPlayerReach(net.minecraft.entity.player.PlayerEntity player,
                                     net.minecraft.util.math.BlockPos pos)

getMinHeight

public static int getMinHeight(net.minecraft.world.World world)

In 1.17 this will become non-trivial. Adding it now to make porting easier in future.

Parameters:

world - the world

Returns:

minimum height allowed for this world.

isInteger

public static boolean isInteger(java.lang.String str)

Check if a given string encodes a valid integer (negative included). Also intended to work for partial strings, so useful for textfield validation.

Parameters:

str - the string to test

Returns:

true if the string encodes an integer (i.e. Integer.parseInt(str) won't throw an exception)

isNumber

public static boolean isNumber(java.lang.String str)

Check if a given string encodes a valid number (negative & decimal point included). Also intended to work for partial strings, so useful for textfield validation.

Parameters:

str - the string to test

Returns:

true if the string encodes a number (i.e. NumberUtils.createNumber(str) won't throw an exception)

modDefaultedRL

public static net.minecraft.util.ResourceLocation modDefaultedRL(java.lang.String str)

Get a resource location from the given string, defaulting to "pneumaticcraft:" namespace

Parameters:

str - a string

Returns:

a resource location

modDefaultedString

public static java.lang.String modDefaultedString(net.minecraft.util.ResourceLocation rl)

Stringify a resource location, omitting the namespace if it's "pneumaticcraft:"

Parameters:

rl - a resource location

Returns:

stringified resource location

copyNBTWithout

public static net.minecraft.nbt.CompoundNBT copyNBTWithout(@Nonnull
                                                           net.minecraft.nbt.CompoundNBT nbt,
                                                           @Nonnull
                                                           java.lang.String skip)