API changelog

Every change to the Plugin API, newest first. API versioning says how long a member stays and how you hear about a change.

Version 4 · revision 34

18 November 2026

Added

Removed

  • HelmArrival."halt"
  • HelmArrival."leaveHelm"
  • HelmArrival."sailOn"
  • HelmFailureCode."CAPSIZED"
  • HelmFailureCode."CARGO_IN_HAND"
  • HelmFailureCode."HULL_LOW"
  • HelmFailureCode."NOT_ABOARD"
  • HelmFailureCode."NO_HELM"
  • HelmFailureCode."NO_SAIL_CONTROLS"
  • HelmFailureCode."STUCK"
  • HelmFailureCode."UNREACHABLE"
  • HelmOptions.arrival
  • HelmOptions.arrive
  • HelmOptions.fit
  • HelmOptions.hullLow
  • HelmOptions.line
  • HelmOptions.marks
  • HelmOptions.pass
  • HelmStatus.course
  • HelmStatus.failure
  • HelmStatus.index
  • HelmStatus.phase
  • HelmStatus.reason
  • HelmStatus.state
  • Helmsman.isSailing
  • Helmsman.sailTo
  • Helmsman.status
  • Helmsman.stop
  • PilotStatus.rumDue
  • Sailing.helmsman
  • TrialPilot.crateTaken
  • TrialPilot.rumDone

Changed

Version 3 · revision 33

13 November 2026

Added

Version 2 · revision 32

9 November 2026

Added

Changed

Version 1 · revision 27

6 November 2026

Added

Changed

  • ChatboxItemSearch.onDone

Version 1 · revision 26

6 November 2026

Added

  • ConfigItemType.ColorClass
  • ConfigItemType.DimensionClass
  • ConfigItemType.DurationClass
  • ConfigItemType.InstantClass
  • ConfigItemType.KeybindClass
  • ConfigItemType.ModifierlessKeybindClass
  • ConfigItemType.NotificationClass
  • ConfigItemType.PointClass
  • ConfigItemType.RectangleClass
  • ConfigItemType.WorldPointClass
  • Global.Insets
  • Global.wiki
  • InsetsClass.new
  • InventoryGoalEntry.InventoryGoalItem
  • InventoryGoalEntry.{ kind: "anyOf", items: { InventoryGoalItem } }
  • InventoryGoalItem.{ itemId: number, quantity: number }
  • InventoryGoalItem.{ itemId: number, quantity: string }
  • Wiki.itemUrl
  • Wiki.npcUrl
  • Wiki.pageUrl
  • Wiki.searchUrl

Removed

  • InventoryGoalEntry.{ itemId: number, quantity: number | string }
  • InventoryGoalEntry.{ kind: "anyOf", items: { { itemId: number, quantity: number | string } } }