Skip to content

Introduce TeleportBehavior #2614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
whimxiqal wants to merge 2 commits into
base: api-12
Choose a base branch
from
Open

Introduce TeleportBehavior #2614

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4ed3e1
Add teleporting behavior to PortalLogic
whimxiqal Aug 16, 2026
e76cc39
javadoc
whimxiqal Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 37 additions & 10 deletions src/main/java/org/spongepowered/api/world/portal/PortalLogic.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ static Factory factory() {

Optional<PortalFinder> finder();

Optional<TeleportBehavior> teleporter();

Optional<PortalGenerator> generator();

/**
Expand All @@ -70,8 +72,12 @@ static Factory factory() {
* @param generateDestinationPortal True if the portal should generate a destination one
* @return True if teleport successful, false if not
*/
boolean teleport(Entity entity, ServerLocation destination, boolean generateDestinationPortal);
@Deprecated
default boolean teleport(Entity entity, ServerLocation destination, boolean generateDestinationPortal) {
return teleport(entity.serverLocation(), entity, destination, generateDestinationPortal);
}

boolean teleport(ServerLocation origin, Entity entity, ServerLocation destination, boolean generateDestinationPortal);

interface Factory {

Expand Down Expand Up @@ -192,33 +198,35 @@ interface Factory {

interface Builder extends ResettableBuilder<PortalLogic, Builder> {

default Builder addSimplePortal(PortalExitCalculator calulator) {
return this.addPortalWithFinder(calulator, PortalLogic.factory().noOpFinder());
default Builder addSimplePortal(PortalExitCalculator calculator) {
return this.addPortalWithFinder(calculator, PortalLogic.factory().noOpFinder());
}

default Builder addPortalWithFinder(PortalExitCalculator calulator, PortalFinder finder) {
return this.addPortal(calulator, finder, (at, axis) -> Optional.empty());
default Builder addPortalWithFinder(PortalExitCalculator calculator, PortalFinder finder) {
return this.addPortal(calculator, finder, (from, to, entity) -> to, (at, axis) -> Optional.empty());
}

default Builder addPortalWithGenerator(PortalExitCalculator calulator, PortalGenerator generator) {
return this.addPortal(calulator, (at, r) -> Optional.empty(), generator);
default Builder addPortalWithGenerator(PortalExitCalculator calculator, PortalGenerator generator) {
return this.addPortal(calculator, (at, r) -> Optional.empty(), (from, to, entity) -> to, generator);
}

/**
* Adds a portal to the builder.
* <p>For a portal to work it needs to calculate a valid exit
* location then find an existing or generate a new portal</p>
*
* @param calulator the portal exit calculator
* @param calculator the portal exit calculator
* @param finder the portal finder
* @param generator the portal generator
*
* @return this builder for chaining
*/
Builder addPortal(PortalExitCalculator calulator, PortalFinder finder, PortalGenerator generator);
@Deprecated
Builder addPortal(PortalExitCalculator calculator, PortalFinder finder, PortalGenerator generator);

<T extends PortalExitCalculator & PortalFinder & PortalGenerator> Builder addPortal(T logic);
Builder addPortal(PortalExitCalculator calculator, PortalFinder finder, TeleportBehavior teleportBehavior, PortalGenerator generator);

<T extends PortalLogic.PortalExitCalculator & PortalLogic.PortalFinder & PortalLogic.TeleportBehavior & PortalLogic.PortalGenerator> Builder addPortal(T logic);

PortalLogic build();
}
Expand Down Expand Up @@ -267,6 +275,25 @@ interface PortalFinder {
Optional<Portal> findPortal(ServerLocation location, int searchRange);
}

@FunctionalInterface
interface TeleportBehavior {

/**
* Calculates a desired location to teleport to,
* given an original pre-teleport block location
* and a destination block location inside the
* destination portal.
*
* @param from the origin location
* @param to the destination location in the portal
* @param entity the entity
*
* @return the location to teleport to
*/
ServerLocation spawnLocation(ServerLocation from, ServerLocation to, Entity entity);

}


@FunctionalInterface
interface PortalGenerator {
Expand Down