net.minecraftforge.common.util

Interface ITeleporter

All Known Implementing Classes:

Teleporter

public interface ITeleporter

Interface for handling the placement of entities during dimension change. An implementation of this interface can be used to place the entity in a safe location, or generate a return portal, for instance. See the Teleporter class, which has been patched to implement this interface, for a vanilla example.

Method Summary

Modifier and Type	Method and Description
default Entity	placeEntity(Entity entity, ServerWorld currentWorld, ServerWorld destWorld, float yaw, java.util.function.Function<java.lang.Boolean,Entity> repositionEntity) Called to handle placing the entity in the new world.

Method Detail

placeEntity

default Entity placeEntity(Entity entity,
                           ServerWorld currentWorld,
                           ServerWorld destWorld,
                           float yaw,
                           java.util.function.Function<java.lang.Boolean,Entity> repositionEntity)

Called to handle placing the entity in the new world. The initial position of the entity will be its position in the origin world, multiplied horizontally by the computed cross-dimensional movement factor (see IForgeDimension.getMovementFactor()). Note that the supplied entity has not yet been spawned in the destination world at the time.

Parameters:

entity - the entity to be placed

currentWorld - the entity's origin

destWorld - the entity's destination

yaw - the suggested yaw value to apply

repositionEntity - a function to reposition the entity, which returns the new entity in the new dimension. This is the vanilla implementation of the dimension travel logic. If the supplied boolean is true, it is attempted to spawn a new portal.

Returns:

the entity in the new World. Vanilla creates for most Entitys a new instance and copy the data. But you are not allowed to create a new instance for PlayerEntitys! Move the player and update its state, see ServerPlayerEntity.changeDimension(net.minecraft.world.dimension.DimensionType, ITeleporter)