Developer API
Events, queries, actions, the menu API and the REST add-on.
The API is a published Maven artifact you compile against. Your plugin can watch what uxmEssentials does, refuse some of it, read its state, and drive it.
| Page | What it covers |
|---|---|
| Overview | The front door, and what each part of the API is for |
| Adding the Dependency | The repository and coordinate, for Maven and Gradle |
| Events | The events published, and the nine you can cancel |
| Query API | Reading state: homes, balances, punishments, worlds |
| Action API | Driving the same use cases the commands drive |
| Menu API | Teaching the engine your own actions, requirements and sources |
| REST API | HTTP and WebSocket access for panels, bots and scripts |
Was this page helpful?