net.fabricmc.fabric.api.dimension.v1

Class FabricDimensions

java.lang.Object

net.fabricmc.fabric.api.dimension.v1.FabricDimensions

public final class FabricDimensions
extends Object

This class consists exclusively of static methods that operate on world dimensions.

Method Summary

Modifier and Type	Method and Description
static <E extends net.minecraft.entity.Entity> E	teleport(E teleported, net.minecraft.world.dimension.DimensionType destination) Teleports an entity to a different dimension, using custom placement logic.
static <E extends net.minecraft.entity.Entity> E	teleport(E teleported, net.minecraft.world.dimension.DimensionType destination, EntityPlacer customPlacer) Teleports an entity to a different dimension, using custom placement logic.

Methods inherited from class java.lang.Object

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

Method Detail

teleport

public static <E extends net.minecraft.entity.Entity> E teleport(E teleported,
                                                                 net.minecraft.world.dimension.DimensionType destination)

Teleports an entity to a different dimension, using custom placement logic.

This method behaves as if:

 teleported.changeDimension(destination)

If destination is a FabricDimensionType, the placement logic used is FabricDimensionType.getDefaultPlacement(). If destination is the nether or the overworld, the default logic is the vanilla path. For any other dimension, the default placement behaviour is undefined. When delegating to a placement logic that uses portals, the entity's lastPortalPosition, lastPortalDirectionVector, and lastPortalDirection fields should be updated before calling this method.

After calling this method, teleported may be invalidated. Callers should use the returned entity for any further manipulation.

Parameters:

teleported - the entity to teleport

destination - the dimension the entity will be teleported to

Returns:

the teleported entity, or a clone of it

See Also:

teleport(Entity, DimensionType, EntityPlacer)

teleport

public static <E extends net.minecraft.entity.Entity> E teleport(E teleported,
                                                                 net.minecraft.world.dimension.DimensionType destination,
                                                                 EntityPlacer customPlacer)

Teleports an entity to a different dimension, using custom placement logic.

If customPlacement is null, this method behaves as if:

 teleported.changeDimension(destination)

The customPlacement may itself return null, in which case the default placement logic for that dimension will be run.

If destination is a FabricDimensionType, the default placement logic is FabricDimensionType.getDefaultPlacement(). If destination is the nether or the overworld, the default logic is the vanilla path. For any other dimension, the default placement behaviour is undefined. When delegating to a placement logic that uses portals, the entity's lastPortalPosition, lastPortalDirectionVector, and lastPortalDirection fields should be updated before calling this method.

After calling this method, teleported may be invalidated. Callers should use the returned entity for any further manipulation.

Type Parameters:

E - the type of the teleported entity

Parameters:

teleported - the entity to teleport

destination - the dimension the entity will be teleported to

customPlacer - custom placement logic that will run before the default one, or null to use the dimension's default behavior (see FabricDimensionType.getDefaultPlacement()).

Returns:

the teleported entity, or a clone of it

Throws:

IllegalStateException - if this method is called on a client entity