Dev Events: Difference between revisions

From MBedwars
Jump to navigation Jump to search
No edit summary
No edit summary
Line 150: Line 150:
'' This event will be executed when a player is (trying to) buy something in the shop''<br />
'' This event will be executed when a player is (trying to) buy something in the shop''<br />
<br />
<br />
'''Constructor:''' ShopBuyEvent(ShopItem si, ShopBuyResult result)<br />
'''Constructor:''' ShopBuyEvent(Player player, ItemStack is, Spawner payment, int price, int priceMultiply)<br />
'''Methods:'''
'''Methods:'''
* void setResult(ShopBuyResult result)
* void setItem(ItemStack is)
* ShopItem getShopItem()
* void setCancelled(boolean bool)
* ShopBuyResult getResult()
* void giveBought(boolean bool)
* boolean isSuccessfull()
* void takePayment(boolean bool)
* void setHasEnoughMaterial(boolean bool)
* Player getBuyer()
* ItemStack getItem()
* Spawner getPayment()
* int getPrice()
* int getPriceMultiply()
* boolean isCancelled()
* boolean isGettingBought()
* boolean isTakingPayment()
* boolean hasEnoughMaterials()

Revision as of 14:10, 7 April 2017

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()

PlayerQuitArenaEvent

This event will be executed when a player is leaving an arena.

Constructor: PlayerJoinArenaEvent(Player player, Arena arena, boolean success)
Methods:

  • Player getPlayer()
  • Arena getArena()
  • boolean wasSuccessfull()

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()

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(List<Player> players, Arena arena, Team winnerteam)
Methods:

  • List<Player> getWinners()
  • Team getWinnerTeam()
  • 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

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()

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, ItemStack is, Spawner payment, int price, int priceMultiply)
Methods:

  • void setItem(ItemStack is)
  • void setCancelled(boolean bool)
  • void giveBought(boolean bool)
  • void takePayment(boolean bool)
  • void setHasEnoughMaterial(boolean bool)
  • Player getBuyer()
  • ItemStack getItem()
  • Spawner getPayment()
  • int getPrice()
  • int getPriceMultiply()
  • boolean isCancelled()
  • boolean isGettingBought()
  • boolean isTakingPayment()
  • boolean hasEnoughMaterials()