Dev Events: Difference between revisions

From MBedwars
Jump to navigation Jump to search
No edit summary
Line 19: Line 19:
''This event will be executed when a player is leaving an arena.''<br />
''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:''' PlayerQuitArenaEvent(Player player, Arena arena, KickReason reason, @Nullable Team team)<br />
'''Methods:'''
'''Methods:'''
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
* boolean wasSuccessfull()
* KickReason getReason()
* @Nullable Team getTeam()


== PlayerJoinArenaSpectatorEvent ==
== PlayerJoinArenaSpectatorEvent ==
Line 54: Line 55:
''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:''' RoundEndEvent(Arena arena, @Nullable Team winnerTeam)<br />
'''Methods:'''
'''Methods:'''
* boolean isTie()
* List<Player> getWinners()
* List<Player> getWinners()
* Team getWinnerTeam()
* Team getWinnerTeam()
* List<Player> getLosers()
* Arena getArena()
* Arena getArena()


Line 92: Line 95:
* ArenaStatus getStatusBefore()
* ArenaStatus getStatusBefore()
* ArenaStatus getStatus()
* ArenaStatus getStatus()
== PlayerRespawnEvent ==
== 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 />
''This event will be executed when a player is respawning (while he is playing MBedwars)''<br />
<br />
<br />
Line 101: Line 106:
* Arena getArena()
* Arena getArena()
* boolean willKick()
* 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()
== OutOfArenaEvent ==
== OutOfArenaEvent ==
''This event will be executed when a player is teleporting himself outside the arena (while he is playing MBedwars)''<br />
''This event will be executed when a player is teleporting himself outside the arena (while he is playing MBedwars)''<br />
Line 115: Line 133:
* boolean willKick()
* boolean willKick()
* boolean isCancelled()
* boolean isCancelled()
== ArenaOutOfTimeEvent ==
== ArenaOutOfTimeEvent ==
'' This event will be executed when an arena is out of time (the timer ends)''<br />
'' This event will be executed when an arena is out of time (the timer ends)''<br />
Line 238: Line 257:
* Arena getArena()
* Arena getArena()
* @Nullable CommandSender getSender()
* @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()

Revision as of 16:26, 11 August 2019

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: PlayerJoinArenaEvent(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: PlayerQuitArenaEvent(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: PlayerJoinArenaSpectatorEvent(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: PlayerQuitArenaSpectatorEvent(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: RoundStartEvent(Arena arena)
Methods:

  • Arena getArena()

RoundEndEvent

This event will be executed when an arena is ending.

Constructor: RoundEndEvent(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: BedPlaceEvent(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: BedBreakEvent(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: ArenaStatusUpdateEvent(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: PlayerRespawnEvent(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()

OutOfArenaEvent

This event will be executed when a player is teleporting himself outside the arena (while he is playing MBedwars)

Constructor: OutOfArenaEvent(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: ArenaOutOfTimeEvent(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: EnableArenaEvent(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: CommandFireEvent(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: CommandArenaFireEvent(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: ShopBuyEvent(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: PlayerKillPlayerEvent(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: PlayerUseExtraItemEvent(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()