org.spongepowered.api.world

Interface PortalAgent

public interface PortalAgent

An agent that handles teleportation between Location's. This can be understood as an agent that handles the creation of "portals" between World's.

An example is the agent handling nether portals.

Method Summary

Modifier and Type	Method and Description
Optional<Location<World>>	createPortal(Location<World> targetLocation) Tells this agent to create a new "portal" location at the suggested Location.
Optional<Location<World>>	findOrCreatePortal(Location<World> targetLocation) Attempts to find a "portal" location, or if none are available, creates one.
Optional<Location<World>>	findPortal(Location<World> targetLocation) Attempts to find a "portal" location.
int	getCreationRadius() Gets the radius of where a "portal" can be created.
int	getSearchRadius() Gets the search radius before a new acceptable "portal" location is created.
PortalAgentType	getType() Gets the type of PortalAgent.
PortalAgent	setCreationRadius(int radius) Sets the creation radius of where a portal may be created.
PortalAgent	setSearchRadius(int radius) Sets the search radius before a new acceptable "portal" location is created.

Method Detail

getSearchRadius

int getSearchRadius()

Gets the search radius before a new acceptable "portal" location is created.

Returns:

The search radius

setSearchRadius

PortalAgent setSearchRadius(int radius)

Sets the search radius before a new acceptable "portal" location is created.

Parameters:

radius - The new radius

Returns:

This agent, for chaining

getCreationRadius

int getCreationRadius()

Gets the radius of where a "portal" can be created.

Returns:

The radius of where a portal can be created

setCreationRadius

PortalAgent setCreationRadius(int radius)

Sets the creation radius of where a portal may be created.

Parameters:

radius - The new radius

Returns:

This agent, for chaining

findOrCreatePortal

Optional<Location<World>> findOrCreatePortal(Location<World> targetLocation)

Attempts to find a "portal" location, or if none are available, creates one. Returns Optional.empty() if none are found.

Parameters:

targetLocation - The suggested location

Returns:

The found location of the "portal", if available

findPortal

Optional<Location<World>> findPortal(Location<World> targetLocation)

Attempts to find a "portal" location. Returns Optional.empty() if none are found.

Parameters:

targetLocation - The suggested location

Returns:

The found location of the "portal", if available

createPortal

Optional<Location<World>> createPortal(Location<World> targetLocation)

Tells this agent to create a new "portal" location at the suggested Location. If ChangeBlockEvent.Place is cancelled, Optional.empty() is returned.

Note: In order to adjust or prevent the Location's of each BlockState set, listen to ChangeBlockEvent.Place and check for the root cause of this portal agent.

Parameters:

targetLocation - The targeted location

Returns:

The newly created "portal" location, if available

getType

PortalAgentType getType()

Gets the type of PortalAgent.

Returns:

The type