MBedwars API: v5.5

The API for the MBedwars Spigot Plugin

This is the documentation for developing MBedwars addons, or Spigot plugins integrating with MBedwars. This documentation does not walk you though setting up a new project, but rather provides a reference for the API. For documentation with regrades to setting up your workspace to integrate with MBedwars, see the Getting-Started page of the MBedwars wiki.

Getting started with the API? Here are helpful tips:

• To get started building an MBedwars Addon, implement the BedwarsAddon class, and register it with the register method.
• For some examples of how to use the API, see the Examples page on our wiki! There you can find information on how to register custom PlayerStatSets, build custom ShopLayouts, create SpecialItems and more.
• All the events that MBedwars fires can be found under the event package.
• MBedwars exposes a lot of its internal helper utilities to the API. You may find tools such as the NMSHelper useful if you are trying to support multiple Minecraft versions. See the tools package for more information.

Packages

Package	Description
de.marcely.bedwars.api	The root package of the MBedwars API
de.marcely.bedwars.api.arena	Contains classes that are related to the Arena.
de.marcely.bedwars.api.arena.picker	Tools that can be used to filter out arenas based on certain criteria.
de.marcely.bedwars.api.arena.picker.condition	Classes used to specify the criteria for an arena used by ArenaPickers.
de.marcely.bedwars.api.arena.picker.condition.variable	Classes related to handling variables for different arena conditions
de.marcely.bedwars.api.command	Classes used to implement the MBedwars command system.
de.marcely.bedwars.api.configuration	API to get or modify the user's MBedwars configuration.
de.marcely.bedwars.api.event	The events fired by MBedwars
de.marcely.bedwars.api.event.arena	Events related to an Arena.
de.marcely.bedwars.api.event.player	Events related to Player actions, or changes to player properties.
de.marcely.bedwars.api.event.remote	Events fired when events occur on a MBedwars RemoteServer.
de.marcely.bedwars.api.exception	Contains all custom exceptions that can be thrown by MBedwars
de.marcely.bedwars.api.game	Contains all classes that can be used to manipulate aspects of the game.
de.marcely.bedwars.api.game.lobby	Classes relevant to the waiting lobby of an Arena.
de.marcely.bedwars.api.game.scoreboard	Classes relevant to manipulating a player's scoreboard.
de.marcely.bedwars.api.game.shop	Classes relevant to the in game shop.
de.marcely.bedwars.api.game.shop.layout	Classes relevant to implement different ShopLayouts for the in game shop.
de.marcely.bedwars.api.game.shop.price	Classes relevant to each ShopPrice in the in game shop.
de.marcely.bedwars.api.game.shop.product	Classes relevant to each ShopProduct in the in game shop.
de.marcely.bedwars.api.game.spawner	Classes related to the in game Spawners.
de.marcely.bedwars.api.game.specialitem	Classes dedicated to handling SpecialItems in MBedwars.
de.marcely.bedwars.api.game.spectator	Classes dedicated to players Spectating in MBedwars.
de.marcely.bedwars.api.game.upgrade	Classes relevant to the in game team upgrade shop.
de.marcely.bedwars.api.game.upgrade.layout	Classes relevant to implement different UpgradeShopLayouts for the in game shop.
de.marcely.bedwars.api.hook	Classes dedicated to managing 3rd party plugins MBedwars can hook into for additional functionality.
de.marcely.bedwars.api.message	Classes dedicated building and sending messages to players.
de.marcely.bedwars.api.player	Classes dedicated to fetching, updating, and saving player data/properties/stats in MBedwars.
de.marcely.bedwars.api.remote	Classes used to manage other servers running MBedwars remotely.
de.marcely.bedwars.api.unsafe	DO NOT USE: These classes are for internal use only, and may change at any time.
de.marcely.bedwars.api.world	Classes relevant to managing custom blocks and holograms placed throughout worlds.
de.marcely.bedwars.api.world.block	Interfaces used to manage custom blocks.
de.marcely.bedwars.api.world.hologram	Interfaces used to manage the MBedwars packet based holograms.
de.marcely.bedwars.api.world.hologram.controller
de.marcely.bedwars.api.world.hologram.skin	Interfaces for different types of skins that can be applied to MBedwars packet holograms.
de.marcely.bedwars.tools	Various helper classes that can be used to make life a lot easier.
de.marcely.bedwars.tools.gui	Tools for easily implementing in game GUIs.
de.marcely.bedwars.tools.gui.type	All the different types of GUIs that can be created.
de.marcely.bedwars.tools.location	Classes used for representing locations within a world.