Dev Events
! Legacy Warning !You are currently visiting a prehistoric website of the Marcely's Bedwars plugin for v4 and older. In 2021, we released version 5 and completely overhauled the wiki. A lot of information that you find here likely won't be up-to-date anymore. You may find the updated wiki on: https://wiki.mbedwars.com |
As any other plugin this plugin also supports events.
You don't need to change much at your code,
you simply add a MBedwars event like the way you did with the Bukkit/Spigot events.
Currently these MBedwars events exists:
PlayerJoinArenaEvent
This event will be executed when a player is entering an arena.
Constructor: Player player, Arena arena, AddPlayerFail failReason
Methods:
- Player getPlayer()
- Arena getArena()
- boolean wasSuccessfull()
- AddPlayerFail getFailReason()
- void setCancelled(boolean bool)
- boolean isCancelled()
PlayerQuitArenaEvent
This event will be executed when a player is leaving an arena.
Constructor: Player player, Arena arena, KickReason reason, @Nullable Team team
Methods:
- Player getPlayer()
- Arena getArena()
- KickReason getReason()
- @Nullable Team getTeam()
PlayerJoinArenaSpectatorEvent
This event will be executed when a player is entering an arena as a spectator.
Constructor: Player player, Arena arena
Methods:
- Player getPlayer()
- Arena getArena()
- void setCancelled(boolean bool)
- boolean isCancelled()
PlayerQuitArenaSpectatorEvent
This event will be executed when a player is leaving an arena as a spectator.
Constructor: Player player, Arena arena
Methods:
- Player getPlayer()
- Arena getArena()
RoundStartEvent
@Deprecated: Please use de.marcely.api.ArenaStatusUpdateEvent instead
This event will be executed when an arena is starting.
Constructor: Arena arena
Methods:
- Arena getArena()
RoundEndEvent
This event will be executed when an arena is ending.
Constructor: Arena arena, @Nullable Team winnerTeam
Methods:
- boolean isTie()
- List<Player> getWinners()
- Team getWinnerTeam()
- List<Player> getLosers()
- Arena getArena()
BedPlaceEvent
This event will be executed when a player changing the beds coordinates of a team.
Constructor: Player player, Arena arena, Team team, Location loc
Methods:
- void setCancelled(boolean bool)
- Player getWhoPlaced()
- Arena getArena()
- Team getTeam()
- Location getLocation()
- boolean isCancelled()
BedBreakEvent
This event will be executed when a player is breaking the bed by a team.
Constructor: Player player, Arena arena, Team team, Location loc
Methods:
- void setSolution(BedBreakEventSolution solution)
- Arena getArena()
- Team getTeam()
- Location getLocation()
- Player getPlayer()
- BedBreakEventSolution getSolution()
ArenaStatusUpdateEvent
This event will be executed when an arena is changing his status.
Constructor: Arena arena, ArenaStatus before, ArenaStatus status
Methods:
- Arena getArena()
- ArenaStatus getStatusBefore()
- ArenaStatus getStatus()
PlayerRespawnEvent
@Deprecated: Please use de.marcely.api.PlayerRoundDeathEvent instead
This event will be executed when a player is respawning (while he is playing MBedwars)
Constructor: Player player, Arena arena, boolean kick
Methods:
- void kickPlayer(boolean bool)
- Player getPlayer()
- Arena getArena()
- boolean willKick()
PlayerRoundDeathEvent
This event will be executed whenever a player died, but during its org.bukkit.event.player.PlayerRespawnEvent event
Constructor: org.bukkit.event.player.PlayerRespawnEvent parent, Arena arena, boolean kick
Extends: PlayerRespawnEvent
Methods:
- org.bukkit.event.player.PlayerRespawnEvent getParentEvent()
- void kickPlayer(boolean bool)
- Player getPlayer()
- Arena getArena()
- boolean willKick()
PlayerRoundRespawnEvent
This event will be called after the player has respawned successfully and continues to play
Constructor: Player player, Arena arena
Methods:
- Player getPlayer()
- Arena getArena()
OutOfArenaEvent
This event will be executed when a player is teleporting himself outside the arena (while he is playing MBedwars)
Constructor: Player player, Arena arena, Location from, Location to, TeleportCause cause
Methods:
- void kickPlayer(boolean bool)
- void setCancelled(boolean bool)
- Player getPlayer()
- Arena getArena()
- Location getFrom()
- Location getTo()
- TeleportCause getCause()
- boolean willKick()
- boolean isCancelled()
ArenaOutOfTimeEvent
This event will be executed when an arena is out of time (the timer ends)
Constructor: Arena arena
Methods:
- void setNewTime(int time)
- Arena getArena()
- int getNewTime()
EnableArenaEvent
This event will be executed when a player is (trying to) enable an arena through /bw arena setenabled
Constructor: Arena arena, List<CrashMessage> crashMessages
Methods:
- setCrashMessages(List<CrashMessage> crashMessages)
- Arena getArena()
- List<CrashMessage> getCrashMessages()
- boolean wasSuccessfull()
CommandFireEvent
This event will be executed when a player is typing typing the /bw command
Constructor: CommandSender sender, Command cmd
Methods:
- void setCancelled(boolean bool)
- CommandSender getCommandSender()
- Command getCommand()
- boolean isCancelled()
CommandArenaFireEvent
This event will be executed when a player is typing typing the /bw command arena command
Constructor: CommandSender sender, Command cmd
Methods:
- void setCancelled(boolean bool)
- CommandSender getCommandSender()
- Command getCommand()
- boolean isCancelled()
ShopBuyEvent
This event will be executed when a player is (trying to) buy something in the shop
Constructor: Player player, ShopItem si, ItemStack is, Spawner payment, int price, int priceMultiply
Methods:
- Arena getArena()
- Player getBuyer()
- ShopItem getShopItem()
- int getTakeAmount()
- ShopOpenType getOpenType()
- boolean isCancelled()
- void setCancelled(boolean cancel)
- void giveBought(boolean bool)
- void takePayment(boolean bool)
- void setHasEnoughMaterials(boolean bool)
- boolean isGettingBought()
- boolean isTakingPayment()
- boolean hasEnoughMaterials()
PlayerKillPlayerEvent
This event will be executed when a player is killing an other player while playing in an arena
Constructor: Arena arena, Player damager, Player player, DamageCause cause, Projectile proj
Methods:
- Arena getArena()
- Player getDamager()
- Player getPlayer()
- DamageCause getCause()
- Projectile getProjectile()
PlayerUseExtraItemEvent
This event will be executed when a player wants to use (and could) a extra item
Constructor: ExtraItem extraItem, Arena arena, PlayerEvent parentEvent, ItemStack item
Methods:
- Player getPlayer()
- @Nullable Block getClickedBlock()
- @Nullable BlockFace getBlockFace()
- ItemStack getItem()
- Arena getArena()
- PlayerInteractEvent getParentEvent()
- ExtraItem getExtraItem()
- boolean isCancelled()
- void setCancelled(boolean bool)
PlayerEarnAchievementEvent
This event will be executed when a player is earning an achievement
Constructor: Player player, Achievement a, UserAchievements ua
Methods:
- Player getPlayer()
- Achievement getAchievement()
- UserAchievements getUserAchievement()
- boolean isCancelled()
- void setCancelled(boolean bool)
PlayerOpenShopEvent
This event will be executed when a player is opening a shop
Constructor: Player player, ShopDesignType design
Methods:
- void setDesign(ShopDesignType design)
- Player getPlayer()
- ShopDesignType getDesign()
- boolean isCancelled()
- void setCancelled(boolean bool)
ArenaRegenerationStartEvent
This event will be executed whenever an arena starts to regenerate itself
Constructor: Arena arena, CommandSender sender, int regenerationSpeed, ArenaRegenerationStartEventResult result
Methods:
- void setResult(ArenaRegenerationStartEventResult result)
- Arena getArena()
- @Nullable CommandSender getSender()
- int getRegenerationSpeed()
- ArenaRegenerationStartEventResult getResult()
- void customRegeneratorCallFinished()
ArenaRegenerationStopEvent
This event will be executed whenever an arena stops (finished or cancelled) to regenerate itself
Constructor: Arena arena, CommandSender sender
Methods:
- Arena getArena()
- @Nullable CommandSender getSender()
ArenaCreateEvent
This event will be executed whenever a player/plugin creats an arena and adds it to the existing arenas list
Constructor: Arena arena, @Nullable CommandSender sender
Methods:
- Arena getArena()
- @Nullable Player getSender()
ArenaDeleteEvent
This event will be executed whenever a player/plugin removes an arena of the existing arenas list
Constructor: Arena arena, @Nullable CommandSender sender
Methods:
- Arena getArena()
- @Nullable Player getSender()
- void setCancelled(boolean cancelled)
- boolean isCancelled()
TeamEliminateEvent
This event will be executed whenever a player dies and by that causes the elimination/removal of the team from the round
Constructor: Arena arena, Team team, Player finalPlayer, boolean causesEnd
Methods:
- Arena getArena()
- Team getTeam()
- Player getFinalPlayer()
- boolean isCausingEnd()