Skip to content

Objectives

API State: Unfinished

Todo

This part of the API is only planned.

Do not use anything of this part of the API yet. It will change in the future.

Unfinished

This part of the API is brand-new. It will be changed if there are any bugs, missing features or usability improvements. This part of the API might receive breaking changes within a minor version.

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. We will try to keep it compatible with previous versions if changes are needed. This part of the API won't receive breaking changes within a minor version.

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 will only change over at least one major version and will likely carry deprecation as long as possible.

This part of the API should be safe to use. We try to keep it compatible with previous versions if changes are needed.

Objective API Classes
  • org.betonquest.betonquest.api.service.objective.Objectives
  • org.betonquest.betonquest.api.service.objective.ObjectiveManager
  • org.betonquest.betonquest.api.service.objective.ObjectiveRegistry
  • org.betonquest.betonquest.api.quest.objective.Objective
  • org.betonquest.betonquest.api.quest.objective.ObjectiveFactory

Introduction🔗

This page covers the Objective API of BetonQuest. You will be introduced to the following:

This page does not cover:

How to create an objective🔗

How to create a factory for an objective🔗

How to register an objective and its factory with BetonQuest🔗

How to access an objective🔗

How a full example looks like🔗

What limitations are there🔗