Package privbot.api


@PublicApi package privbot.api
The PrivBot plugin API boundary: what is supported, and which version of it a runtime provides.
  • PublicApi marks the supported packages. The list is the resource privbot/api/public-packages.txt; everything else in shared-lib is internal.
  • Internal marks public types and members inside those packages that are not supported (adapter wiring, server-specific helpers).
  • ApiVersion is the API version and the plugin compatibility rule.

Policy: the SDK docs, Versioning.

  • Class
    Description
    The 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 public for technical reasons but is NOT part of the supported plugin API, even though it lives in a PublicApi package.
    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 of false plus 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 one Capability on one server.