me.desht.pneumaticcraft.api.item

Interface IPositionProvider

All Known Implementing Classes:

ItemAmadronTablet, ItemGPSAreaTool, ItemGPSTool

public interface IPositionProvider

Represents an item which can store & provide one or more block positions. An example would be the GPS Tool (one position), the GPS Area Tool (possibly many positions) or the Amadron Tablet (two positions).

Method Summary

Modifier and Type	Method and Description
default boolean	disableDepthTest() Whether or not the rendered positions should be visible through the world.
default java.util.List<net.minecraft.util.math.BlockPos>	getRawStoredPositions(net.minecraft.world.World world, net.minecraft.item.ItemStack stack) Gets the raw stored positions in this provider.
default int	getRenderColor(int index) Color that should be used to highlight the stored block positions if & when they are rendered on-screen.
java.util.List<net.minecraft.util.math.BlockPos>	getStoredPositions(net.minecraft.world.World world, net.minecraft.item.ItemStack stack) Get block position data from the given ItemStack.
default void	syncVariables(net.minecraft.entity.player.ServerPlayerEntity player, net.minecraft.item.ItemStack stack) If the item stores any global variables which the client needs to know about (e.g.

Method Detail

getStoredPositions

@Nonnull
java.util.List<net.minecraft.util.math.BlockPos> getStoredPositions(net.minecraft.world.World world,
                                                                             @Nonnull
                                                                             net.minecraft.item.ItemStack stack)

Get block position data from the given ItemStack. It is up to the implementor to decide how the block positions should be stored on the itemstack and in what order they should be returned.

Parameters:

world - the world (if a server world, global variables may be used)

stack - the itemstack

Returns:

a list of block positions that has been retrieved from the itemstack

getRenderColor

default int getRenderColor(int index)

Color that should be used to highlight the stored block positions if & when they are rendered on-screen.

Parameters:

index - the index in the list returned by getStoredPositions()

Returns:

a color in ARGB format, or 0 to skip rendering completely

disableDepthTest

default boolean disableDepthTest()

Whether or not the rendered positions should be visible through the world.

Returns:

true if visible through the world, false if not.

getRawStoredPositions

default java.util.List<net.minecraft.util.math.BlockPos> getRawStoredPositions(net.minecraft.world.World world,
                                                                               net.minecraft.item.ItemStack stack)

Gets the raw stored positions in this provider. E.g. for the GPS Area Tool, just the two clicked positions, not the whole set of positions defined by the tool's area type.

Parameters:

world - the world (if a server world, global variables may be used)

stack - the itemstack

Returns:

the raw positions stored on the itemstack

syncVariables

default void syncVariables(net.minecraft.entity.player.ServerPlayerEntity player,
                           net.minecraft.item.ItemStack stack)

If the item stores any global variables which the client needs to know about (e.g. for area rendering), implement this method to sync their values to the client. This method is only called server-side, of course. See PneumaticRegistry.IPneumaticCraftInterface.syncGlobalVariable(ServerPlayerEntity, String)} for a convenience method to send the necessary sync packet.

Parameters:

player - the player to sync to

stack - the itemstack