me.desht.pneumaticcraft.api.drone

Interface IDrone

All Superinterfaces:

net.minecraftforge.common.capabilities.ICapabilityProvider

All Known Subinterfaces:

IDroneBase

All Known Implementing Classes:

EntityAmadrone, EntityCollectorDrone, EntityDrone, EntityGuardDrone, EntityHarvestingDrone, EntityLogisticsDrone, TileEntityProgrammableController

public interface IDrone
extends net.minecraftforge.common.capabilities.ICapabilityProvider

Represents a drone or drone-like object (e.g. a Programmable Controller).

Do not implement this class yourself!

Method Summary

Modifier and Type	Method and Description
void	dropItem(net.minecraft.item.ItemStack stack) Cause the drone to drop the given item at its position.
java.util.List<net.minecraft.entity.Entity>	getCarryingEntities() Get the list of entities currently carried by this drone.
net.minecraft.util.math.BlockPos	getControllerPos() Get the position of the drone's controller.
net.minecraft.util.math.BlockPos	getDeployPos() Get the blockpos at which this drone was deployed (by player or dispenser).
net.minecraft.util.math.vector.Vector3d	getDronePos() Get the drone's exact position.
net.minecraftforge.common.util.FakePlayer	getFakePlayer() Get the fake player object for the drone.
net.minecraftforge.fluids.IFluidTank	getFluidTank() Get the drone's fluid tank.
net.minecraftforge.items.IItemHandlerModifiable	getInv() Get the drone's inventory.
net.minecraft.entity.player.PlayerEntity	getOwner() Retrieve the owning player of this drone; i.e.
java.util.UUID	getOwnerUUID() Get the UUID of the drone's owner.
IPathNavigator	getPathNavigator() Get the drone's path navigator object.
net.minecraft.entity.ai.goal.GoalSelector	getTargetAI() Get the drone's current collection of tasks.
int	getUpgrades(EnumUpgrade upgrade) Get the number of installed upgrades of the given item type.
boolean	isAIOverridden() Has the drone's normal tasks been overridden by special circumstances? E.g.
boolean	isBlockValidPathfindBlock(net.minecraft.util.math.BlockPos pos) Is the given position valid for pathfinding purposes? i.e.
void	onItemPickupEvent(net.minecraft.entity.item.ItemEntity curPickingUpEntity, int stackSize) Called when a drone is picking up an item.
void	sendWireframeToClient(net.minecraft.util.math.BlockPos pos) Send a position to the client to be rendered by the Pneumatic Helmet with Entity Tracker.
void	setCarryingEntity(net.minecraft.entity.Entity entity) Make the drone pick up the given entity.
void	setDugBlock(net.minecraft.util.math.BlockPos pos) Mark the given block as being dug.
void	setEmittingRedstone(net.minecraft.util.Direction orientation, int emittingRedstone) Make the drone emit redstone in the given direction from its current position.
void	setName(net.minecraft.util.text.ITextComponent string) Set the drone's custom name.
net.minecraft.world.World	world() Get the drone's world.

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

getCapability, getCapability

Method Detail

getUpgrades

int getUpgrades(EnumUpgrade upgrade)

Get the number of installed upgrades of the given item type.

Returns:

amount of installed upgrades in the drone

world

net.minecraft.world.World world()

Get the drone's world.

Returns:

a world

getFluidTank

net.minecraftforge.fluids.IFluidTank getFluidTank()

Get the drone's fluid tank. Note that this is also accessible via the CapabilityFluidHandler.FLUID_HANDLER_CAPABILITY capability.

Returns:

a fluid tank

getInv

net.minecraftforge.items.IItemHandlerModifiable getInv()

Get the drone's inventory. Note that this is also accessible via the CapabilityItemHandler.ITEM_HANDLER_CAPABILITY capability.

Returns:

an inventory

getDronePos

net.minecraft.util.math.vector.Vector3d getDronePos()

Get the drone's exact position.

Returns:

the entity position

getControllerPos

net.minecraft.util.math.BlockPos getControllerPos()

Get the position of the drone's controller. For actual drone entities, this will always be (0,0,0). If the drone is actually a Programmable Controller, it will be the controller's block position.

getPathNavigator

IPathNavigator getPathNavigator()

Get the drone's path navigator object.

Returns:

the path navigator

sendWireframeToClient

void sendWireframeToClient(net.minecraft.util.math.BlockPos pos)

Send a position to the client to be rendered by the Pneumatic Helmet with Entity Tracker. This is used to highlight blacklisted block positions.

Parameters:

pos - a block position

getFakePlayer

net.minecraftforge.common.util.FakePlayer getFakePlayer()

Get the fake player object for the drone. This will always return null if called client-side.

Returns:

a fake player

isBlockValidPathfindBlock

boolean isBlockValidPathfindBlock(net.minecraft.util.math.BlockPos pos)

Is the given position valid for pathfinding purposes? i.e. may the drone move through or to it?

Custom pathfinding functionality may be added via IDroneRegistry.addPathfindableBlock(Block, IPathfindHandler).

Parameters:

pos - a block position

Returns:

true if the position is valid, false otherwise

dropItem

void dropItem(net.minecraft.item.ItemStack stack)

Cause the drone to drop the given item at its position. The specified item does not need to be in the drone's inventory, nor will it be removed from the drone's inventory if present.

Parameters:

stack - the item stack to drop

setDugBlock

void setDugBlock(net.minecraft.util.math.BlockPos pos)

Mark the given block as being dug.

Parameters:

pos - a block position

getTargetAI

net.minecraft.entity.ai.goal.GoalSelector getTargetAI()

Get the drone's current collection of tasks.

Returns:

a vanilla EntityAITasks object

setEmittingRedstone

void setEmittingRedstone(net.minecraft.util.Direction orientation,
                         int emittingRedstone)

Make the drone emit redstone in the given direction from its current position.

Parameters:

orientation - the direction to emit

emittingRedstone - the redstone level

setName

void setName(net.minecraft.util.text.ITextComponent string)

Set the drone's custom name.

Parameters:

string - a custom name

setCarryingEntity

void setCarryingEntity(net.minecraft.entity.Entity entity)

Make the drone pick up the given entity. The given entity will be set as a rider of the drone, but it will not have any control over the drone (in fact, its AI is disabled while being carried).

Parameters:

entity - an entity to pick up, or null to drop any currently-held entity

getCarryingEntities

java.util.List<net.minecraft.entity.Entity> getCarryingEntities()

Get the list of entities currently carried by this drone. Note: although this method returns a list, drones currently only support carrying a single entity.

Returns:

a list of entities

isAIOverridden

boolean isAIOverridden()

Has the drone's normal tasks been overridden by special circumstances? E.g. drone hacked, or heading to a charging station.

Returns:

true if the drone's normal AI has been overridden

onItemPickupEvent

void onItemPickupEvent(net.minecraft.entity.item.ItemEntity curPickingUpEntity,
                       int stackSize)

Called when a drone is picking up an item.

Parameters:

curPickingUpEntity - the item entity

stackSize - the size of the itemstack in the item entity

getOwner

net.minecraft.entity.player.PlayerEntity getOwner()

Retrieve the owning player of this drone; i.e. the player who deployed the drone. A drone deployed by a Dispenser does not have a valid player owner.

Returns:

the owning player; will be null if the owner is offline or the drone was not player-deployed

getOwnerUUID

@Nonnull
java.util.UUID getOwnerUUID()

Get the UUID of the drone's owner. This will be non-null even if the owning player is offline. A drone deployed by a Dispenser has an arbitrary owner UUID that was assigned to it when it was spawned.

Returns:

the owner's UUID

getDeployPos

net.minecraft.util.math.BlockPos getDeployPos()

Get the blockpos at which this drone was deployed (by player or dispenser). For the Programmable Controller, this will simply return the controller's block position.

Returns:

the deployment pos