Events
API State: Stable
Unfinished
This part of the API is brand-new. It will be changed if there are any bugs, missing features or usability improvements.It is not recommended relying on this part of the API, it will most likely change.
Draft
Our own usage and testing has shown that this part of the API is complete and seems bug free. However, other plugins may have other use cases which are not covered by our testing. Therefore, please go ahead and use this API part. Let us know if there are missing features or bugs. This API part will be changed if there are more bugs, missing features or usability improvements.Please use this part of the API and give us feedback!
Stable
Both our own and third party testing showed that this part of the API is complete. Only bugs and major conceptual problems would lead to more changes.This part of the API should be safe to use. We try to keep it compatible with previous versions if changes are needed.
Listening to BetonQuest (Bukkit) events🔗
BetonQuest exposes some of its actions as Bukkit events.
You can find these events in org.betonquest.betonquest.api.bukkit.event package.
Use them as you would use any other Bukkit event.
The event API itself is stable as the API state tells, but some events will change from time to time or get renamed/replaced. If you need any additional events, create a discussion or pull request on GitHub.
Event List🔗
| Event | Description |
|---|---|
| ConversationOptionEvent | Signals that a profile has selected an option in a conversation. |
| LoadDataEvent | Fires after BetonQuest finished loading or reloading all events, conditions, objectives, conversations etc. |
| PlayerConversationEndEvent | Fires when a profile ends a conversation. |
| PlayerConversationStartEvent | Fires when profile starts a conversation. |
| PlayerJournalAddEvent | Fires when new content is added to a profile's journal. |
| PlayerJournalDeleteEvent | Fires when content is removed from a profile's journal. |
| PlayerObjectiveChangeEvent | Fires when a profile's objectives change. |
| PlayerTagAddEvent | Fired when a tag is added to a profile. |
| PlayerTagRemoveEvent | Fired when a tag is removed from a profile. |
| PlayerUpdatePointEvent | Fired when a profile's points are updated. |
| ProfileEvent (abstract) | Represents a profile related event. |
| QuestCompassTargetChangeEvent | Fired when the compass calls the setCompassTarget method. |
| QuestDataUpdateEvent | Fired when the quest data updates. |
| Npc/NpcInteractEvent | Event for interaction with BetonQuest Npcs. |
| Npc/NpcVisibilityUpdateEvent | Event to call if a Npc is externally modified and its BetonQuest features needs recalibration. |