Minestom/src/main/java/net/minestom/server/event/player/PlayerSpawnEvent.java

47 lines
1.2 KiB
Java

package net.minestom.server.event.player;
import net.minestom.server.entity.Player;
import net.minestom.server.event.trait.PlayerInstanceEvent;
import net.minestom.server.instance.Instance;
import org.jetbrains.annotations.NotNull;
/**
* Called when a new instance is set for a player.
*/
public class PlayerSpawnEvent implements PlayerInstanceEvent {
private final Player player;
private final Instance spawnInstance;
private final boolean firstSpawn;
public PlayerSpawnEvent(@NotNull Player player, @NotNull Instance spawnInstance, boolean firstSpawn) {
this.player = player;
this.spawnInstance = spawnInstance;
this.firstSpawn = firstSpawn;
}
/**
* Gets the player's new instance.
*
* @return the instance
*/
@NotNull
@Deprecated
public Instance getSpawnInstance() {
return spawnInstance;
}
/**
* 'true' if the player is spawning for the first time. 'false' if this spawn event was triggered by a dimension teleport
*
* @return true if this is the first spawn, false otherwise
*/
public boolean isFirstSpawn() {
return firstSpawn;
}
@Override
public @NotNull Player getPlayer() {
return player;
}
}