public class PlayerLoginEvent extends PlayerEvent
PlayerJoinEvent
instead.Modifier and Type | Class | Description |
---|---|---|
static class |
PlayerLoginEvent.Result |
Basic kick reasons for communicating to plugins
|
player
Constructor | Description |
---|---|
PlayerLoginEvent(@NotNull Player player,
@NotNull String hostname,
@NotNull InetAddress address) |
|
PlayerLoginEvent(@NotNull Player player,
@NotNull String hostname,
@NotNull InetAddress address,
@NotNull InetAddress realAddress) |
This constructor defaults message to an empty string, and result to
ALLOWED
|
PlayerLoginEvent(@NotNull Player player,
@NotNull String hostname,
@NotNull InetAddress address,
@NotNull PlayerLoginEvent.Result result,
@NotNull String message,
@NotNull InetAddress realAddress) |
This constructor pre-configures the event with a result and message
|
Modifier and Type | Method | Description |
---|---|---|
void |
allow() |
Allows the player to log in
|
void |
disallow(@NotNull PlayerLoginEvent.Result result,
@NotNull String message) |
Disallows the player from logging in, with the given reason
|
@NotNull InetAddress |
getAddress() |
Gets the
InetAddress for the Player associated with this event. |
static @NotNull HandlerList |
getHandlerList() |
|
@NotNull HandlerList |
getHandlers() |
|
@NotNull String |
getHostname() |
Gets the hostname that the player used to connect to the server, or
blank if unknown
|
@NotNull String |
getKickMessage() |
Gets the current kick message that will be used if getResult() !=
Result.ALLOWED
|
@NotNull InetAddress |
getRealAddress() |
Gets the connection address of this player, regardless of whether it has been spoofed or not.
|
@NotNull PlayerLoginEvent.Result |
getResult() |
Gets the current result of the login, as an enum
|
void |
setKickMessage(@NotNull String message) |
Sets the kick message to display if getResult() != Result.ALLOWED
|
void |
setResult(@NotNull PlayerLoginEvent.Result result) |
Sets the new result of the login, as an enum
|
callEvent, getEventName, isAsynchronous
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getPlayer
public PlayerLoginEvent(@NotNull @NotNull Player player, @NotNull @NotNull String hostname, @NotNull @NotNull InetAddress address, @NotNull @NotNull InetAddress realAddress)
player
- The Player
for this eventhostname
- The hostname that was used to connect to the serveraddress
- The address the player used to connect, provided for
timing issuesrealAddress
- the actual, unspoofed connecting addresspublic PlayerLoginEvent(@NotNull @NotNull Player player, @NotNull @NotNull String hostname, @NotNull @NotNull InetAddress address)
public PlayerLoginEvent(@NotNull @NotNull Player player, @NotNull @NotNull String hostname, @NotNull @NotNull InetAddress address, @NotNull @NotNull PlayerLoginEvent.Result result, @NotNull @NotNull String message, @NotNull @NotNull InetAddress realAddress)
player
- The Player
for this eventhostname
- The hostname that was used to connect to the serveraddress
- The address the player used to connect, provided for
timing issuesresult
- The result status for this eventmessage
- The message to be displayed if result denies loginrealAddress
- the actual, unspoofed connecting address@NotNull public @NotNull InetAddress getRealAddress()
@NotNull public @NotNull PlayerLoginEvent.Result getResult()
public void setResult(@NotNull @NotNull PlayerLoginEvent.Result result)
result
- New result to set@NotNull public @NotNull String getKickMessage()
public void setKickMessage(@NotNull @NotNull String message)
message
- New kick message@NotNull public @NotNull String getHostname()
public void allow()
public void disallow(@NotNull @NotNull PlayerLoginEvent.Result result, @NotNull @NotNull String message)
result
- New result for disallowing the playermessage
- Kick message to display to the user@NotNull public @NotNull InetAddress getAddress()
InetAddress
for the Player associated with this event.
This method is provided as a workaround for player.getAddress()
returning null during PlayerLoginEvent.@NotNull public @NotNull HandlerList getHandlers()
getHandlers
in class Event
@NotNull public static @NotNull HandlerList getHandlerList()
Copyright © 2020. All rights reserved.