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
Actor.getAnimationFrameCycleActor.getAnimationLoopCountActor.getPoseAnimationFrameCycleActorSpotAnim.getCycleActorSpotAnim.getFrameAnimation.getDurationAnimation.getFrameLengthsAnimation.getFrameStepAnimation.getLeftHandItemAnimation.getNumFramesAnimation.getRestartModeAnimation.getRightHandItemAnimation.isMayaAnimClient.getExpandedMapLoadingClient.getIndexClient.setExpandedMapLoadingEmptyLoadoutSlot.emptySlotEquipmentGoal.{ EquipmentGoalRow }EquipmentGoalRow.EmptyLoadoutSlotEquipmentGoalRow.EquippedLoadoutItemIndexDataBase.loadDataPilotLap.coursePilotLap.orderPilotLap.plansPilotLap.seaPilotStatus.duePilotStatus.steadyProjectile.getAnimationProjectile.getAnimationFrameProjectile.getEndHeightProjectile.getSlopeProjectile.getStartHeightProjectile.getStartPosProjectileMoved.getZQuest.A_SHELL_OF_A_FRIENDQuest.THE_BIRDS_AND_THE_WASPSRouteOptions.setEatFoodSailing.voyageTrialPilot.holdTrialPilot.remainingVoyage.doneVoyage.isSailingVoyage.missedVoyage.startVoyage.statusVoyage.stopVoyageArea.neVoyageArea.notOverVoyageArea.swVoyageArrival."halt"VoyageArrival."leaveHelm"VoyageArrival."sailOn"VoyageClick.itemVoyageClick.npcVoyageClick.objectVoyageClick.optionVoyageClick.tileVoyageFailure."CAPSIZED"VoyageFailure."CARGO_IN_HAND"VoyageFailure."NOT_ABOARD"VoyageFailure."NO_HELM"VoyageFailure."NO_SAIL_CONTROLS"VoyageFailure."STUCK"VoyageFailure."UNREACHABLE"VoyageOptions.arrivalVoyageOptions.clickVoyageOptions.goalVoyageOptions.holdMotesVoyageOptions.routeVoyageOptions.throughVoyageStatus.clickedVoyageStatus.failureVoyageStatus.inAreaVoyageStatus.notesVoyageStatus.passedVoyageStatus.reasonVoyageStatus.state
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.arrivalHelmOptions.arriveHelmOptions.fitHelmOptions.hullLowHelmOptions.lineHelmOptions.marksHelmOptions.passHelmStatus.courseHelmStatus.failureHelmStatus.indexHelmStatus.phaseHelmStatus.reasonHelmStatus.stateHelmsman.isSailingHelmsman.sailToHelmsman.statusHelmsman.stopPilotStatus.rumDueSailing.helmsmanTrialPilot.crateTakenTrialPilot.rumDone
Changed
Version 3 · revision 33
13 November 2026
Added
Bank.enablePinKeyboardDockArea.kindDockArea.neDockArea.swDockAreaKind."reach"DockAreaKind."ring"HelmFailureCode."CAPSIZED"HelmFailureCode."HULL_LOW"HelmOptions.hullLowHelmOptions.lineHelmOptions.marksHelmOptions.passPathQuery.seaCostsPathQuery.toSeaPilotStatus.notesPilotStatus.reasonPilotStatus.remainingPilotStatus.rumDuePilotStatus.stateRecommendedSetting.notOptionRecommendedSetting.notValueSailing.dockAreaSailing.dockAtSailing.pilotSeaCost.costSeaCost.diagonalSeaCost.landableSeaCost.problemSeaCost.reachedSeaCost.stopsAtSeaCost.straightSeaCost.ticksSeaCostOptions.boatSeaCostOptions.fromSeaCostOptions.fromDockSeaCostOptions.maxCostSeaCostOptions.withinSeaCostQuery.costsSeaCostQuery.isDoneSeaCostQuery.problemSeaOptions.withinTagManager.getRegisteredTagTagManager.getRegisteredTagsTagManager.registerTagItemsTagManager.registeredTagContainsTagManager.unregisterTagTrialPilot.crateTakenTrialPilot.lightningStruckTrialPilot.rumDoneTrialPilot.startTrialPilot.statusTrialPilot.stopWebwalk.startSeaWorldTypeName."hardcore"
Version 2 · revision 32
9 November 2026
Added
Actions.lastRefusalActions.refusedCountBoardedBoat.atSailsBoardedBoat.cargoBoardedBoat.crewBoardedBoat.facilitiesBoardedBoat.headingBoardedBoat.helmBoardedBoat.hpBoardedBoat.kindBoardedBoat.maxHpBoardedBoat.maxWindMotesBoardedBoat.motionBoardedBoat.movingBoardedBoat.navigatingBoardedBoat.orientationBoardedBoat.ownBoardedBoat.partsBoardedBoat.playersAboardBoardedBoat.positionBoardedBoat.repairKitsBoardedBoat.resistancesBoardedBoat.roleBoardedBoat.slotBoardedBoat.speedBoardedBoat.speedBoostBoardedBoat.targetBoardedBoat.trimBoardedBoat.windCatcherOnBoardedBoat.windMotesBoardedBoat.worldViewBoatFacility.crewmateBoatFacility.hotspotBoatFacility.kindBoatFacility.objectBoatFacility.occupiedBoatFacility.stateBoatFacilityKind.crewFacilityBoatFacilityKind.facilityTypeBoatFacilityKind.locsBoatFacilityKind.nameBoatFacilityKind.rowBoatFacilityKind.subtypeBoatFacilityState.activeBoatFacilityState.depthBoatFacilityState.kindBoatFacilityState.moteReadyBoatFacilityStateKind."catcher"BoatFacilityStateKind."crystalExtractor"BoatFacilityStateKind."net"BoatFacilityStateKind."none"BoatHeading.orientationBoatHeading.stepBoatHeading.targetOrientationBoatHeading.targetStepBoatHelmStatus."crewSteering"BoatHelmStatus."notSteering"BoatHelmStatus."steering"BoatHelmStatus."unavailable"BoatKind.crewCapacityBoatKind.levelBoatKind.nameBoatKind.playerCapacityBoatKind.rowBoatKind.sizeBoatKind.typeIdBoatLocation.dockBoatLocation.kindBoatLocationKind."bottled"BoatLocationKind."capsized"BoatLocationKind."docked"BoatLocationKind."lostAtSea"BoatMotion."fast"BoatMotion."reversing"BoatMotion."slow"BoatMotion."stopped"BoatPart.kindBoatPart.nameBoatPart.rowBoatPart.sailingLevelBoatPartKind."brazier"BoatPartKind."flag"BoatPartKind."hull"BoatPartKind."keel"BoatPartKind."sail"BoatPartKind."sailPattern"BoatPartKind."steering"BoatPartKind."trim"BoatPosition.fineXBoatPosition.fineYBoatPosition.tileBoatResistances.crystalFleckedBoatResistances.crystalHelmBoatResistances.fetidBoatResistances.icyBoatResistances.rapidsBoatResistances.stormBoatResistances.tangledKelpBoatSpeed.accelerationBoatSpeed.baseBoatSpeed.capBoatSpeedBoost.activeBoatSpeedBoost.ticksLeftBoatStats.accelerationBoatStats.armourBoatStats.baseSpeedBoatStats.cargoSizeBoatStats.crystalFleckedBoatStats.crystalHelmBoatStats.fetidBoatStats.hpMaxBoatStats.icyBoatStats.maxWindMotesBoatStats.rapidsBoatStats.speedCapBoatStats.stormBoatStats.tangledKelpBoatTeleportFocus."focus"BoatTeleportFocus."greater"BoatTeleportFocus."none"BoatTrim.readyBoatTrim.ticksLeftBoatTrim.ticksToGustBoatTrim.waitingClient.getAnimationInterpolationFilterClient.setAnimationInterpolationFilterCrewStat."deckhandiness"CrewStat."helmsmanship"CrewStat."privateering"CrewStation."helm"CrewStation."helmAndSails"CrewStation."hotspot"CrewStation."hullRepairs"CrewStation."none"CrewStation."sails"Crewmate.hotspotCrewmate.kindCrewmate.slotCrewmate.statCrewmate.stationCrewmateKind.boatNpcCrewmateKind.cargoNpcCrewmateKind.deckhandinessCrewmateKind.helmsmanshipCrewmateKind.idCrewmateKind.privateeringDock.idDock.kindDock.levelDock.nameDock.objectDock.questDockKind."mooring"DockKind."port"DockOptions.stayAboardHelmArrival."halt"HelmArrival."leaveHelm"HelmArrival."sailOn"HelmFailureCode."CARGO_IN_HAND"HelmFailureCode."NOT_ABOARD"HelmFailureCode."NO_HELM"HelmFailureCode."NO_SAIL_CONTROLS"HelmFailureCode."STUCK"HelmFailureCode."UNREACHABLE"HelmOptions.arrivalHelmOptions.arriveHelmOptions.fitHelmStatus.courseHelmStatus.failureHelmStatus.indexHelmStatus.phaseHelmStatus.reasonHelmStatus.stateHelmsman.isSailingHelmsman.sailToHelmsman.statusHelmsman.stopOwnedBoat.cargoOwnedBoat.facilitiesOwnedBoat.kindOwnedBoat.locationOwnedBoat.nameOwnedBoat.orientationOwnedBoat.ownedOwnedBoat.partsOwnedBoat.positionOwnedBoat.slotOwnedBoat.spawnedOwnedBoat.statsOwnedBoat.storedHpOwnedBoat.storedMaxHpOwnedBoat.teleportFocusPathQuery.toDockPlayerDomain.sailingPortTask.bountyObjectPortTask.bountyTargetPortTask.cancellablePortTask.cargoPortTask.cargoPortPortTask.deliveredPortTask.deliveryObjectPortTask.endingPortTask.facilitiesRecommendedPortTask.facilitiesRequiredPortTask.idPortTask.kindPortTask.levelPortTask.namePortTask.slotPortTask.startingPortTask.takenPortTaskFacility.namePortTaskFacility.objectPortTaskItem.amountPortTaskItem.itemPortTaskKind."bounty"PortTaskKind."courier"RouteOptions.setAvoidAreasRouteSail.dockRouteSail.fitRouteSail.slotRouteStep.sailSailing.boardedSailing.boatsSailing.crewSailing.dockSailing.docksSailing.helmsmanSailing.lastBoardedSailing.portTaskSlotsSailing.portTasksSailing.shipwreckSailing.trialSailing.trialBestSailing.trialMasterStateSailing.trialRankBestScriptIds."all"ScriptIds.numberScriptIds.{ number }Shipwreck.depletedShipwreck.kindShipwreck.levelShipwreckKind."barracuda"ShipwreckKind."fisherman"ShipwreckKind."fremennik"ShipwreckKind."large"ShipwreckKind."mercenary"ShipwreckKind."merchant"ShipwreckKind."pirate"ShipwreckKind."small"Trial.kindTrial.rankTrial.remainingTrial.ticksTrial.totalTrialKind."gwenithGlide"TrialKind."jubblyJive"TrialKind."temporTantrum"TrialRank."marlin"TrialRank."shark"TrialRank."swordfish"TrialRank."unranked"Webwalk.startDockWebwalkFailureCode."BOAT_UNREACHABLE"WebwalkFailureCode."CARGO_IN_HAND"WebwalkFailureCode."NO_BOAT"WebwalkFailureCode."UNKNOWN_DOCK"
Changed
Version 1 · revision 27
6 November 2026
Added
Changed
ChatboxItemSearch.onDone
Version 1 · revision 26
6 November 2026
Added
ConfigItemType.ColorClassConfigItemType.DimensionClassConfigItemType.DurationClassConfigItemType.InstantClassConfigItemType.KeybindClassConfigItemType.ModifierlessKeybindClassConfigItemType.NotificationClassConfigItemType.PointClassConfigItemType.RectangleClassConfigItemType.WorldPointClassGlobal.InsetsGlobal.wikiInsetsClass.newInventoryGoalEntry.InventoryGoalItemInventoryGoalEntry.{ kind: "anyOf", items: { InventoryGoalItem } }InventoryGoalItem.{ itemId: number, quantity: number }InventoryGoalItem.{ itemId: number, quantity: string }Wiki.itemUrlWiki.npcUrlWiki.pageUrlWiki.searchUrl
Removed
InventoryGoalEntry.{ itemId: number, quantity: number | string }InventoryGoalEntry.{ kind: "anyOf", items: { { itemId: number, quantity: number | string } } }