AP_Scripting: update lua docs

This commit is contained in:
Andrew Tridgell 2022-03-07 14:06:46 +11:00
parent f09c715d7a
commit 3d9086b460
1 changed files with 67 additions and 0 deletions

View File

@ -388,6 +388,9 @@ function Vector2f_ud:normalize() end
---@return number ---@return number
function Vector2f_ud:length() end function Vector2f_ud:length() end
-- desc
---@return number
function Vector2f_ud:angle() end
-- desc -- desc
---@class Vector3f_ud ---@class Vector3f_ud
@ -458,6 +461,14 @@ function Vector3f_ud:normalize() end
---@return number ---@return number
function Vector3f_ud:length() end function Vector3f_ud:length() end
-- desc
---@param param1 number -- XY rotation in radians
function Vector3f_ud:rotate_xy(param1) end
-- desc
---@return Vector2f_ud
function Vector3f_ud:xy() end
-- desc -- desc
---@class Location_ud ---@class Location_ud
@ -1309,6 +1320,12 @@ function vehicle:set_target_posvel_NED(target_pos, target_vel) end
---@return boolean ---@return boolean
function vehicle:set_target_pos_NED(target_pos, use_yaw, yaw_deg, use_yaw_rate, yaw_rate_degs, yaw_relative, terrain_alt) end function vehicle:set_target_pos_NED(target_pos, use_yaw, yaw_deg, use_yaw_rate, yaw_rate_degs, yaw_relative, terrain_alt) end
-- desc
---@param param1 Location_ud -- current target
---@param param2 Location_ud -- new target
---@return boolean
function vehicle:update_target_location(param1, param2) end
-- desc -- desc
---@return Location_ud|nil ---@return Location_ud|nil
function vehicle:get_target_location() end function vehicle:get_target_location() end
@ -1357,6 +1374,32 @@ function vehicle:get_mode() end
---@return boolean ---@return boolean
function vehicle:set_mode(mode_number) end function vehicle:set_mode(mode_number) end
-- desc
---@param param1 Vector2f_ud
---@return boolean
function vehicle:set_velocity_match(param1) end
-- desc
---@param param1 integer
---@return boolean
function vehicle:nav_scripting_enable(param1) end
-- desc
---@param param1 number
---@param param2 number
---@return boolean
function vehicle:set_desired_turn_rate_and_speed(param1, param2) end
-- desc
---@param param1 number -- throttle percent
---@param param2 number -- roll rate deg/s
---@param param3 number -- pitch rate deg/s
---@param param4 number -- yaw rate deg/s
function vehicle:set_target_throttle_rate_rpy(param1, param2, param3, param4) end
-- desc
---@param param1 integer
function vehicle:nav_script_time_done(param1) end
-- desc -- desc
---@class onvif ---@class onvif
@ -1904,4 +1947,28 @@ function ahrs:get_pitch() end
---@return number ---@return number
function ahrs:get_roll() end function ahrs:get_roll() end
-- desc
---@class follow
follow = {}
-- desc
---@return number|nil
function follow:get_target_heading_deg() end
-- desc
---@return Location_ud|nil
---@return Vector3f_ud|nil
function follow:get_target_location_and_velocity_ofs() end
-- desc
---@return Location_ud|nil
---@return Vector3f_ud|nil
function follow:get_target_location_and_velocity() end
-- desc
---@return uint32_t_ud
function follow:get_last_update_ms() end
-- desc
---@return boolean
function follow:have_target() end