Dev Events: Difference between revisions

From MBedwars
Jump to navigation Jump to search
No edit summary
No edit summary
 
(35 intermediate revisions by the same user not shown)
Line 3: Line 3:
you simply add a MBedwars event like the way you did with the Bukkit/Spigot events.<br />
you simply add a MBedwars event like the way you did with the Bukkit/Spigot events.<br />
Currently these MBedwars events exists:<br />
Currently these MBedwars events exists:<br />
=== de.marcely.bedwars.api.PlayerJoinArenaEvent ===
 
This event will be executed when a player is entering an arena.<br />
== PlayerJoinArenaEvent ==
''This event will be executed when a player is entering an arena.''<br />
<br />
<br />
Constructor: PlayerJoinArenaEvent(Player player, Arena arena, boolean success)<br />
'''Constructor:''' Player player, Arena arena, AddPlayerFail failReason<br />
Methods:<br />
'''Methods:'''
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
* boolean wasSuccessfull()
* boolean wasSuccessfull()
=== de.marcely.bedwars.api.PlayerQuitArenaEvent ===
* AddPlayerFail getFailReason()
This event will be executed when a player is leaving an arena.<br />
* void setCancelled(boolean bool)
* boolean isCancelled()
 
== PlayerQuitArenaEvent ==
''This event will be executed when a player is leaving an arena.''<br />
<br />
<br />
Constructor: PlayerJoinArenaEvent(Player player, Arena arena, boolean success)<br />
'''Constructor:''' Player player, Arena arena, KickReason reason, @Nullable Team team<br />
Methods:<br />
'''Methods:'''
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
* boolean wasSuccessfull()
* KickReason getReason()
=== de.marcely.bedwars.api.PlayerJoinArenaSpectatorEvent ===
* @Nullable Team getTeam()
This event will be executed when a player is entering an arena as a spectator.<br />
 
== PlayerJoinArenaSpectatorEvent ==
''This event will be executed when a player is entering an arena as a spectator.''<br />
<br />
<br />
Constructor: PlayerJoinArenaSpectatorEvent(Player player, Arena arena)<br />
'''Constructor:''' Player player, Arena arena<br />
Methods:<br />
'''Methods:'''
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
=== de.marcely.bedwars.api.PlayerQuitArenaSpectatorEvent ===
* void setCancelled(boolean bool)
This event will be executed when a player is leaving an arena as a spectator.<br />
* boolean isCancelled()
 
== PlayerQuitArenaSpectatorEvent ==
''This event will be executed when a player is leaving an arena as a spectator.''<br />
<br />
<br />
Constructor: PlayerQuitArenaSpectatorEvent(Player player, Arena arena)<br />
'''Constructor:''' Player player, Arena arena<br />
Methods:<br />
'''Methods:'''
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
=== de.marcely.bedwars.api.RoundStartEvent ===
 
== RoundStartEvent ==
<small>@Deprecated: Please use de.marcely.api.ArenaStatusUpdateEvent instead</small><br />
<small>@Deprecated: Please use de.marcely.api.ArenaStatusUpdateEvent instead</small><br />
This event will be executed when an arena is starting.<br />
''This event will be executed when an arena is starting.''<br />
<br />
<br />
Constructor: RoundStartEvent(Arena arena)<br />
'''Constructor:''' Arena arena<br />
Methods:<br />
'''Methods:'''
* Arena getArena()
* Arena getArena()


=== de.marcely.bedwars.api.RoundEndEvent ===
== RoundEndEvent ==
This event will be executed when an arena is ending.<br />
''This event will be executed when an arena is ending.''<br />
<br />
<br />
Constructor: RoundEndEvent(List<Player> players, Arena arena, Team winnerteam)<br />
'''Constructor:''' Arena arena, @Nullable Team winnerTeam<br />
Methods:<br />
'''Methods:'''
* boolean isTie()
* List<Player> getWinners()
* List<Player> getWinners()
* Team getWinnerTeam()
* Team getWinnerTeam()
* List<Player> getLosers()
* Arena getArena()
== BedPlaceEvent ==
''This event will be executed when a player changing the beds coordinates of a team.''<br />
<br />
'''Constructor:''' Player player, Arena arena, Team team, Location loc<br />
'''Methods:'''
* void setCancelled(boolean bool)
* Player getWhoPlaced()
* Arena getArena()
* Arena getArena()
=== de.marcely.bedwars.api.BedBreakEvent ===
* Team getTeam()
* Location getLocation()
* boolean isCancelled()
 
== BedBreakEvent ==
''This event will be executed when a player is breaking the bed by a team.''<br />
''This event will be executed when a player is breaking the bed by a team.''<br />
<br />
<br />
'''Constructor:''' BedBreakEvent(Team team, Location loc, Player player)<br />
'''Constructor:''' Player player, Arena arena, Team team, Location loc<br />
'''Methods:'''<br />
'''Methods:'''
* void setSolution(BedBreakEventSolution solution)
* void setSolution(BedBreakEventSolution solution)
* Arena getArena()
* Team getTeam()
* Team getTeam()
* Location getLocation()
* Location getLocation()
Line 60: Line 87:
* BedBreakEventSolution getSolution()
* BedBreakEventSolution getSolution()


=== de.marcely.bedwars.api.ArenaStatusUpdateEvent ===
== ArenaStatusUpdateEvent ==
''This event will be executed when an arena is changing his status.''<br />
''This event will be executed when an arena is changing his status.''<br />
<br />
<br />
'''Constructor:''' ArenaStatusUpdateEvent(Arena arena, ArenaStatus before, ArenaStatus status)<br />
'''Constructor:''' Arena arena, ArenaStatus before, ArenaStatus status<br />
'''Methods:'''
'''Methods:'''
* Arena getArena()
* Arena getArena()
* ArenaStatus getStatusBefore()
* ArenaStatus getStatusBefore()
* ArenaStatus getStatus()
* ArenaStatus getStatus()
== PlayerRespawnEvent ==
<small>@Deprecated: Please use de.marcely.api.PlayerRoundDeathEvent instead</small><br />
''This event will be executed when a player is respawning (while he is playing MBedwars)''<br />
<br />
'''Constructor:''' Player player, Arena arena, boolean kick<br />
'''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''<br />
<br />
'''Constructor:''' org.bukkit.event.player.PlayerRespawnEvent parent, Arena arena, boolean kick<br />
'''Extends:''' PlayerRespawnEvent<br />
'''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''<br />
<br />
'''Constructor:''' Player player, Arena arena<br />
'''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)''<br />
<br />
'''Constructor:''' Player player, Arena arena, Location from, Location to, TeleportCause cause<br />
'''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)''<br />
<br />
'''Constructor:''' Arena arena<br />
'''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''<br />
<br />
'''Constructor:''' Arena arena, List<CrashMessage> crashMessages<br />
'''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''<br />
<br />
'''Constructor:''' CommandSender sender, Command cmd<br />
'''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''<br />
<br />
'''Constructor:''' CommandSender sender, Command cmd<br />
'''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''<br />
<br />
'''Constructor:''' Player player, ShopItem si, ItemStack is, Spawner payment, int price, int priceMultiply<br />
'''Methods:'''
* Arena getArena()
* Player getBuyer()
* ShopItem getShopItem()
* ShopOpenType getOpenType()
* List<ShopBuyProblem> getProblems()
* boolean addProblem(ShopBuyProblem problem)
* boolean removeProblem(ShopBuyProblem problem)
* int removeAllProblems()
* void setGivingProducts(boolean giveProducts)
* void setTakingPayments(boolean takingPayments)
* boolean isGivingProducts()
* boolean isTakingPayments()
* boolean isShiftClick()
* int getAmount()
* void setAmount(int)
* @Deprecated int getTakeAmount()
* @Deprecated boolean isCancelled()
* @Deprecated void setCancelled(boolean cancel)
* @Deprecated void giveBought(boolean bool)
* @Deprecated void takePayment(boolean bool)
* @Deprecated void setHasEnoughMaterials(boolean bool)
* @Deprecated boolean isGettingBought()
* @Deprecated boolean isTakingPayment()
* @Deprecated boolean hasEnoughMaterials()
== PlayerKillPlayerEvent ==
'' This event will be executed when a player is killing an other player while playing in an arena''<br />
<br />
'''Constructor:''' Arena arena, Player damager, Player player, DamageCause cause, Projectile proj<br />
'''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''<br />
<br />
'''Constructor:''' ExtraItem extraItem, Arena arena, PlayerEvent parentEvent, ItemStack item<br />
'''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''<br />
<br />
'''Constructor:''' Player player, Achievement a, UserAchievements ua<br />
'''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''<br />
<br />
'''Constructor:''' Player player, ShopDesignType design<br />
'''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''<br />
<br />
'''Constructor:''' Arena arena, CommandSender sender, int regenerationSpeed, ArenaRegenerationStartEventResult result<br />
'''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''<br />
<br />
'''Constructor:''' Arena arena, CommandSender sender<br />
'''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''<br />
<br />
'''Constructor:''' Arena arena, @Nullable CommandSender sender<br />
'''Methods:'''
* Arena getArena()
* @Nullable Player getSender()
== ArenaDeleteEvent ==
'' This event will be executed whenever a player/plugin removes an arena of the existing arenas list''<br />
<br />
'''Constructor:''' Arena arena, @Nullable CommandSender sender<br />
'''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''<br />
<br />
'''Constructor:''' Arena arena, Team team, Player finalPlayer, boolean causesEnd<br />
'''Methods:'''
* Arena getArena()
* Team getTeam()
* Player getFinalPlayer()
* boolean isCausingEnd()
== ShopGUIBuildEvent ==
'' This event will be executed after the system has build the GUI of the shop. This event adds the ability to additionaly customize the GUI. [https://pastebin.com/1FQnpu2k Click here for an example usage]''<br />
<br />
'''Constructor:''' Player player, ShopDesign design, @Nullable SimpleGUI gui<br />
'''Methods:'''
* Player getPlayer()
* ShopDesign getDesign()
* @Nullable SimpleGUI getGUI()
* void setGUI(@Nullable SimpleGUI gui)
== PlayerDeathInventoryDropEvent ==
'' Gets called whenever the plugin is handling the drops of a player whenever he dies''

Latest revision as of 20:00, 19 April 2021

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()
  • ShopOpenType getOpenType()
  • List<ShopBuyProblem> getProblems()
  • boolean addProblem(ShopBuyProblem problem)
  • boolean removeProblem(ShopBuyProblem problem)
  • int removeAllProblems()
  • void setGivingProducts(boolean giveProducts)
  • void setTakingPayments(boolean takingPayments)
  • boolean isGivingProducts()
  • boolean isTakingPayments()
  • boolean isShiftClick()
  • int getAmount()
  • void setAmount(int)
  • @Deprecated int getTakeAmount()
  • @Deprecated boolean isCancelled()
  • @Deprecated void setCancelled(boolean cancel)
  • @Deprecated void giveBought(boolean bool)
  • @Deprecated void takePayment(boolean bool)
  • @Deprecated void setHasEnoughMaterials(boolean bool)
  • @Deprecated boolean isGettingBought()
  • @Deprecated boolean isTakingPayment()
  • @Deprecated 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()

ShopGUIBuildEvent

This event will be executed after the system has build the GUI of the shop. This event adds the ability to additionaly customize the GUI. Click here for an example usage

Constructor: Player player, ShopDesign design, @Nullable SimpleGUI gui
Methods:

  • Player getPlayer()
  • ShopDesign getDesign()
  • @Nullable SimpleGUI getGUI()
  • void setGUI(@Nullable SimpleGUI gui)

PlayerDeathInventoryDropEvent

Gets called whenever the plugin is handling the drops of a player whenever he dies