Dev Events: Difference between revisions

From MBedwars
Jump to navigation Jump to search
No edit summary
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 ===
=== PlayerJoinArenaEvent ===
''This event will be executed when a player is entering an arena.''<br />
''This event will be executed when a player is entering an arena.''<br />
<br />
<br />
Line 11: Line 11:
* Arena getArena()
* Arena getArena()
* boolean wasSuccessfull()
* boolean wasSuccessfull()
=== de.marcely.bedwars.api.PlayerQuitArenaEvent ===
=== PlayerQuitArenaEvent ===
''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 />
Line 19: Line 19:
* Arena getArena()
* Arena getArena()
* boolean wasSuccessfull()
* boolean wasSuccessfull()
=== de.marcely.bedwars.api.PlayerJoinArenaSpectatorEvent ===
=== PlayerJoinArenaSpectatorEvent ===
''This event will be executed when a player is entering an arena as a spectator.''<br />
''This event will be executed when a player is entering an arena as a spectator.''<br />
<br />
<br />
Line 26: Line 26:
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
=== de.marcely.bedwars.api.PlayerQuitArenaSpectatorEvent ===
=== PlayerQuitArenaSpectatorEvent ===
''This event will be executed when a player is leaving an arena as a spectator.''<br />
''This event will be executed when a player is leaving an arena as a spectator.''<br />
<br />
<br />
Line 33: Line 33:
* 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 />
Line 41: Line 41:
* 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 />
Line 49: Line 49:
* Team getWinnerTeam()
* Team getWinnerTeam()
* Arena getArena()
* Arena getArena()
=== de.marcely.bedwars.api.BedBreakEvent ===
=== BedPlaceEvent ===
''This event will be executed when a player changing the beds coordinates of a team.''<br />
<br />
'''Constructor:''' BedBreakEvent(Player player, Arena arena, Team team, Location loc)<br />
'''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.''<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:''' BedBreakEvent(Player player, Arena arena, Team team, Location loc)<br />
'''Methods:'''
'''Methods:'''
* void setSolution(BedBreakEventSolution solution)
* void setSolution(BedBreakEventSolution solution)
Line 61: Line 72:
* 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 />

Revision as of 20:07, 18 November 2016

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, boolean success)
Methods:

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

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