Skip to main content

Navigation API

This page is generated from the current Java binding inventory. “Supported” means an official script currently uses the member; it does not imply every option or failure path has completed live acceptance testing.

MemberStabilityOfficial usePurpose
arrivedExperimentalNoCheck if navigation completed
blacklistExperimentalNoManually blacklist a position
check_locationExperimentalNoCheck if at location
clear_blacklistSupportedYesRemove a position from blacklist
clear_camera_lockSupportedYesClear Camera Lock
dropExperimentalNoDrop down from current location
etherwarpSupportedYesTeleport using etherwarp
find_ground_positionExperimentalNoFind Ground Position
get_blacklist_countExperimentalNoGet count of blacklisted positions
get_wasd_stuck_reasonExperimentalNoGet reason WASD mode got stuck (resets after read)
get_water_surface_yExperimentalNoGet Y level of water surface at position
has_camera_lockExperimentalNoHas Camera Lock
is_blacklistedExperimentalNoCheck if a position is blacklisted
is_in_waterExperimentalNoCheck if player is currently in water
is_navigatingSupportedYesCheck if currently navigating
is_swim_navigatingExperimentalNoCheck if currently swim navigating
is_swimmingExperimentalNoCheck if player is in swim mode
is_underwaterExperimentalNoCheck if a position is underwater
nearSupportedYesNear
set_camera_lockSupportedYesnavigation uses strafe only.
smart_etherwarpExperimentalNoSmart etherwarp with LOS check
start_asyncSupportedYesStart navigation (path compute is synchronous). Returns immediately after pathfinding starts.
stopSupportedYesStop navigation
swim_toExperimentalNoSwim To
toSupportedYesNavigate to a location