Package org.spongepowered.api.world.portal

Interface PortalLogic.PortalGenerator

Enclosing interface:

PortalLogic

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface PortalLogic.PortalGenerator

Method Summary

Modifier and Type	Method	Description
Optional<Portal>	generatePortal(ServerLocation location, Axis axis)	Attempts to generate the portal at the location.

Method Details

generatePortal

Optional<Portal> generatePortal(ServerLocation location,
 Axis axis)

Attempts to generate the portal at the location.

It is left up to the discretion of the implementer how this is done. Portals come in all shapes and sizes or none at all.

The location and axis are meant to be hints and should not be considered to be the exact final location/orientation of the resulting portal.

Parameters:

location - The location

axis - The axis

Returns:

the adjusted teleport location if generated