Package privbot.api
@PublicApi
package privbot.api
The PrivBot plugin API boundary: what is supported, and which version of it a runtime provides.
PublicApimarks the supported packages. The list is the resourceprivbot/api/public-packages.txt; everything else in shared-lib is internal.Internalmarkspublictypes and members inside those packages that are not supported (adapter wiring, server-specific helpers).ApiVersionis the API version and the plugin compatibility rule.
Policy: the SDK docs, Versioning.
-
ClassDescriptionThe PrivBot plugin API version, and the rule that decides whether a plugin built against one version may run on another.A load decision with a message fit to show the user.What the unified API supports on the server this plugin runs on.One thing a plugin can ask the unified API to read or do.Translates OSRS ids to the ids this server uses, and back.Marks a type or member that is
publicfor technical reasons but is NOT part of the supported plugin API, even though it lives in aPublicApipackage.Observed<T>The result of one read of game state, with "could not read it" kept apart from every real answer.Which of the three answers a read gave.What happened when a verb was asked to act: an explicit answer instead offalseplus a log line.Why an action was or was not sent.Marks a package or type as part of the supported PrivBot plugin API.The live server a plugin runs on, as the unified API names it.How well the unified API does oneCapabilityon one server.