| Package | Description |
|---|---|
| org.bukkit |
More generalized classes in the API.
|
| org.bukkit.boss | |
| org.bukkit.conversations |
Classes dedicated to facilitate direct player-to-plugin communication.
|
| org.bukkit.entity |
Interfaces for non-voxel objects that can exist in a
world, including all players, monsters, projectiles, etc. |
| org.bukkit.event.block | |
| org.bukkit.event.enchantment |
Events triggered from an enchantment table. |
| org.bukkit.event.entity | |
| org.bukkit.event.hanging |
Events relating to entities that hang. |
| org.bukkit.event.inventory | |
| org.bukkit.event.player | |
| org.bukkit.event.raid | |
| org.bukkit.event.server |
Events relating to programmatic state
changes on the server. |
| org.bukkit.event.world | |
| org.bukkit.map |
Classes to facilitate plugin handling of
map displays. |
| org.bukkit.plugin.messaging |
Classes dedicated to specialized plugin to client protocols.
|
| org.spigotmc.event.player |
| Modifier and Type | Method and Description |
|---|---|
Player |
OfflinePlayer.getPlayer()
Gets a
Player object that this represents, if there is one
If the player is online, this will return that player. |
Player |
OfflinePlayer.getPlayer()
Gets a
Player object that this represents, if there is one
If the player is online, this will return that player. |
static Player |
Bukkit.getPlayer(String name)
Gets a player object by the given username.
|
Player |
Server.getPlayer(String name)
Gets a player object by the given username.
|
Player |
Server.getPlayer(String name)
Gets a player object by the given username.
|
static Player |
Bukkit.getPlayer(String name)
Gets a player object by the given username.
|
static Player |
Bukkit.getPlayer(UUID id)
Gets the player with the given UUID.
|
Player |
Server.getPlayer(UUID id)
Gets the player with the given UUID.
|
Player |
Server.getPlayer(UUID id)
Gets the player with the given UUID.
|
static Player |
Bukkit.getPlayer(UUID id)
Gets the player with the given UUID.
|
static Player |
Bukkit.getPlayerExact(String name)
Gets the player with the exact given name, case insensitive.
|
Player |
Server.getPlayerExact(String name)
Gets the player with the exact given name, case insensitive.
|
Player |
Server.getPlayerExact(String name)
Gets the player with the exact given name, case insensitive.
|
static Player |
Bukkit.getPlayerExact(String name)
Gets the player with the exact given name, case insensitive.
|
| Modifier and Type | Method and Description |
|---|---|
static Collection<? extends Player> |
Bukkit.getOnlinePlayers()
Gets a view of all currently logged in players.
|
Collection<? extends Player> |
Server.getOnlinePlayers()
Gets a view of all currently logged in players.
|
Collection<? extends Player> |
Server.getOnlinePlayers()
Gets a view of all currently logged in players.
|
static Collection<? extends Player> |
Bukkit.getOnlinePlayers()
Gets a view of all currently logged in players.
|
List<Player> |
World.getPlayers()
Get a list of all players in this World
|
List<Player> |
World.getPlayers()
Get a list of all players in this World
|
static List<Player> |
Bukkit.matchPlayer(String name)
Attempts to match any players with the given name, and returns a list
of all possibly matches.
|
List<Player> |
Server.matchPlayer(String name)
Attempts to match any players with the given name, and returns a list
of all possibly matches.
|
List<Player> |
Server.matchPlayer(String name)
Attempts to match any players with the given name, and returns a list
of all possibly matches.
|
static List<Player> |
Bukkit.matchPlayer(String name)
Attempts to match any players with the given name, and returns a list
of all possibly matches.
|
| Modifier and Type | Method and Description |
|---|---|
List<Player> |
BossBar.getPlayers()
Returns all players viewing this boss bar
|
List<Player> |
BossBar.getPlayers()
Returns all players viewing this boss bar
|
| Modifier and Type | Method and Description |
|---|---|
void |
BossBar.addPlayer(Player player)
Adds the player to this boss bar causing it to display on their screen.
|
void |
BossBar.addPlayer(Player player)
Adds the player to this boss bar causing it to display on their screen.
|
void |
BossBar.removePlayer(Player player)
Removes the player from this boss bar causing it to be removed from their
screen.
|
void |
BossBar.removePlayer(Player player)
Removes the player from this boss bar causing it to be removed from their
screen.
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract Prompt |
PlayerNamePrompt.acceptValidatedInput(ConversationContext context,
Player input)
Override this method to perform some action with the user's player name
response.
|
protected abstract Prompt |
PlayerNamePrompt.acceptValidatedInput(ConversationContext context,
Player input)
Override this method to perform some action with the user's player name
response.
|
| Modifier and Type | Method and Description |
|---|---|
Player |
LivingEntity.getKiller()
Gets the player identified as the killer of the living entity.
|
Player |
LivingEntity.getKiller()
Gets the player identified as the killer of the living entity.
|
| Modifier and Type | Method and Description |
|---|---|
Set<Player> |
Player.Spigot.getHiddenPlayers()
Gets all players hidden with
hidePlayer(org.bukkit.entity.Player). |
Set<Player> |
Player.Spigot.getHiddenPlayers()
Gets all players hidden with
hidePlayer(org.bukkit.entity.Player). |
| Modifier and Type | Method and Description |
|---|---|
boolean |
Player.canSee(Player player)
Checks to see if a player has been hidden from this player
|
boolean |
Player.canSee(Player player)
Checks to see if a player has been hidden from this player
|
void |
Player.hidePlayer(Player player)
Deprecated.
|
void |
Player.hidePlayer(Player player)
Deprecated.
|
void |
Player.hidePlayer(Plugin plugin,
Player player)
Hides a player from this player
|
void |
Player.hidePlayer(Plugin plugin,
Player player)
Hides a player from this player
|
void |
Player.showPlayer(Player player)
Deprecated.
|
void |
Player.showPlayer(Player player)
Deprecated.
|
void |
Player.showPlayer(Plugin plugin,
Player player)
Allows this player to see a player that was previously hidden.
|
void |
Player.showPlayer(Plugin plugin,
Player player)
Allows this player to see a player that was previously hidden.
|
| Modifier and Type | Field and Description |
|---|---|
protected Player |
BlockPlaceEvent.player |
protected Player |
BlockPlaceEvent.player |
| Modifier and Type | Method and Description |
|---|---|
Player |
BlockBreakEvent.getPlayer()
Gets the Player that is breaking the block involved in this event.
|
Player |
BlockCanBuildEvent.getPlayer()
Gets the player who placed the block involved in this event.
|
Player |
BlockDamageEvent.getPlayer()
Gets the player damaging the block involved in this event.
|
Player |
BlockDropItemEvent.getPlayer()
Gets the Player that is breaking the block involved in this event.
|
Player |
BlockFertilizeEvent.getPlayer()
Gets the player that triggered the fertilization.
|
Player |
BlockIgniteEvent.getPlayer()
Gets the player who ignited this block
|
Player |
BlockPlaceEvent.getPlayer()
Gets the player who placed the block involved in this event.
|
Player |
SignChangeEvent.getPlayer()
Gets the player changing the sign involved in this event.
|
Player |
SignChangeEvent.getPlayer()
Gets the player changing the sign involved in this event.
|
Player |
BlockPlaceEvent.getPlayer()
Gets the player who placed the block involved in this event.
|
Player |
BlockIgniteEvent.getPlayer()
Gets the player who ignited this block
|
Player |
BlockFertilizeEvent.getPlayer()
Gets the player that triggered the fertilization.
|
Player |
BlockDropItemEvent.getPlayer()
Gets the Player that is breaking the block involved in this event.
|
Player |
BlockDamageEvent.getPlayer()
Gets the player damaging the block involved in this event.
|
Player |
BlockCanBuildEvent.getPlayer()
Gets the player who placed the block involved in this event.
|
Player |
BlockBreakEvent.getPlayer()
Gets the Player that is breaking the block involved in this event.
|
| Constructor and Description |
|---|
BlockBreakEvent(Block theBlock,
Player player) |
BlockBreakEvent(Block theBlock,
Player player) |
BlockCanBuildEvent(Block block,
Player player,
BlockData type,
boolean canBuild) |
BlockCanBuildEvent(Block block,
Player player,
BlockData type,
boolean canBuild) |
BlockDamageEvent(Player player,
Block block,
ItemStack itemInHand,
boolean instaBreak) |
BlockDamageEvent(Player player,
Block block,
ItemStack itemInHand,
boolean instaBreak) |
BlockDropItemEvent(Block block,
BlockState blockState,
Player player,
List<Item> items) |
BlockDropItemEvent(Block block,
BlockState blockState,
Player player,
List<Item> items) |
BlockFertilizeEvent(Block theBlock,
Player player,
List<BlockState> blocks) |
BlockFertilizeEvent(Block theBlock,
Player player,
List<BlockState> blocks) |
BlockMultiPlaceEvent(List<BlockState> states,
Block clicked,
ItemStack itemInHand,
Player thePlayer,
boolean canBuild) |
BlockMultiPlaceEvent(List<BlockState> states,
Block clicked,
ItemStack itemInHand,
Player thePlayer,
boolean canBuild) |
BlockPlaceEvent(Block placedBlock,
BlockState replacedBlockState,
Block placedAgainst,
ItemStack itemInHand,
Player thePlayer,
boolean canBuild)
Deprecated.
|
BlockPlaceEvent(Block placedBlock,
BlockState replacedBlockState,
Block placedAgainst,
ItemStack itemInHand,
Player thePlayer,
boolean canBuild)
Deprecated.
|
BlockPlaceEvent(Block placedBlock,
BlockState replacedBlockState,
Block placedAgainst,
ItemStack itemInHand,
Player thePlayer,
boolean canBuild,
EquipmentSlot hand) |
BlockPlaceEvent(Block placedBlock,
BlockState replacedBlockState,
Block placedAgainst,
ItemStack itemInHand,
Player thePlayer,
boolean canBuild,
EquipmentSlot hand) |
SignChangeEvent(Block theBlock,
Player thePlayer,
String[] theLines) |
SignChangeEvent(Block theBlock,
Player thePlayer,
String[] theLines) |
| Modifier and Type | Method and Description |
|---|---|
Player |
EnchantItemEvent.getEnchanter()
Gets the player enchanting the item
|
Player |
PrepareItemEnchantEvent.getEnchanter()
Gets the player enchanting the item
|
Player |
PrepareItemEnchantEvent.getEnchanter()
Gets the player enchanting the item
|
Player |
EnchantItemEvent.getEnchanter()
Gets the player enchanting the item
|
| Constructor and Description |
|---|
EnchantItemEvent(Player enchanter,
InventoryView view,
Block table,
ItemStack item,
int level,
Map<Enchantment,Integer> enchants,
int i) |
EnchantItemEvent(Player enchanter,
InventoryView view,
Block table,
ItemStack item,
int level,
Map<Enchantment,Integer> enchants,
int i) |
PrepareItemEnchantEvent(Player enchanter,
InventoryView view,
Block table,
ItemStack item,
EnchantmentOffer[] offers,
int bonus) |
PrepareItemEnchantEvent(Player enchanter,
InventoryView view,
Block table,
ItemStack item,
EnchantmentOffer[] offers,
int bonus) |
| Modifier and Type | Method and Description |
|---|---|
Player |
PlayerDeathEvent.getEntity() |
Player |
PlayerDeathEvent.getEntity() |
Player |
EntityPlaceEvent.getPlayer()
Deprecated.
Returns the player placing the entity
|
Player |
PlayerLeashEntityEvent.getPlayer()
Returns the player involved in this event
|
Player |
PlayerLeashEntityEvent.getPlayer()
Returns the player involved in this event
|
Player |
EntityPlaceEvent.getPlayer()
Deprecated.
Returns the player placing the entity
|
| Constructor and Description |
|---|
EntityPlaceEvent(Entity entity,
Player player,
Block block,
BlockFace blockFace)
Deprecated.
|
EntityPlaceEvent(Entity entity,
Player player,
Block block,
BlockFace blockFace)
Deprecated.
|
PlayerDeathEvent(Player player,
List<ItemStack> drops,
int droppedExp,
int newExp,
int newTotalExp,
int newLevel,
String deathMessage) |
PlayerDeathEvent(Player player,
List<ItemStack> drops,
int droppedExp,
int newExp,
int newTotalExp,
int newLevel,
String deathMessage) |
PlayerDeathEvent(Player player,
List<ItemStack> drops,
int droppedExp,
int newExp,
String deathMessage) |
PlayerDeathEvent(Player player,
List<ItemStack> drops,
int droppedExp,
int newExp,
String deathMessage) |
PlayerDeathEvent(Player player,
List<ItemStack> drops,
int droppedExp,
String deathMessage) |
PlayerDeathEvent(Player player,
List<ItemStack> drops,
int droppedExp,
String deathMessage) |
PlayerLeashEntityEvent(Entity what,
Entity leashHolder,
Player leasher) |
PlayerLeashEntityEvent(Entity what,
Entity leashHolder,
Player leasher) |
| Modifier and Type | Method and Description |
|---|---|
Player |
HangingPlaceEvent.getPlayer()
Returns the player placing the hanging entity
|
Player |
HangingPlaceEvent.getPlayer()
Returns the player placing the hanging entity
|
| Constructor and Description |
|---|
HangingPlaceEvent(Hanging hanging,
Player player,
Block block,
BlockFace blockFace) |
HangingPlaceEvent(Hanging hanging,
Player player,
Block block,
BlockFace blockFace) |
| Modifier and Type | Method and Description |
|---|---|
Player |
FurnaceExtractEvent.getPlayer()
Get the player that triggered the event
|
Player |
FurnaceExtractEvent.getPlayer()
Get the player that triggered the event
|
| Constructor and Description |
|---|
FurnaceExtractEvent(Player player,
Block block,
Material itemType,
int itemAmount,
int exp) |
FurnaceExtractEvent(Player player,
Block block,
Material itemType,
int itemAmount,
int exp) |
| Modifier and Type | Field and Description |
|---|---|
protected Player |
PlayerEvent.player |
protected Player |
PlayerEvent.player |
| Modifier and Type | Method and Description |
|---|---|
Player |
PlayerEvent.getPlayer()
Returns the player involved in this event
|
Player |
PlayerUnleashEntityEvent.getPlayer()
Returns the player who is unleashing the entity.
|
Player |
PlayerUnleashEntityEvent.getPlayer()
Returns the player who is unleashing the entity.
|
Player |
PlayerEvent.getPlayer()
Returns the player involved in this event
|
| Modifier and Type | Method and Description |
|---|---|
Set<Player> |
AsyncPlayerChatEvent.getRecipients()
Gets a set of recipients that this chat message will be displayed to.
|
Set<Player> |
PlayerChatEvent.getRecipients()
Deprecated.
Gets a set of recipients that this chat message will be displayed to
|
Set<Player> |
PlayerCommandPreprocessEvent.getRecipients()
Deprecated.
This method is provided for backward compatibility with no
guarantee to the effect of viewing or modifying the set.
|
Set<Player> |
PlayerCommandPreprocessEvent.getRecipients()
Deprecated.
This method is provided for backward compatibility with no
guarantee to the effect of viewing or modifying the set.
|
Set<Player> |
PlayerChatEvent.getRecipients()
Deprecated.
Gets a set of recipients that this chat message will be displayed to
|
Set<Player> |
AsyncPlayerChatEvent.getRecipients()
Gets a set of recipients that this chat message will be displayed to.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PlayerChatEvent.setPlayer(Player player)
Deprecated.
Sets the player that this message will display as, or command will be
executed as
|
void |
PlayerCommandPreprocessEvent.setPlayer(Player player)
Sets the player that this command will be executed as.
|
void |
PlayerCommandPreprocessEvent.setPlayer(Player player)
Sets the player that this command will be executed as.
|
void |
PlayerChatEvent.setPlayer(Player player)
Deprecated.
Sets the player that this message will display as, or command will be
executed as
|
| Constructor and Description |
|---|
AsyncPlayerChatEvent(boolean async,
Player who,
String message,
Set<Player> players) |
AsyncPlayerChatEvent(boolean async,
Player who,
String message,
Set<Player> players) |
PlayerChatEvent(Player player,
String message,
String format,
Set<Player> recipients)
Deprecated.
|
PlayerChatEvent(Player player,
String message,
String format,
Set<Player> recipients)
Deprecated.
|
PlayerCommandPreprocessEvent(Player player,
String message,
Set<Player> recipients) |
PlayerCommandPreprocessEvent(Player player,
String message,
Set<Player> recipients) |
| Modifier and Type | Method and Description |
|---|---|
Player |
RaidTriggerEvent.getPlayer()
Returns the player who triggered the raid.
|
Player |
RaidTriggerEvent.getPlayer()
Returns the player who triggered the raid.
|
| Modifier and Type | Method and Description |
|---|---|
List<Player> |
RaidFinishEvent.getWinners()
Returns an immutable list contains all winners.
|
List<Player> |
RaidFinishEvent.getWinners()
Returns an immutable list contains all winners.
|
| Constructor and Description |
|---|
RaidTriggerEvent(Raid raid,
World world,
Player player) |
RaidTriggerEvent(Raid raid,
World world,
Player player) |
| Constructor and Description |
|---|
RaidFinishEvent(Raid raid,
World world,
List<Player> winners) |
RaidFinishEvent(Raid raid,
World world,
List<Player> winners) |
| Modifier and Type | Method and Description |
|---|---|
Iterator<Player> |
ServerListPingEvent.iterator()
Calling the
Iterator.remove() method will force that particular
player to not be displayed on the player list, decrease the size
returned by ServerListPingEvent.getNumPlayers(), and will not be returned again by
any new iterator. |
Iterator<Player> |
ServerListPingEvent.iterator()
Calling the
Iterator.remove() method will force that particular
player to not be displayed on the player list, decrease the size
returned by ServerListPingEvent.getNumPlayers(), and will not be returned again by
any new iterator. |
| Modifier and Type | Method and Description |
|---|---|
Player |
StructureGrowEvent.getPlayer()
Gets the player that created the structure.
|
Player |
StructureGrowEvent.getPlayer()
Gets the player that created the structure.
|
| Constructor and Description |
|---|
StructureGrowEvent(Location location,
TreeType species,
boolean bonemeal,
Player player,
List<BlockState> blocks) |
StructureGrowEvent(Location location,
TreeType species,
boolean bonemeal,
Player player,
List<BlockState> blocks) |
| Modifier and Type | Method and Description |
|---|---|
abstract void |
MapRenderer.render(MapView map,
MapCanvas canvas,
Player player)
Render to the given map.
|
abstract void |
MapRenderer.render(MapView map,
MapCanvas canvas,
Player player)
Render to the given map.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Messenger.dispatchIncomingMessage(Player source,
String channel,
byte[] message)
Dispatches the specified incoming message to any registered listeners.
|
void |
StandardMessenger.dispatchIncomingMessage(Player source,
String channel,
byte[] message) |
void |
StandardMessenger.dispatchIncomingMessage(Player source,
String channel,
byte[] message) |
void |
Messenger.dispatchIncomingMessage(Player source,
String channel,
byte[] message)
Dispatches the specified incoming message to any registered listeners.
|
void |
PluginMessageListener.onPluginMessageReceived(String channel,
Player player,
byte[] message)
A method that will be thrown when a PluginMessageSource sends a plugin
message on a registered channel.
|
void |
PluginMessageListener.onPluginMessageReceived(String channel,
Player player,
byte[] message)
A method that will be thrown when a PluginMessageSource sends a plugin
message on a registered channel.
|
| Constructor and Description |
|---|
PlayerSpawnLocationEvent(Player who,
Location spawnLocation) |
PlayerSpawnLocationEvent(Player who,
Location spawnLocation) |
Copyright © 2022. All rights reserved.