Package dev.objz.commandbridge.api.platform

Interface PlayerLocator

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 interface PlayerLocator

Service for resolving which server a player is currently connected to within the bridge network.

A PlayerLocator is available only on the Velocity proxy. Obtain an instance via CommandBridgeAPI.playerLocator(). On backend servers, that method returns Optional.empty().

To resolve a player's current server:

 locator.locate(playerUUID).ifPresent(target ->
         Log.info("Player is on server: {}", target.id()));
 

See Also:

• CommandBridgeAPI.playerLocator()
• Platform.ServerTarget

Method Summary

Modifier and Type	Method	Description
Optional<Platform.ServerTarget>	locate(UUID player)	Resolves the server a player is currently connected to.

Method Details

locate

Optional<Platform.ServerTarget> locate(UUID player)

Resolves the server a player is currently connected to.

Parameters:

player - the UUID of the player to locate

Returns:

an Optional containing the Platform.ServerTarget of the server the player is connected to, or an empty Optional if the player is offline or their location is unknown

See Also:

• Platform.ServerTarget