Bukkit-API
1.7.9-R0.2
The inofficial Bukkit-API
|
Classes | |
enum | Result |
Public Member Functions | |
PlayerLoginEvent (final Player player) | |
PlayerLoginEvent (final Player player, final String hostname) | |
PlayerLoginEvent (final Player player, final String hostname, final InetAddress address) | |
PlayerLoginEvent (final Player player, final Result result, final String message) | |
PlayerLoginEvent (final Player player, String hostname, final InetAddress address, final Result result, final String message) | |
Result | getResult () |
void | setResult (final Result result) |
String | getKickMessage () |
void | setKickMessage (final String message) |
String | getHostname () |
void | allow () |
void | disallow (final Result result, final String message) |
InetAddress | getAddress () |
HandlerList | getHandlers () |
![]() | |
PlayerEvent (final Player who) | |
final Player | getPlayer () |
![]() | |
Event () | |
Event (boolean isAsync) | |
String | getEventName () |
abstract HandlerList | getHandlers () |
final boolean | isAsynchronous () |
Static Public Member Functions | |
static HandlerList | getHandlerList () |
Additional Inherited Members | |
![]() | |
Player | player |
Stores details for players attempting to log in
Definition at line 11 of file PlayerLoginEvent.java.
org.bukkit.event.player.PlayerLoginEvent.PlayerLoginEvent | ( | final Player | player | ) |
Definition at line 22 of file PlayerLoginEvent.java.
org.bukkit.event.player.PlayerLoginEvent.PlayerLoginEvent | ( | final Player | player, |
final String | hostname | ||
) |
Definition at line 30 of file PlayerLoginEvent.java.
org.bukkit.event.player.PlayerLoginEvent.PlayerLoginEvent | ( | final Player | player, |
final String | hostname, | ||
final InetAddress | address | ||
) |
This constructor defaults message to an empty string, and result to ALLOWED
player | The Player for this event |
hostname | The hostname that was used to connect to the server |
address | The address the player used to connect, provided for timing issues |
Definition at line 43 of file PlayerLoginEvent.java.
org.bukkit.event.player.PlayerLoginEvent.PlayerLoginEvent | ( | final Player | player, |
final Result | result, | ||
final String | message | ||
) |
Definition at line 54 of file PlayerLoginEvent.java.
org.bukkit.event.player.PlayerLoginEvent.PlayerLoginEvent | ( | final Player | player, |
String | hostname, | ||
final InetAddress | address, | ||
final Result | result, | ||
final String | message | ||
) |
This constructor pre-configures the event with a result and message
player | The Player for this event |
hostname | The hostname that was used to connect to the server |
address | The address the player used to connect, provided for timing issues |
result | The result status for this event |
message | The message to be displayed if result denies login |
Definition at line 68 of file PlayerLoginEvent.java.
void org.bukkit.event.player.PlayerLoginEvent.allow | ( | ) |
Allows the player to log in
Definition at line 124 of file PlayerLoginEvent.java.
References org.bukkit.event.player.PlayerLoginEvent.Result.ALLOWED.
void org.bukkit.event.player.PlayerLoginEvent.disallow | ( | final Result | result, |
final String | message | ||
) |
Disallows the player from logging in, with the given reason
result | New result for disallowing the player |
message | Kick message to display to the user |
Definition at line 135 of file PlayerLoginEvent.java.
InetAddress org.bukkit.event.player.PlayerLoginEvent.getAddress | ( | ) |
Gets the InetAddress for the Player associated with this event. This method is provided as a workaround for player.getAddress() returning null during PlayerLoginEvent.
Definition at line 148 of file PlayerLoginEvent.java.
String org.bukkit.event.player.PlayerLoginEvent.getHostname | ( | ) |
Gets the hostname that the player used to connect to the server, or blank if unknown
Definition at line 117 of file PlayerLoginEvent.java.
String org.bukkit.event.player.PlayerLoginEvent.getKickMessage | ( | ) |
Gets the current kick message that will be used if getResult() != Result.ALLOWED
Definition at line 98 of file PlayerLoginEvent.java.
Result org.bukkit.event.player.PlayerLoginEvent.getResult | ( | ) |
Gets the current result of the login, as an enum
Definition at line 79 of file PlayerLoginEvent.java.
void org.bukkit.event.player.PlayerLoginEvent.setKickMessage | ( | final String | message | ) |
Sets the kick message to display if getResult() != Result.ALLOWED
message | New kick message |
Definition at line 107 of file PlayerLoginEvent.java.
void org.bukkit.event.player.PlayerLoginEvent.setResult | ( | final Result | result | ) |
Sets the new result of the login, as an enum
result | New result to set |
Definition at line 88 of file PlayerLoginEvent.java.