Class PlayerSpawnEvent

java.lang.Object

net.minestom.server.event.player.PlayerSpawnEvent

All Implemented Interfaces:

Event, EntityEvent, EntityInstanceEvent, InstanceEvent, PlayerEvent, PlayerInstanceEvent

public class PlayerSpawnEvent
extends Object
implements PlayerInstanceEvent

Called when a new instance is set for a player.

Constructor Summary

Constructors

Constructor	Description
PlayerSpawnEvent(Player player, Instance spawnInstance, boolean firstSpawn)

Method Summary

Modifier and Type	Method	Description
Player	getPlayer()	Gets the player.
Instance	getSpawnInstance()	Deprecated.
boolean	isFirstSpawn()	'true' if the player is spawning for the first time.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface EntityInstanceEvent

getInstance

Methods inherited from interface PlayerEvent

getEntity

Constructor Details

PlayerSpawnEvent

public PlayerSpawnEvent(Player player,
 Instance spawnInstance,
 boolean firstSpawn)

Method Details

getSpawnInstance

@Deprecated
public Instance getSpawnInstance()

Deprecated.

Gets the player's new instance.

Returns:

the instance

isFirstSpawn

public boolean isFirstSpawn()

'true' if the player is spawning for the first time. 'false' if this spawn event was triggered by a dimension teleport

Returns:

true if this is the first spawn, false otherwise

getPlayer

public Player getPlayer()

Description copied from interface: PlayerEvent

Gets the player.

Specified by:

getPlayer in interface PlayerEvent

Returns:

the player