Dev Events: Difference between revisions

From MBedwars
Jump to navigation Jump to search
No edit summary
No edit summary
Line 4: Line 4:
Currently these MBedwars events exists:<br />
Currently these MBedwars events exists:<br />
=== de.marcely.bedwars.api.PlayerJoinArenaEvent ===
=== de.marcely.bedwars.api.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 />
Constructor: PlayerJoinArenaEvent(Player player, Arena arena, boolean success)<br />
'''Constructor:''' PlayerJoinArenaEvent(Player player, Arena arena, boolean success)<br />
Methods:<br />
'''Methods:'''
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
* boolean wasSuccessfull()
* boolean wasSuccessfull()
=== de.marcely.bedwars.api.PlayerQuitArenaEvent ===
=== de.marcely.bedwars.api.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 />
Constructor: PlayerJoinArenaEvent(Player player, Arena arena, boolean success)<br />
'''Constructor:''' PlayerJoinArenaEvent(Player player, Arena arena, boolean success)<br />
Methods:<br />
'''Methods:'''
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
* boolean wasSuccessfull()
* boolean wasSuccessfull()
=== de.marcely.bedwars.api.PlayerJoinArenaSpectatorEvent ===
=== de.marcely.bedwars.api.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 />
Constructor: PlayerJoinArenaSpectatorEvent(Player player, Arena arena)<br />
'''Constructor:''' PlayerJoinArenaSpectatorEvent(Player player, Arena arena)<br />
Methods:<br />
'''Methods:'''
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
=== de.marcely.bedwars.api.PlayerQuitArenaSpectatorEvent ===
=== de.marcely.bedwars.api.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 />
Constructor: PlayerQuitArenaSpectatorEvent(Player player, Arena arena)<br />
'''Constructor:''' PlayerQuitArenaSpectatorEvent(Player player, Arena arena)<br />
Methods:<br />
'''Methods:'''
* Player getPlayer()
* Player getPlayer()
* Arena getArena()
* Arena getArena()
=== de.marcely.bedwars.api.RoundStartEvent ===
=== de.marcely.bedwars.api.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:''' RoundStartEvent(Arena arena)<br />
Methods:<br />
'''Methods:'''
* Arena getArena()
* Arena getArena()


=== de.marcely.bedwars.api.RoundEndEvent ===
=== de.marcely.bedwars.api.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:''' RoundEndEvent(List<Player> players, Arena arena, Team winnerteam)<br />
Methods:<br />
'''Methods:'''
* List<Player> getWinners()
* List<Player> getWinners()
* Team getWinnerTeam()
* Team getWinnerTeam()
Line 53: Line 53:
<br />
<br />
'''Constructor:''' BedBreakEvent(Team team, Location loc, Player player)<br />
'''Constructor:''' BedBreakEvent(Team team, Location loc, Player player)<br />
'''Methods:'''<br />
'''Methods:'''
* void setSolution(BedBreakEventSolution solution)
* void setSolution(BedBreakEventSolution solution)
* Team getTeam()
* Team getTeam()

Revision as of 16:26, 8 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:

de.marcely.bedwars.api.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()

de.marcely.bedwars.api.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()

de.marcely.bedwars.api.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()

de.marcely.bedwars.api.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()

de.marcely.bedwars.api.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()

de.marcely.bedwars.api.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()

de.marcely.bedwars.api.BedBreakEvent

This event will be executed when a player is breaking the bed by a team.

Constructor: BedBreakEvent(Team team, Location loc, Player player)
Methods:

  • void setSolution(BedBreakEventSolution solution)
  • Team getTeam()
  • Location getLocation()
  • Player getPlayer()
  • BedBreakEventSolution getSolution()

de.marcely.bedwars.api.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()