AsyncPlayerSpawnLocationEvent.java

package io.papermc.paper.event.player;

import com.google.common.base.Preconditions;
import io.papermc.paper.connection.PlayerConfigurationConnection;
import org.bukkit.Location;
import org.bukkit.Server;
import org.bukkit.World;
import org.bukkit.event.Event;
import org.bukkit.event.HandlerList;
import org.jetbrains.annotations.ApiStatus;
import org.jspecify.annotations.NullMarked;

/**
 * Called when selecting a player's spawn location (i.e. joining the server or reconfiguring).
 *
 * <p>The player will be kept in the configuration phase until all event handlers return and
 * the spawn location is loaded.</p>
 */
@ApiStatus.Experimental
@NullMarked
public class AsyncPlayerSpawnLocationEvent extends Event {

    private static final HandlerList HANDLER_LIST = new HandlerList();

    private final PlayerConfigurationConnection connection;
    private final boolean newPlayer;
    private Location spawnLocation;

    @ApiStatus.Internal
    public AsyncPlayerSpawnLocationEvent(final PlayerConfigurationConnection connection, final Location spawnLocation, final boolean newPlayer) {
        super(true);
        this.connection = connection;
        this.spawnLocation = spawnLocation;
        this.newPlayer = newPlayer;
    }

    /**
     * Gets the spawning player's connection.
     *
     * @return the player connection
     */
    public PlayerConfigurationConnection getConnection() {
        return this.connection;
    }

    /**
     * Gets the player's spawn location.
     *
     * <p>If the player has played on this server before, defaults to the location inside the player data file.
     * For new players, the default spawn location is the {@link World#getSpawnLocation() spawn location}
     * of the {@link Server#getRespawnWorld() respawn world}.</p>
     *
     * @return the spawn location
     */
    public Location getSpawnLocation() {
        return this.spawnLocation;
    }

    /**
     * Sets player's spawn location.
     *
     * @param location the spawn location
     */
    public void setSpawnLocation(final Location location) {
        Preconditions.checkArgument(location != null, "Location cannot be null");
        Preconditions.checkArgument(location.getWorld() != null, "World cannot be null");
        this.spawnLocation = location.clone();
    }

    /**
     * Returns true if the player is joining the server for the first time.
     *
     * @return whether the player is new
     */
    public boolean isNewPlayer() {
        return this.newPlayer;
    }

    @Override
    public HandlerList getHandlers() {
        return HANDLER_LIST;
    }

    public static HandlerList getHandlerList() {
        return HANDLER_LIST;
    }
}