DUXPLIMA Documentation
UXPLIMA Documentation / Developer API

Developer API

Overview, Adding Dependency, Events, Query API and Menu API.

Copy Markdown
  • Overview — uxmEssentials is built to be a good neighbour. Your plugin can watch what it does, refuse the things it is about to do, extend its menus, and read its economy, through a published API you compile against like any other library.
  • Adding Dependency — The uxmEssentials developer API is published as an ordinary Maven artifact. You add one repository and one coordinate, and your IDE gives you the event classes, the front door, and the value types with full javadoc.
  • Events — Everything uxmEssentials does is published as an ordinary Bukkit event, and the operations that can be refused cleanly are published twice: once as a question you may cancel, once as the fact afterwards.
  • Query API — Events tell you what uxmEssentials did. Queries answer what is true right now: how many homes a player owns, what they hold, whether they are banned, who is away, which worlds are loaded.
  • Menu API