intellisense.lua

----------------------------------------
--- // Info
----------------------------------------

--[[
    This file contains every Addon Lua function, callback, and type.
    Simply put this file in your code workspace and you should have intellisense support (auto-completion, etc) for Addon Lua.

    This extension is required: https://marketplace.visualstudio.com/items?itemName=sumneko.lua

    Created by: @nameouschangey (GitHub) and @Toast732 (GitHub)
    Maintained by: @Cuh4 (GitHub)

    Repo: https://github.com/Cuh4/StormworksAddonLuaDocumentation
]]

----------------------------------------
--- // Changelog
----------------------------------------

--[[
    Last updated for game version: v1.14.3 (The Firefighter SCBA Update)
        Note that even if the above version is outdated on the latest version of this repo, it means no 
        functions were added, changed or removed from the game since the update.
        
        Corrections and changes to the documentation may still be made after the game version is outdated
        anyway.

    Changelog available at the GitHub repo @ https://github.com/Cuh4/StormworksAddonLuaDocumentation.
]]

----------------------------------------
--- // Main
----------------------------------------

---@meta _

-------------------
-- Definitions
-------------------

--[[
    A table containing most of addon lua's functions.

    server.announce("Server", "Hello World")
]]
server = {}

--[[
    A table containing functions that can be used for making your addon easily customizable by the user.<br>
    Functions in this table must be saved in g_savedata.

    g_savedata = {
        example = property.checkbox("Example", false), -- defaults to false, name is "Example"
        ... -- anything else you want in g_savedata
    }
]]
property = {}

--[[
    A table containing functions that can be used for creating and manipulating matrices.<br>

    local myMatrix = matrix.translation(0, 0, 0)
    local x, y, z = matrix.position(myMatrix)

    print(x, y, z) -- 0, 0, 0
  ]]
matrix = {}

--[[
    A table containing debug-related functions. Only `debug.log` exists for now.<br>

    debug.log("Hello World")
]]
debug = {}

--[[
    A table used for saving tables, numbers, strings, and booleans across addon reloads and sessions.<br>
    Only access g_savedata after `onCreate` is called, otherwise saved values won't be loaded yet.

    g_savedata = {}
    
    function onCreate(is_create)
        if is_create then -- this is a new save
            g_savedata.example = "Hello World"
        end
    
        print(g_savedata.example) -- "Hello World"
    end
]]
g_savedata = {}

-------------------
-- Matrices
-------------------

---@class SWMatrix
---@field [1] number
---@field [2] number
---@field [3] number
---@field [4] number
---@field [5] number
---@field [6] number
---@field [7] number
---@field [8] number
---@field [9] number
---@field [10] number
---@field [11] number
---@field [12] number
---@field [13] number x
---@field [14] number y
---@field [15] number z
---@field [16] number

-- Multiplies two matrices together
---@param matrix1 SWMatrix
---@param matrix2 SWMatrix
---@return SWMatrix matrix
function matrix.multiply(matrix1, matrix2) end

-- Inverts the matrix
---@param matrix SWMatrix
---@return SWMatrix matrix
function matrix.invert(matrix) end

-- Transposes a matrix
---@param matrix SWMatrix
---@return SWMatrix matrix
function matrix.transpose(matrix) end

-- Returns an identity matrix
---@return SWMatrix matrix
function matrix.identity() end

-- Converts radians to the x axis rotation in a matrix. Doesn't rotate the orientation. Rotates the point around the center of the world (0,0,0)
---@param radians number The angle in radians you want to convert
---@return SWMatrix matrix
function matrix.rotationX(radians) end

-- Converts radians to the y axis rotation in a matrix
---@param radians number The angle in radians you want to convert
---@return SWMatrix matrix
function matrix.rotationY(radians) end

-- Converts radians to the z axis rotation in a matrix
---@param radians number The angle in radians you want to convert
---@return SWMatrix matrix
function matrix.rotationZ(radians) end

-- Returns your x,y,z points as a matrix
---@param x number
---@param y number
---@param z number
---@return SWMatrix matrix
function matrix.translation(x, y, z) end

-- Returns x,y,z when given a matrix
---@param matrix SWMatrix returns the location tuplets from the matrix provided. this is the same as MATRIX[13],MATRIX[14],MATRIX[15]
---@return number x, number y, number z
function matrix.position(matrix) end

-- Returns the distance in meters between two matrices in 3D space
---@param matrix1 SWMatrix The first matrix
---@param matrix2 SWMatrix The second matrix
---@return number dist
function matrix.distance(matrix1, matrix2) end

-- Multiplies a matrix by a vec 4.
---@param matrix1 SWMatrix The matrix to multiply
---@param x number
---@param y number
---@param z number
---@param w number
---@return number out_x, number out_y, number out_z, number out_w
function matrix.multiplyXYZW(matrix1, x, y, z, w) end

-- Returns the rotation required to face an X Z vector
---@param x number
---@param z number
---@return SWMatrix required_rotation
function matrix.rotationToFaceXZ(x, z) end

-------------------
-- Callbacks
-------------------

-- Called when all oil spills are cleared
function onClearOilSpill() end

-- called every game tick
---@param game_ticks number the number of ticks since the last onTick call (normally 1, while sleeping 400.)
function onTick(game_ticks) end

-- Called when the script is initialized (whenever creating or loading a world.)
---@param is_world_create boolean Only returns true when the world is first created.
function onCreate(is_world_create) end

-- Called when the world is exited.
function onDestroy() end

-- Called when a command is entered into chat, does not trigger if sent by server.
---@param full_message string The full message that was sent
---@param peer_id number The peer ID of the player who sent the message
---@param is_admin boolean If the player who entered the command has admin
---@param is_auth boolean If the player who entered the command is authenticated
---@param command string The command the player sent (ex: player entered "?help me", command will be "?help")
---@param ... string The rest of the args of the command, can be packed into a table with "arg = table.pack(...)" and referenced with "arg[1]", "arg[2]", ect
function onCustomCommand(full_message, peer_id, is_admin, is_auth, command, ...) end

-- Called when a message is sent to the chat, does not trigger if sent by server.
---@param peer_id number The peer ID of the player who sent the message
---@param sender_name string The name of the player who sent the message
---@param message string The message that was sent
function onChatMessage(peer_id, sender_name, message) end

-- Called when a player joins the game.
---@param steam_id number The player's Steam ID (convert to string as soon as possible to prevent loss of data)
---@param name string The player's name
---@param peer_id number The player's peer ID
---@param is_admin boolean If the player has admin
---@param is_auth boolean If the player is authenticated
function onPlayerJoin(steam_id, name, peer_id, is_admin, is_auth) end

-- Called when a player sits in a seat.
---@param peer_id number The peer ID of the player who sat in the seat
---@param vehicle_id number The vehicle ID of the vehicle which the seat belongs to
---@param seat_name string The name of the seat
function onPlayerSit(peer_id, vehicle_id, seat_name) end

-- Called when a player gets out of the seat.
---@param peer_id number The peer ID of the player who got out of the seat
---@param vehicle_id number The vehicle ID of the vehicle which the seat belongs to
---@param seat_name string The name of the seat
function onPlayerUnsit(peer_id, vehicle_id, seat_name) end

-- Called when any character (including players) sits in a seat.
---@param object_id number The object ID of the character which sat in the seat
---@param vehicle_id number The vehicle ID of the vehicle which the seat belongs to
---@param seat_name string The name of the seat
function onCharacterSit(object_id, vehicle_id, seat_name) end

-- Called when any character (including players) get out of a seat.
---@param object_id number The object ID of the character which sat in the seat
---@param vehicle_id number The vehicle ID of the vehicle which the seat belongs to
---@param seat_name string The name of the seat
function onCharacterUnsit(object_id, vehicle_id, seat_name) end

-- Called whenever any character (including players) picks up a character (including players).
---@param object_id_actor number the object id of the object which picked up the character
---@param object_id_target number the object id of who was picked up
function onCharacterPickup(object_id_actor, object_id_target) end

-- Called when any creature sits in a seat.
---@param object_id number The object ID of the creature which sat in the seat
---@param vehicle_id number The vehicle ID of the vehicle which the seat belongs to
---@param seat_name string The name of the seat
function onCreatureSit(object_id, vehicle_id, seat_name) end

-- Called when any creature gets gets out of a seat.
---@param object_id number The object ID of the character which sat in the seat
---@param vehicle_id number The vehicle ID of the vehicle which the seat belongs to
---@param seat_name string The name of the seat
function onCreatureUnsit(object_id, vehicle_id, seat_name) end

-- Called whenever any character (including players) pick up a creature.
---@param object_id_actor number the object id of the object which picked up the creature
---@param object_id_target number the object id of who was picked up
function onCreaturePickup(object_id_actor, object_id_target) end

-- Called when a character (including players) picks up an equipment item
---@param character_object_id number the object_id of the character
---@param equipment_object_id number the object_id of the equipment item
---@param EQUIPMENT_ID SWEquipmentTypeEnum the equipment_id of the item which was picked up.
function onEquipmentPickup(character_object_id, equipment_object_id, EQUIPMENT_ID) end

-- Called when a character (including players) drops an equipment item
---@param character_object_id number the object_id of the character
---@param equipment_object_id number the object_id of the equipment item
---@param EQUIPMENT_ID SWEquipmentTypeEnum the equipment_id of the item which was dropped.
function onEquipmentDrop(character_object_id, equipment_object_id, EQUIPMENT_ID) end

-- Called whenever a player respawns.
---@param peer_id number The peer ID of the player who respawned
function onPlayerRespawn(peer_id) end

-- Called when a player leaves the game.
---@param steam_id number The player's Steam ID (convert to string as soon as possible to prevent loss of data.)
---@param name string The player's name.
---@param peer_id number The player's peer ID.
---@param is_admin boolean If the player had admin.
---@param is_auth boolean If the player was authenticated.
function onPlayerLeave(steam_id, name, peer_id, is_admin, is_auth) end

-- Called when a player opens/closes the map.
---@param peer_id number The player's peer ID
---@param is_open boolean false if the map was closed, true if the map was opened
function onToggleMap(peer_id, is_open) end

-- Called when a player dies.
---@param steam_id number The player's Steam ID (convert to string as soon as possible to prevent loss of data.)
---@param name string The player's name.
---@param peer_id number The player's peer ID.
---@param is_admin boolean If the player has admin.
---@param is_auth boolean If the player is authenticated.
function onPlayerDie(steam_id, name, peer_id, is_admin, is_auth) end

-- Called when a vehicle is spawned.
---@param vehicle_id number The vehicle ID of the vehicle that was spawned.
---@param peer_id number The peer ID of the player who spawned the vehicle, -1 if spawned by the server.
---@param x number The x coordinate of the vehicle's spawn location relative to world space.
---@param y number The y coordinate of the vehicle's spawn location relative to world space.
---@param z number The z coordinate of the vehicle's spawn location relative to world space.
---@param group_cost number The cost of the group this vehicle belongs to.
---@param group_id number The ID of the group this vehicle belongs to
function onVehicleSpawn(vehicle_id, peer_id, x, y, z, group_cost, group_id) end

-- Called when a group is spawned.
---@param group_id number The group_cost ID of the group that was spawned.
---@param peer_id number The peer ID of the player who spawned the group, -1 if spawned by the server.
---@param x number The x coordinate of the group's spawn location relative to world space.
---@param y number The y coordinate of the group's spawn location relative to world space.
---@param z number The z coordinate of the group's spawn location relative to world space.
---@param group_cost number The cost of the group
function onGroupSpawn(group_id, peer_id, x, y, z, group_cost) end

-- Called when a vehicle is despawned.
---@param vehicle_id number the vehicle ID of the vehicle that was despawned.
---@param peer_id number The peer ID of the player who despawned the vehicle, -1 if despawned by the server.
function onVehicleDespawn(vehicle_id, peer_id) end

-- Called when a vehicle is loaded and is ready to be simulated.
---@param vehicle_id number The vehicle ID of the vehicle that was loaded.
function onVehicleLoad(vehicle_id) end

-- Called when a vehicle is unloaded and is no longer simulating.
---@param vehicle_id number The vehicle ID of the vehicle that was unloaded.
function onVehicleUnload(vehicle_id) end

-- Called when a vehicle is teleported or returned to the workbench.
---@param vehicle_id number The vehicle ID of the vehicle that was teleported.
---@param peer_id number The peer ID of the player who teleported the vehicle, -1 if teleported by the server.
---@param x number The x coordinate of the vehicle's spawn location relative to world space.
---@param y number The y coordinate of the vehicle's spawn location relative to world space.
---@param z number The z coordinate of the vehicle's spawn location relative to world space.
function onVehicleTeleport(vehicle_id, peer_id, x, y, z) end

-- Called when an object (character/prop/animal) has loaded and is ready to simulate.
---@param object_id number The object ID of the object that was loaded.
function onObjectLoad(object_id) end

-- Called when an object (character/prop/animal) is unloaded and is no longer simulating.
---@param object_id number The object ID of the object that was unloaded.
function onObjectUnload(object_id) end

-- Called when a button is interacted with (still triggers for locked buttons). For getting a button's current state use server.getVehicleButton() instead. Does not trigger if the button was interacted with by the server.
---@param vehicle_id number The vehicle ID of the vehicle that the button belongs to.
---@param peer_id number The peer ID of the player who interacted with the button.
---@param button_name string The name of the button that was interacted with.
---@param is_pressed boolean if the button's state is now pressed.
function onButtonPress(vehicle_id, peer_id, button_name, is_pressed) end

-- Called when a vehicle or object is spawned by a script.
---@param vehicle_or_object_id number The vehicle ID or object ID that was spawned.
---@param component_name string The display name of the component that was spawned.
---@param TYPE_STRING string The type of the component as a string ("zone", "object", "character", "vehicle", "flare", "fire", "loot", "button", "animal", "ice")
---@param addon_index number The internal index of the addon which spawned the vehicle or object.
function onSpawnAddonComponent(vehicle_or_object_id, component_name, TYPE_STRING, addon_index) end

-- Called whenever a vehicle is damaged or repaired.
---@param vehicle_id number The vehicle ID of the vehicle that was damaged or repaired.
---@param damage_amount number The amount of damage that was done to the vehicle, Negative when its repaired.
---@param voxel_x number 0,0,0 is the center of the vehicle (viewable with the move tool). Each "block" or 0.25m is a different voxel. 0,0.25,0 is one block above the start point.
---@param voxel_y number
---@param voxel_z number
---@param body_index number the body index which was damaged, 0 is the main body, useful for ignoring damage to missiles (body index can be seen via merge view in the editor, {0 = red, green, blue, yellow, magenta, cyan, orange,...})
function onVehicleDamaged(vehicle_id, damage_amount, voxel_x, voxel_y, voxel_z, body_index) end

---+ Called when a HTTP request has been returned. The callback details the request and recieved reply.
---@param port number The port the request was recieved from.
---@param request string The request that was recieved.
---@param reply string The reply that was recieved from the request.
function httpReply(port, request, reply) end

-- Called when a fire is extinguished.
---@param fire_x number The x coordinate of the fire which was extinguished in world space.
---@param fire_y number The y coordinate of the fire which was extinguished in world space.
---@param fire_z number The z coordinate of the fire which was extinguished in world space.
function onFireExtinguished(fire_x, fire_y, fire_z) end

-- Called when 5 or more trees have been detected to be on fire within a small radius.
---@param fire_objective_id number The fire objective ID of the forest fire, used to tell apart multiple forest fires.
---@param fire_x number The x coordinate of the forest fire which was detected in world space.
---@param fire_y number The y coordinate of the forest fire which was detected in world space.
---@param fire_z number The z coordinate of the forest fire which was detected in world space.
function onForestFireSpawned(fire_objective_id, fire_x, fire_y, fire_z) end

-- Called when a forest fire is extinguished.
---@param fire_objective_id number The fire objective ID of the forest fire, used to tell apart multiple forest fires.
---@param fire_x number The x coordinate of the forest fire which was extinguished in world space.
---@param fire_y number The y coordinate of the forest fire which was extinguished in world space.
---@param fire_z number The z coordinate of the forest fire which was extinguished in world space.
function onForestFireExtinguished(fire_objective_id, fire_x, fire_y, fire_z) end

-- Called when a Tornado is spawned.
---@param transform SWMatrix Where the Tornado was spawned.
function onTornado(transform) end

-- Called when a Meteor is spawned.
---@param transform SWMatrix Where the Meteor was spawned.
function onMeteor(transform, magnitude) end

-- Called when a Tsunami is spawned.
---@param transform SWMatrix Where the Tsunami was spawned.
---@param magnitude number The magnitude of the Tsunami. (0-1)
function onTsunami(transform, magnitude) end

-- Called when a Whirlpool is spawned.
---@param transform SWMatrix Where the Whirlpool was spawned.
---@param magnitude number The magnitude of the Whirlpool. (0-1)
function onWhirlpool(transform, magnitude) end

-- Called when a Volcano erupts.
---@param transform SWMatrix Where the Volcano was spawned.
function onVolcano(transform) end

-- Called when an oil spill is updated
---@param tile_x number tile_x coordinate
---@param tile_z number tile_z coordinate
---@param delta number how much the oil amount has changed since last time.
---@param total number the total amount of oil for this spill
---@param vehicle_id integer the vehicle_id which caused the oil spill to change, vehicle_id is -1 for script commands and oil tick updates.
function onOilSpill(tile_x, tile_z, delta, total, vehicle_id) end

-------------------
-- Enums
-------------------

---@alias SWObjectTypeEnum
---| 0 # none
---| 1 # character
---| 2 # crate_small
---| 3 # collectable (Not spawnable)
---| 4 # basketball
---| 5 # television
---| 6 # barrel
---| 7 # schematic  (Not spawnable)
---| 8 # debris  (Not spawnable)
---| 9 # chair
---| 10 # trolley_food
---| 11 # trolley_med
---| 12 # clothing  (Not spawnable)
---| 13 # office_chair
---| 14 # book
---| 15 # bottle
---| 16 # fryingpan
---| 17 # mug
---| 18 # saucepan
---| 19 # stool
---| 20 # telescope
---| 21 # log
---| 22 # bin
---| 23 # book_2
---| 24 # loot
---| 25 # blue_barrel
---| 26 # buoyancy_ring
---| 27 # container
---| 28 # gas_canister
---| 29 # pallet
---| 30 # storage_bin
---| 31 # fire_extinguisher
---| 32 # trolley_tool
---| 33 # cafetiere
---| 34 # drawers_tools
---| 35 # glass
---| 36 # microwave
---| 37 # plate
---| 38 # box_closed
---| 39 # box_open
---| 40 # desk_lamp
---| 41 # eraser_board
---| 42 # folder
---| 43 # funnel
---| 44 # lamp
---| 45 # microscope
---| 46 # notebook
---| 47 # pen_marker
---| 48 # pencil
---| 49 # scales
---| 50 # science_beaker
---| 51 # science_cylinder
---| 52 # science_flask
---| 53 # tub_1
---| 54 # tub_2
---| 55 # filestack
---| 56 # barrel_toxic
---| 57 # flare
---| 58 # fire
---| 59 # animal
---| 60 # map_label  (Not spawnable)
---| 61 # iceberg    (Not spawnable)
---| 62 # gun_flare
---| 63 # vehicle_flare
---| 64 # ammo_shell
---| 65 # binoculars
---| 66 # C4
---| 67 # grenade
---| 68 # vehicle_flare
---| 69 # coal
---| 70 # meteorite
---| 71 # glowstick
---| 72 # creature
---| 73 # drill_rod
---| 74 # fishing_lure

---@alias SWAddonComponentDataTypeEnum
---| 0 # zone
---| 1 # object
---| 2 # character
---| 3 # vehicle
---| 4 # flare
---| 5 # fire
---| 6 # loot
---| 7 # button
---| 8 # animal
---| 9 # ice
---| 10 # cargo_zone

---@alias SWTankFluidTypeEnum
---| 0 # freshwater
---| 1 # diesel
---| 2 # jetfuel
---| 3 # air
---| 4 # exhaust
---| 5 # oil
---| 6 # seawater
---| 7 # steam
---| 8 # slurry
---| 9 # saturated slurry
---| 10 # oxygen
---| 11 # nitrogen
---| 12 # hydrogen

---@alias SWResourceTypeEnum
---| 0 # coal
---| 1 # iron
---| 2 # aluminium
---| 3 # gold
---| 4 # gold_dirt
---| 5 # uranium
---| 6 # ingot_iron
---| 7 # ingot_steel
---| 8 # ingot_aluminium
---| 9 # ingot_gold_impure
---| 10 # ingot_gold
---| 11 # ingot_uranium
---| 12 # solid_propellant
---| 13 # anchovy
---| 14 # anglerfish
---| 15 # arctic_char
---| 16 # ballan_lizardfish
---| 17 # ballan_wrasse
---| 18 # barreleye_fish
---| 19 # black_bream
---| 20 # black_dragonfish
---| 21 # clownfish
---| 22 # cod
---| 23 # dolphinfish
---| 24 # gulper_eel
---| 25 # haddock
---| 26 # hake
---| 27 # herring
---| 28 # john_dory
---| 29 # labrus
---| 30 # lanternfish
---| 31 # mackerel
---| 32 # midshipman
---| 33 # perch
---| 34 # pike
---| 35 # pinecone_fish
---| 36 # pollock
---| 37 # red_mullet
---| 38 # rockfish
---| 39 # sablefish
---| 40 # salmon
---| 41 # sardine
---| 42 # scad
---| 43 # sea_bream
---| 44 # halibut
---| 45 # sea_piranha
---| 46 # seabass
---| 47 # slimehead
---| 48 # snapper
---| 49 # gold_snapper
---| 50 # snook
---| 51 # spadefish
---| 52 # trout
---| 53 # tubeshoulders_fish
---| 54 # viperfish
---| 55 # yellowfin_tuna

---@alias SWGameSettingEnum
---| "photo_mode"
---| "map_show_players"
---| "sharks"
---| "infinite_fuel"
---| "lightning"
---| "show_name_plates"
---| "override_weather"
---| "megalodon"
---| "infinite_money"
---| "night_length"
---| "fast_travel"
---| "cleanup_vehicle"
---| "settings_menu"
---| "settings_menu_lock"
---| "rogue_mode"
---| "ceasefire"
---| "vehicle_damage"
---| "vehicle_spawning"
---| "engine_overheating"
---| "third_person_vehicle"
---| "infinite_ammo"
---| "no_clip"
---| "unlock_all_components"
---| "day_length"
---| "player_damage"
---| "map_show_vehicles"
---| "despawn_on_leave"
---| "third_person"
---| "infinite_batteries"
---| "teleport_vehicle"
---| "clear_fow"
---| "npc_damage"
---| "show_3d_waypoints"
---| "map_teleport"
---| "respawning"
---| "unlock_all_islands"

-------------------
-- Addon
-------------------

---@alias SWZoneTypeEnum
---| 0 # box
---| 1 # sphere
---| 2 # radius

---@class SWZone
---@field tags         table<number, string> The tags on the zone
---@field tags_full    string
---@field name         string The name of the zone
---@field transform    SWMatrix The location of the zone
---@field size         SWZoneSize size of the zone
---@field radius       number The radius of the zone
---@field type         SWZoneTypeEnum The shape of the zone
---@field parent_vehicle_id number the parent's vehicle_id
---@field parent_relative_transform SWMatrix the matrix relative to the parent

---@class SWZoneSize
---@field x number The world X coordinate
---@field y number The world Y coordinate
---@field z number The world Z coordinate

---@class SWAddonData
---@field name             string The name of the addon
---@field path_id          string
---@field file_store       string
---@field location_count   number The number of locations in the addon

---@class SWLocationData
---@field name             string The name of the location
---@field tile             string The filename of the tile location
---@field env_spawn_count  number The amount of environment spawns
---@field env_mod          boolean Whether the location is an environment mod
---@field component_count  number The amount of components in this location

---@class SWAddonComponentData
---@field tags_full                        string
---@field tags                             table<number, string> The tags on the component
---@field display_name                     string The display name of the component
---@field type                             SWAddonComponentDataTypeEnum The type of the component (0 = zone, 1 = object, 2 = character, 3 = vehicle, 4 = flare, 5 = fire, 6 = loot, 7 = button, 8 = animal, 9 = ice, 10 = cargo_zone)
---@field id                               number The ID of the component from the missions editor e.g. ID_27
---@field dynamic_object_type              SWObjectTypeEnum The object type of the component (number for pan/character/pot/whatever)
---@field transform                        SWMatrix The position of the component
---@field vehicle_parent_component_id      number
---@field character_outfit_type            number The character outfit type (See Outfit type)
---@field interactable                     boolean
---@field creature_type                    SWCreatureTypeEnum
---@field animal_type                      SWAnimalTypeEnum

---@class SWAddonComponentSpawned
---@field tags_full            string The tags as a string (ex. "tag1,tag2,tag3")
---@field tags                 table<number, string> The tags of the component
---@field display_name         string The display name of the component
---@field type                 SWAddonComponentDataTypeEnum The type of the component
---@field transform            SWMatrix The location of the component
---@field id                   number object_id/vehicle id of spawned item
---@field object_id            number The object_id/main_vehicle_id, if this component is an object
---@field group_id             number The object_id/group_id, if this component is a group
---@field vehicle_ids          table<integer, integer> The IDs of the vehicle belonging to this component if it is a group

-- Get the internal index of an active addon (useful if you want to spawn objects from another script). Omitting the name argument will return this addon's index
---@param name string|nil The name of the addon as it appears in xml file. Not the filename
---@return number addon_index, boolean is_success
function server.getAddonIndex(name) end

---@deprecated
server.getPlaylistIndexCurrent = server.getAddonIndex

---@deprecated
server.getPlaylistIndexByName = server.getAddonIndex

-- Get the internal index of a location in the specified addon by its name (this index is local to the addon)
---@param addon_index number The index of the addon as it is found in the missions folder. There is no set order and it may not be the same next execution.
---@param name string The name of the location as it appears in the addon
---@return number location_index
function server.getLocationIndex(addon_index, name) end

-- The name of the location as it appears in the addon
---@param name string
---@return boolean is_success
function server.spawnThisAddonLocation(name) end

---@deprecated
server.spawnThisPlaylistMissionLocation = server.spawnThisAddonLocation

-- Directly spawn a location by a name from the current addon, optional matrix parameter
---@param name string the name of the location in the current addon
---@param matrix SWMatrix? optional param, leaving blank will result in it spawning at the first tile of the location type, matrix in global space.
---@return number location_index the index of the location which was spawned.
---@return boolean is_success true if it successfully spawned the location, false if it failed
function server.spawnNamedAddonLocation(name, matrix) end

-- Spawn a mission location at the given matrix
---@param matrix SWMatrix Matrix the mission location should spawn at. 0,0,0 matrix will spawn at a random location of the tile's type.
---@param addon_index number The index of the addon as it is found in the missions folder. There is no set order and it may not be the same next execution.
---@param location_index number The index of the location as it appears in the addon.
---@return SWMatrix matrix, boolean is_success
function server.spawnAddonLocation(matrix, addon_index, location_index) end

---@deprecated
server.spawnMissionLocation = server.spawnAddonLocation

-- Get the filepath of a addon
---@param addon_name string The name of the addon as it appears in the save file
---@param is_rom boolean Only true for missions that are made by the developers (or at least put in the file path "Stormworks\rom\data\missions")
---@return string path, boolean is_success
function server.getAddonPath(addon_name, is_rom) end

---@deprecated
server.getPlaylistPath = server.getAddonPath

-- Returns a list of all env mod zones
---@param tag string|nil Returns a list of all env mod zones that match the tag(s). Example: server.getZones("type=car,arctic")  Returns all zones that have exactly type=car AND arctic in it's tags
---@return table<number, SWZone> ZONE_LIST
function server.getZones(tag) end

-- Returns whether the matrix is within an env mod zone that matches the display name
---@param matrix SWMatrix The matrix to check
---@param zone_display_name string The environment mod zone to test the matrix against
---@return boolean is_in_zone, boolean is_success
function server.isInZone(matrix, zone_display_name) end

-- Returns the amount of addons that are enabled on this save
---@return number count
function server.getAddonCount() end

---@deprecated
server.getPlaylistCount = server.getAddonCount

-- Returns data about the addon
---@param addon_index number The index of the addon as it is found in the missions folder. There is no set order and it may not be the same next execution. INDEX STARTS AT 0
---@return SWAddonData addon_data
function server.getAddonData(addon_index) end

---@deprecated
server.getPlaylistData = server.getAddonData

-- Returns data on a specific location in the addon
---@param addon_index number The index of the addon as it is found in the missions folder. There is no set order and it may not be the same next execution. INDEX STARTS AT 0
---@param location_index number The index of the location as it is found in the missions folder. There is no set order and it may not be the same next execution. INDEX STARTS AT 0
---@return SWLocationData location_data, boolean is_success
function server.getLocationData(addon_index, location_index) end

-- Returns data on a specific mission component. returned data includes component_id which can be used with server.spawnVehicle()
---@param addon_index number The index of the addon as it is found in the missions folder. There is no set order and it may not be the same next execution. INDEX STARTS AT 0
---@param location_index number The index of the location in the addon
---@param component_index number The index of the component in the addon
---@return SWAddonComponentData component_data, boolean is_success
function server.getLocationComponentData(addon_index, location_index, component_index) end

-- Spawns a component within an addon's misson location. This can be used to spawn vehicles, objects, NPCs, fires, etc.
---@param matrix SWMatrix The matrix the mission object should be spawned at
---@param addon_index number The index of the addon as it is found in the missions folder. There is no set order and it may not be the same next execution.
---@param location_index number The unique index of the location that the component is in
---@param component_index number The index of the component that can be read from the COMPONENT_DATA table using server.getLocationComponentData()
---@param parent_vehicle_id number? optional id of the vehicle to parent the fire or zone component to,
---@return SWAddonComponentSpawned component, boolean is_success
function server.spawnAddonComponent(matrix, addon_index, location_index, component_index, parent_vehicle_id) end

---@deprecated
server.spawnMissionComponent = server.spawnAddonComponent

-------------------
-- UI
-------------------

---@alias SWLabelTypeEnum
---| 0 # none
---| 1 # cross
---| 2 # wreckage
---| 3 # terminal
---| 4 # military
---| 5 # heritage
---| 6 # rig
---| 7 # industrial
---| 8 # hospital
---| 9 # science
---| 10 # airport
---| 11 # coastguard
---| 12 # lighthouse
---| 13 # fuel
---| 14 # fuel_sell
---| 15 # hospital ship
---| 16 # refuel_plane
---| 17 # ore
---| 18 # ingot
---| 19 # fish
---| 20 # dollar

---@alias SWPositionTypeEnum
---| 0 # fixed
---| 1 # vehicle
---| 2 # object

---@alias SWMarkerTypeEnum
---| 0 # delivery_target
---| 1 # survivor
---| 2 # object
---| 3 # waypoint
---| 4 # tutorial
---| 5 # fire
---| 6 # shark
---| 7 # ice
---| 8 # search_radius
---| 9 # flag_1
---| 10 # flag_2
---| 11 # house
---| 12 # car
---| 13 # plane
---| 14 # tank
---| 15 # heli
---| 16 # ship
---| 17 # boat
---| 18 # attack
---| 19 # defend

---@alias SWNotificationTypeEnum
---| 0 # new_mission
---| 1 # new_mission_critical
---| 2 # failed_mission
---| 3 # failed_mission_critical
---| 4 # complete_mission
---| 5 # network_connect
---| 6 # network_disconnect
---| 7 # network_info
---| 8 # chat_message
---| 9 # rewards
---| 10 # network_info_critical
---| 11 # research_complete

-- Messages player(s) using the in-game chat
---@param name string The display name of the user sending the message
---@param message string The message to send the player(s)
---@param peerID number|nil The peerID of the player you want to message. -1 messages all players. If ignored, it will message all players
function server.announce(name, message, peerID) end

-- Sends a command that can be recieved by addons using the onCustomCommand callback
-- `onCustomCommand` will receive a peer ID of `-1`, with auth and admin both provided as `true`.
---@param message string the message to send, for example, "?prefix command arg1"
function server.command(message) end

-- Displays a notification for player(s) on the right side of the screen.
---@param peerID number The peerID of the player you want to message. -1 messages all players
---@param title string The title of the notification
---@param message string The message you want to send the player(s)
---@param notificationType SWNotificationTypeEnum Changes how the notification looks. Refer to notificationTypes
function server.notify(peerID, title, message, notificationType) end

-- Gets a unique ID to be used with other UI functions. Functions similar to a vehicle ID. A UI id can be used for multiple lines and map objects but each popup with a different text or position must have it's own ID
---@return integer ui_id
function server.getMapID() end

-- Remove any UI type created with this ui_id. If you have drawn multiple lines on the map with one UI id, this command would remove all of them.
---@param peer_id number The peer id of the affected player. -1 affects all players
---@param ui_id integer The unique ui id to be removed
function server.removeMapID(peer_id, ui_id) end

-- Add a map marker for the specified peer(s). x, z represent the worldspace location of the marker, since the map is 2D a y coordinate is not required. If POSITION_TYPE is set to 1 or 2 (vehicle or object) then the marker will track the object/vehicle of object_id/vehicle_id and offset the position by parent_local_x, parent_local_z.
---@param peer_id number The peer id of the affected player. -1 affects all players
---@param ui_id integer The unique ui id to use
---@param position_type SWPositionTypeEnum Defines what type (object/vehicle) the marker should follow. Or if it should not follow anything. If the vehicle/object that object is set to follow cannot be found, this defaults to 0 meaning it becomes static, when the vehicle/object is reloacated, it reverts back to the previous value.
---@param marker_type SWMarkerTypeEnum The type of map object to use. Changes the visible icon on the map
---@param x number Refer to World Space. Overrides parent_local_x
---@param z number Refer to World Space. Overrrides parent_local_z
---@param parent_local_x number The x offset relative to the parent. Refer to World Space
---@param parent_local_z number The y offset relative to the parent. Refer to World Space
---@param vehicle_id number The vehicle to follow if POSITION_TYPE is set to 1. Set to 0 to ignore
---@param object_id number The object to follow if POSITION_TYPE is set to 2. Set to 0 to ignore
---@param label string The text that appears when mousing over the icon. Appears like a title
---@param radius number The radius of the red dashed circle. Only applies if MARKER_TYPE = 8
---@param hover_label string The text that appears when mousing over the icon. Appears like a subtitle or description
---@param r number? the amount of red, range is 0-255
---@param g number? the amount of green, range is 0-255
---@param b number? the amount of blue, range is 0-255
---@param a number? the alpha of the object, range is 0-255
function server.addMapObject(peer_id, ui_id, position_type, marker_type, x, z, parent_local_x, parent_local_z, vehicle_id, object_id, label, radius, hover_label, r, g, b, a) end

-- Removes the map objects with the specified ui_id for the specified peer(s)
---@param peer_id number The peer id of the affected player. -1 affects all players
---@param ui_id integer The unique ui id to use
function server.removeMapObject(peer_id, ui_id) end

-- Adds a map label for the specified peer(s). Map labels appear under fog of war.
---@param peer_id number The peer id of the affected player. -1 affects all players
---@param ui_id integer The unique ui id to use
---@param LABEL_TYPE SWLabelTypeEnum The type of label to use. Changes the visible icon on the map
---@param name string The text that appears on the label
---@param x number Refer to World Space
---@param z number Refer to World Space
function server.addMapLabel(peer_id, ui_id, LABEL_TYPE, name, x, z) end

-- Removes a map label with the specified ui_id for the specified peer(s)
---@param peer_id number The peer id of the affected player. -1 affects all players
---@param ui_id integer The ui id to use
function server.removeMapLabel(peer_id, ui_id) end

-- Adds a map line between two world space matrices with the specified ui_id for the specified pee(s). Custom colour defaults to red.
---@param peer_id number The peer id of the affected player. -1 affects all players
---@param ui_id integer The ui id to use
---@param start_matrix SWMatrix Line start position. worldspace
---@param end_matrix SWMatrix Line stop position
---@param width number Line width
---@param r number? the amount of red, range is 0-255
---@param g number? the amount of green, range is 0-255
---@param b number? the amount of blue, range is 0-255
---@param a number? the alpha of the line, range is 0-255
function server.addMapLine(peer_id, ui_id, start_matrix, end_matrix, width, r, g, b, a) end

-- Removes a map line with the specified ui_id for the specified peer(s)
---@param peer_id number The peer id of the affected player
---@param ui_id integer The ui id to use
function server.removeMapLine(peer_id, ui_id) end

-- Displays a tooltip-like popup either in the world. If the popup does not exist, it will be created.
---@param peer_id number The peer id of the affected player. -1 affects all players
---@param ui_id integer A unique ui_id to be used with this popup. You cannot re-use ui ids for popups, unless they have the same text and position, then they can be used for multiple players.
---@param name string ? Appears to do nothing. Can be left as an empty string: ""
---@param is_show boolean If the popup is currently being shown
---@param text string The text inside the popup. You can fit 13 characters in a line before it will wrap.
---@param x number X position of the popup. worldspace (if vehicle_parent_id or object_parent_id is specified, this will become a relative position)
---@param y number Y position of the popup. worldspace (if vehicle_parent_id or object_parent_id is specified, this will become a relative position)
---@param z number Z position of the popup. worldspace (if vehicle_parent_id or object_parent_id is specified, this will become a relative position)
---@param render_distance number The distance the popup will be viewable from in meters
---@param vehicle_parent_id number? (optional) The vehicle to attach the popup to
---@param object_parent_id number? (optional) The object to attach the popup to
function server.setPopup(peer_id, ui_id, name, is_show, text, x, y, z, render_distance, vehicle_parent_id, object_parent_id) end

-- Creates a popup that appears on the player's screen, regardless of their look direction and location in the world.
---@param peer_id number The peer id of the affected player. -1 affects all players
---@param ui_id integer A unique ui_id to be used with this popup. You cannot re-use ui ids for popups. One ui id per popup.
---@param name string ?
---@param is_show boolean If the popup is currently being shown
---@param text string The text inside the popup. You can fit 13 characters in a line before it will wrap.
---@param horizontal_offset number The offset on the horizontal axis. Ranges from -1 (left) to 1 (right)
---@param vertical_offset number The offset on the vertical axis. Ranges from -1 (Top) to 1 (Bottom)
function server.setPopupScreen(peer_id, ui_id, name, is_show, text, horizontal_offset, vertical_offset) end

-- Will remove popups that have been assigned to a player
---@param peer_id number The peer id of the affected player. -1 affects all players
---@param ui_id integer The unique ui id to use
function server.removePopup(peer_id, ui_id) end

-------------------
-- Objects
-------------------

---@class SWPlayer
---@field id number The peer ID of the player (as seen in the server player list)
---@field name string The name of the player
---@field admin boolean Whether the player is an admin
---@field auth boolean Whether the player has auth
---@field steam_id number The player's Steam ID (convert to string as soon as possible to prevent loss of data)
---@field object_id number The player's character's object ID. Note that this isnt in the in-game documentation for some reason

---@class SWObjectData object here is interchangable with "character"
---@field object_type SWObjectTypeEnum the object's type.
---@field hp number The objects's health points
---@field incapacitated boolean Whether the object is incapacitated
---@field dead boolean Whether the object is dead
---@field interactible boolean Whether the object is interactible
---@field ai boolean Whether the object is AI or not
---@field name string the name of the object
---@field creature_type SWCreatureTypeEnum the creature type of the object
---@field scale number the scale of the object.

-- Returns all players within the server.
-- Note that the table is not guaranteed to be in a sequential order.
-- Therefore, do not use `ipairs` or a `for i` loop to iterate through the table.
-- Use `pairs` instead.
---@return table<number, SWPlayer> players
function server.getPlayers() end

-- Returns the display name of the player
---@param peer_id number The peer id of the player
---@return string name, boolean is_success
function server.getPlayerName(peer_id) end

-- Returns the position of the requested player as a matrix
---@param peer_id number The peer id of the player
---@return SWMatrix matrix, boolean is_success
function server.getPlayerPos(peer_id) end

-- Moves the player from their current location to the matrix provided
---@param peer_id number The peer id of the player
---@param matrix SWMatrix The matrix that should be applied to the player
---@return boolean is_success
function server.setPlayerPos(peer_id, matrix) end

-- This can only be called after a user has been in the server for a few seconds. Returns the direction the player is looking in. A player sitting in a seat will have their look direction reported relative to the seat. If the seat is upside down, looking "up" is down relative to the world. math.atan(x,z) will return the heading the player is facing.
---@param peer_id number The peer id of the player
---@return number x, number y, number z, boolean is_success
function server.getPlayerLookDirection(peer_id) end

-- Returns the id of the player's character
---@param peer_id number The peer id of the player
---@return number object_id, boolean is_success
function server.getPlayerCharacterID(peer_id) end

-- Spawns an object at the specified matrix
---@param matrix SWMatrix The matrix that the object should be spawned at
---@param object_type SWObjectTypeEnum The object to spawn
---@return number object_id, boolean is_success
function server.spawnObject(matrix, object_type) end

-- Spawns a fire at the given matrix. Can spawn explosions
---@param matrix SWMatrix The matrix the fire will be spawned at
---@param size number The size of the fire (0-10)
---@param magnitude number -1 explodes instantly. Nearer to 0 means the explosion takes longer to happen. Must be below 0 for explosions to work.
---@param is_lit boolean Lights the fire. If the magnitude is >1, this will need to be true for the fire to first warm up before exploding.
---@param is_explosive boolean If the fire is explosive
---@param parent_vehicle_id number Can be 0 or nil. When given a vehicle id, the fire will follow the given vehicle.
---@param explosion_magnitude number The size of the explosion (0-5)
---@return number object_id, boolean is_success
function server.spawnFire(matrix, size, magnitude, is_lit, is_explosive, parent_vehicle_id, explosion_magnitude) end

-- Spawns an NPC.
---@param matrix SWMatrix The matrix the character will be spawned at
---@param outfit_id SWOutfitTypeEnum If is_interactable is false, outfit_id is the name that shows up when looking at the NPC . This is the only place to give the character a name.
---@return number object_id, boolean is_success
function server.spawnCharacter(matrix, outfit_id) end

-- Spawns an animal (whale, shark, kraken.)
---@param matrix SWMatrix The matrix the animal will be spawned at
---@param animal_type SWAnimalTypeEnum The animal type to spawn
---@param size_multiplier number The scale multiplier of the animal
---@return number object_id, boolean is_success
function server.spawnAnimal(matrix, animal_type, size_multiplier) end

-- Requires Industrial Frontier DLC, Spawns a specified creature.
---@param matrix SWMatrix The matrix the creature will be spawned at
---@param creature_type SWCreatureTypeEnum the creature type to spawn
---@param size_multiplier number the scale multiplier of the animal
---@return number object_id the object_id of the spawned creature
---@return boolean is_success if the creature was successfully spawned
function server.spawnCreature(matrix, creature_type, size_multiplier) end

-- Requires Industrial Frontier DLC, sets the next target matrix for the creature to path to.
---@param object_id number the object_id of the creature that will be pathing to the matrix
---@param matrix SWMatrix The matrix the creature will path to
---@return boolean is_success if the creatures next path was successfully set
function server.setCreatureMoveTarget(object_id, matrix) end

-- Spawns a dropped equipment item at the specified matrix, with the ability to set some settings of the item
---@param matrix SWMatrix the matrix to spawn the equipment at
---@param EQUIPMENT_ID SWEquipmentTypeEnum the equipment type to spawn
---@param int integer for setting the int data for this object.
---@param float number for setting the float data for this object, such as charge level, ammo, etc.
---@return number object_id the object_id of the spawned equipment
---@return boolean is_success true if the equipment was successsfully spawned, false if it failed.
function server.spawnEquipment(matrix, EQUIPMENT_ID, int, float) end

-- Despawns objects. Can be used on characters and animals.
---@param object_id number The unique id of the object/character/animal to be despawned
---@param is_instant boolean If the object should be despawned instantly (true) or when no one is near (false)
---@return boolean is_success
function server.despawnObject(object_id, is_instant) end

-- Get the positon of an object/character/animal
---@param object_id number The unique id of the object/character/animal
---@return SWMatrix matrix, boolean is_success
function server.getObjectPos(object_id) end

-- Get the simulating state of a specified object
---@param object_id number The unique id of the object/character/animal
---@return boolean is_simulating, boolean is_success
function server.getObjectSimulating(object_id) end

-- Sets the position of an object/character/animal
---@param object_id number The unique id of the object/character/animal
---@param matrix SWMatrix The matrix to be applied to the object/character/animal
---@return boolean is_success
function server.setObjectPos(object_id, matrix) end


-- Sets the parameters for a fire
---@param object_id number The unique id of the fire
---@param is_lit boolean If the fire is ignited
---@param is_explosive boolean If the fire is explosive
function server.setFireData(object_id, is_lit, is_explosive) end

-- Returns the is_lit parameter of a fire
---@param object_id number The unique id of the fire
---@return boolean is_lit, boolean is_success
function server.getFireData(object_id) end

-- Kills the given character
---@param object_id number The unique object_id of the character you want to kill
function server.killCharacter(object_id) end

-- Revives the given character
---@param object_id number The unique object_id of the character you want to revive
function server.reviveCharacter(object_id) end

-- Makes the provided object (character, creature, etc) sit in the first seat found that has a matching name or matching voxel position to that which is provided. Can seat player characters
---@overload fun(object_id: number, vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param object_id number The unique object_id of the character you want to seat
---@param vehicle_id number The vehicle that the seat is a part of
---@param seat_name string The name of the seat of which you want to set the character seated in.
function server.setSeated(object_id, vehicle_id, seat_name) end

server.setCharacterSeated = server.setSeated
server.setCreatureSeated = server.setSeated

-- Get object/character data of the specified object_id
---@param object_id number The unique object_id of the character you want to get data on
---@return SWObjectData character_data SWCharacterData if success, nil if failed.
function server.getObjectData(object_id) end

server.getCharacterData = server.getObjectData

-- Get the current vehicle_id for a specified character object
---@param object_id number The unique id of the character
---@return number vehicle_id, boolean is_success
function server.getCharacterVehicle(object_id) end

-- Sets the various parameters of a character
---@param object_id number The unique id of the character/object/animal to be affected
---@param hp number Value from 0 to 100. Has no effect on objects. Value will still be saved regardless. While is_interactable is false, hp can be any value.
---@param is_interactable boolean If this is false you cannot pickup or ask the character to follow. Their name will be outfit_id which can't be set here (must be set at spawnCharacter)
---@param is_ai boolean lets the character do seat controls
function server.setCharacterData(object_id, hp, is_interactable, is_ai) end

-- Sets the character's/creature's tooltip
-- Put after the character's "Pickup" and "Follow" tooltips without a line break.
-- Doesn't support setting a player's tooltip
---@param object_id integer the character's object_id which you want to set the tooltip of
---@param display_name string the tooltip to put after the game's default tooltips, such as the game's Hold [key1][key2] to pickup tooltips
function server.setCharacterTooltip(object_id, display_name) end

server.setCreatureTooltip = server.setCharacterTooltip

-- Set the equipment a character has
---@param object_id number The unique id of the character
---@param slot SWSlotNumberEnum The slot to put the equipment in
---@param equipment_id SWEquipmentTypeEnum The equipment to put in the slot
---@param is_active boolean Activates equipment such as strobe lights and fire exstinguishers.
---@param integer_value number|nil Depending on the item, sets the integer value (charges, ammo, channel, etc.)
---@param float_value number|nil Depending on the item, sets the float value (ammo, battery, etc.)
---@return boolean is_success
function server.setCharacterItem(object_id, slot, equipment_id, is_active, integer_value, float_value) end

-- Returns the id of the equipment that the character has in the provided slot
---@param object_id number The unique id of the character to check
---@param slot_number SWSlotNumberEnum number
---@return SWEquipmentTypeEnum equipment_id, boolean is_success
function server.getCharacterItem(object_id, slot_number) end

---@alias SWOutfitTypeEnum
---| 0 # none
---| 1 # worker
---| 2 # fishing
---| 3 # waiter
---| 4 # swimsuit
---| 5 # military
---| 6 # office
---| 7 # police
---| 8 # science
---| 9 # medical
---| 10 # wetsuit
---| 11 # civilian

---@alias SWAnimalTypeEnum
---| 0 # shark
---| 1 # whale
---| 4 # kraken

---@alias SWCreatureTypeEnum
---| 0 # badger_common
---| 1 # bear_grizzly
---| 2 # bear_black
---| 3 # bear_polar
---| 4 # chicken_barnevelder
---| 5 # chicken_marans
---| 6 # chicken_orpington_fowl
---| 7 # chicken_sussex_fowl
---| 8 # cow_angus
---| 9 # cow_hereford
---| 10 # cow_highland
---| 11 # cow_holstein
---| 12 # sasquatch
---| 13 # yeti
---| 14 # deer_red_f
---| 15 # deer_red_m
---| 16 # deer_sika_f
---| 17 # deer_sika_m
---| 18 # dog_beagle
---| 19 # dog_border_collie
---| 20 # dog_boxer
---| 21 # dog_corgi
---| 22 # dog_dachschund
---| 23 # dog_dalmatian
---| 24 # dog_dobermann
---| 25 # dog_german_shepherd
---| 26 # dog_greyhound
---| 27 # dog_jack_russell
---| 28 # dog_labrador
---| 29 # dog_newfoundland
---| 30 # dog_pug
---| 31 # dog_shiba
---| 32 # dog_siberian_husky
---| 33 # dog_st_bernard
---| 34 # dog_vizsla
---| 35 # dog_yorkshire_terrier
---| 36 # fox_red
---| 37 # fox_arctic
---| 38 # goat_alpine
---| 39 # goat_bengal
---| 40 # goat_oberhasli
---| 41 # goat_saanen
---| 42 # hare_arctic
---| 43 # hare_irish
---| 44 # hare_mountain
---| 45 # horse_clydesdale
---| 46 # horse_friesian
---| 47 # horse_haflinger
---| 48 # horse_welara
---| 49 # muntjac_f
---| 50 # muntjac_m
---| 51 # penguin_gentoo
---| 52 # pig_angeln_saddleback
---| 53 # pig_old_spot
---| 54 # pig_tamworth
---| 55 # pig_yorkshire
---| 56 # seal_polar
---| 57 # sheep_black_nose
---| 58 # sheep_highlander
---| 59 # sheep_mule
---| 60 # wildcat_scottish
---| 61 # wolf_arctic
---| 62 # wolf_costal
---| 63 # wolf_plains
---| 64 # zombie_male
---| 65 # zombie_male_a
---| 66 # zombie_male_b
---| 67 # zombie_male_c
---| 68 # zombie_male_d
---| 69 # zombie_male_e
---| 70 # zombie_male_f
---| 71 # zombie_male_g
---| 72 # zombie_male_nurse
---| 73 # zombie_male_arctic
---| 74 # zombie_male_firefighter
---| 75 # zombie_male_pilot
---| 76 # zombie_male_police
---| 77 # zombie_male_ranger
---| 78 # zombie_male_scuba
---| 79 # zombie_male_tree_surgeon
---| 80 # zombie_female
---| 81 # zombie_female_a
---| 82 # zombie_female_b
---| 83 # zombie_female_c
---| 84 # zombie_female_d
---| 85 # zombie_female_e
---| 86 # zombie_female_f
---| 87 # zombie_female_arctic
---| 88 # zombie_female_firefighter
---| 89 # zombie_female_hazmat
---| 90 # zombie_female_pilot
---| 91 # zombie_female_pirate
---| 92 # zombie_female_police
---| 93 # zombie_female_safari
---| 94 # zombie_female_sar
---| 95 # zombie_female_scuba
---| 96 # zombie_female_surgeon
---| 97 # buffalo
---| 98 # sheep_bighorn
---| 99 # roadrunner
---| 100 # lion_mountain
---| 101 # crocodile
---| 102 # coyote
---| 103 # gila_monster
---| 104 # tortise_desert

---@alias SWSlotNumberEnum
---| 1 # Large_Equipment_Slot
---| 2 # Small_Equipment_Slot
---| 3 # Small_Equipment_Slot
---| 4 # Small_Equipment_Slot
---| 5 # Small_Equipment_Slot
---| 6 # Small_Equipment_Slot
---| 7 # Small_Equipment_Slot
---| 8 # Small_Equipment_Slot
---| 9 # Small_Equipment_Slot
---| 10 # Outfit_Slot

---@alias SWEquipmentTypeEnum
---| 0 # none
---| 1 # diving
---| 2 # firefighter
---| 3 # scuba
---| 4 # parachute [int = {0 = deployed, 1 = ready}]
---| 5 # arctic
---| 6 # binoculars
---| 7 # cable
---| 8 # compass
---| 9 # defibrillator [int = charges]
---| 10 # fire_extinguisher [float = ammo]
---| 11 # first_aid [int = charges]
---| 12 # flare [int = charges]
---| 13 # flaregun [int = ammo]
---| 14 # flaregun_ammo [int = ammo]
---| 15 # flashlight [float = battery]
---| 16 # hose [int = {0 = hose off, 1 = hose on}]
---| 17 # night_vision_binoculars [float = battery]
---| 18 # oxygen_mask [float = oxygen]
---| 19 # radio [int = channel] [float = battery]
---| 20 # radio_signal_locator [float = battery]
---| 21 # remote_control [int = channel] [float = battery]
---| 22 # rope
---| 23 # strobe_light [int = {0 = off, 1 = on}] [float = battery]
---| 24 # strobe_light_infrared [int = {0 = off, 1 = on}] [float = battery]
---| 25 # transponder [int = {0 = off, 1 = on}] [float = battery]
---| 26 # underwater_welding_torch [float = charge]
---| 27 # welding_torch [float = charge]
---| 28 # coal
---| 29 # hazmat
---| 30 # radiation_detector [float = battery]
---| 31 # c4 [int = ammo]
---| 32 # c4_detonator
---| 33 # speargun [int = ammo]
---| 34 # speargun_ammo
---| 35 # pistol [int = ammo]
---| 36 # pistol_ammo
---| 37 # smg [int = ammo]
---| 38 # smg_ammo
---| 39 # rifle [int = ammo]
---| 40 # rifle_ammo
---| 41 # grenade [int = ammo]
---| 42 # machine_gun_ammo_box_k
---| 43 # machine_gun_ammo_box_he
---| 44 # machine_gun_ammo_box_he_frag
---| 45 # machine_gun_ammo_box_ap
---| 46 # machine_gun_ammo_box_i
---| 47 # light_auto_ammo_box_k
---| 48 # light_auto_ammo_box_he
---| 49 # light_auto_ammo_box_he_frag
---| 50 # light_auto_ammo_box_ap
---| 51 # light_auto_ammo_box_i
---| 52 # rotary_auto_ammo_box_k
---| 53 # rotary_auto_ammo_box_he
---| 54 # rotary_auto_ammo_box_he_frag
---| 55 # rotary_auto_ammo_box_ap
---| 56 # rotary_auto_ammo_box_i
---| 57 # heavy_auto_ammo_box_k
---| 58 # heavy_auto_ammo_box_he
---| 59 # heavy_auto_ammo_box_he_frag
---| 60 # heavy_auto_ammo_box_ap
---| 61 # heavy_auto_ammo_box_i
---| 62 # battle_shell_k
---| 63 # battle_shell_he
---| 64 # battle_shell_he_frag
---| 65 # battle_shell_ap
---| 66 # battle_shell_i
---| 67 # artillery_shell_k
---| 68 # artillery_shell_he
---| 69 # artillery_shell_he_frag
---| 70 # artillery_shell_ap
---| 71 # artillery_shell_i
---| 72 # glowstick
---| 73 # dog_whistle
---| 74 # bomb_disposal
---| 75 # chest_rig
---| 76 # black_hawk_vest
---| 77 # plate_vest
---| 78 # armor_vest
---| 79 # space_suit
---| 80 # exploration_space_suit
---| 81 # fishing rod
---| 82 # anchovie [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 83 # anglerfish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 84 # arctic_char [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 85 # ballan_lizardfish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 86 # ballan_wrasse [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 87 # barreleye_fish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 88 # black_Bream [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 89 # black_dragonfish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 90 # clown_fish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 91 # cod [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 92 # dolphinfish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 93 # gulper_eel [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 94 # haddock [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 95 # hake [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 96 # herring [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 97 # john_dory [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 98 # labrus [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 99 # lanternfish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 100 # mackerel [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 101 # midshipman [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 102 # perch [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 103 # pike [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 104 # pinecone_fish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 105 # pollack [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 106 # red_mullet [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 107 # rockfish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 108 # sablefish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 109 # salmon [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 110 # sardine [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 111 # scad [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 112 # sea_bream [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 113 # sea_halibut [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 114 # sea_piranha [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 115 # seabass [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 116 # slimehead [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 117 # snapper [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 118 # snapper_gold [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 119 # snook [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 120 # spadefish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 121 # trout [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 122 # tubeshoulders_fish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 123 # viperfish [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 124 # yellowfin_tuna [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 125 # blue_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 126 # brown_box_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 127 # coconut_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 128 # dungeness_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 129 # furry_lobster [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 130 # homarus_americanus [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 131 # homarus_gammarus [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 132 # horseshoe_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 133 # jasus_edwardsii [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 134 # jasus_lalandii [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 135 # jonah_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 136 # king_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 137 # mud_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 138 # munida_lobster [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 139 # ornate_rock_lobster [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 140 # panulirus_interruptus [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 141 # red_king_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 142 # reef_lobster [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 143 # slipper_lobster [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 144 # snow_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 145 # southern_rock_lobster [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 146 # spider_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 147 # spiny_lobster [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 148 # stone_crab [int = fish {0 = idle, 1 = flee, 2 = flop, 3 = dead}]
---| 149 # firefighter_scba

-------------------
-- Vehicles
-------------------

---@class SWVoxelPos the voxel position of the component (as set in the editor, is not updated with its current position in game)
---@field x number voxel_x position
---@field y number voxel_y position
---@field z number voxel_z position

---@class SWVehicleSignData
---@field name string the name of the sign
---@field pos SWVoxelPos the voxel position of the sign

---@class SWVehicleSeatData
---@field name string the name of the seat
---@field pos SWVoxelPos the voxel position of the seat
---@field seated_id integer the character id of who is in the seat
---@field seated_peer_id integer the peer id of the player sitting in the seat, if any

---@class SWVehicleButtonData
---@field name string the name of the button
---@field pos SWVoxelPos the voxel position of the button
---@field on boolean is the button on or off

---@class SWVehicleDialData
---@field name string the name of the dial
---@field pos SWVoxelPos the voxel position of the dial
---@field value number the first value of the dial
---@field value2 number the second value of the dial (eg: Guage Display)

---@class SWVehicleTankData
---@field name string the name of the tank
---@field pos SWVoxelPos the voxel position of the tank
---@field value number total amount of fluid in the tank
---@field values table<SWTankFluidTypeEnum, number> a table indexed by the fluid id, with the value being the amount of that fluid inside this fluid tank
---@field capacity number total capacity of the tank
---@field fluid_type SWTankFluidTypeEnum as set in the tank's properties.

---@class SWVehicleBatteryData
---@field name string the name of the battery
---@field pos SWVoxelPos the voxel position of the battery
---@field charge number current charge

---@class SWVehicleHopperData
---@field name string the name of the hopper
---@field pos SWVoxelPos the voxel position of the hopper
---@field values table<SWResourceTypeEnum, number> a table indexed by the resource id, with the value being the amount of that resource inside this hopper
---@field capacity number total capacity of the hopper

---@class SWVehicleWeaponData
---@field name string the name of the weapon/ammo container
---@field pos SWVoxelPos the voxel position of the weapon/ammo container
---@field ammo number the amount of ammo in the weapon/ammo container
---@field capacity number total capacity of the weapon/ammo container

---@class SWVehicleRopeHookData
---@field name string the name of the rope anchor
---@field pos SWVoxelPos the voxel position of the rope anchor

---@class SWVehicleComponents
---@field signs table<integer, SWVehicleSignData>
---@field seats table<integer, SWVehicleSeatData>
---@field buttons table<integer, SWVehicleButtonData>
---@field dials table<integer, SWVehicleDialData>
---@field tanks table<integer, SWVehicleTankData>
---@field batteries table<integer, SWVehicleBatteryData>
---@field hoppers table<integer, SWVehicleHopperData>
---@field guns table<integer, SWVehicleWeaponData>
---@field rope_hooks table<integer, SWVehicleRopeHookData>

---@class SWLoadedVehicleData
---@field components SWVehicleComponents The components of this vehicle
---@field mass number The mass of the vehicle
---@field voxels number The voxel count of the vehicle
---@field characters table<integer, integer> The IDs of characters sitting in this vehicle

---@class SWVehicleAuthor
---@field name string The name of the author
---@field steam_id string The Steam ID of the author

---@class SWVehicleData
---@field name string The name of the vehicle
---@field tags_full string The tags as a string (ex. "tag1,tag2,tag3")
---@field tags table<number, string> The tags of the vehicle
---@field group_id integer The ID of the group this vehicle belongs to
---@field transform SWMatrix The position of the vehicle
---@field simulating boolean Whether the vehicle is simulating (loaded) or not
---@field editable boolean Is the vehicle editable at workbenches
---@field invulnerable boolean Is the vehicle invulnerable
---@field static boolean Is the vehicle static
---@field authors table<integer, SWVehicleAuthor> The authors of the vehicle

---@alias SWRopeTypeEnum
---| 0 # rope
---| 1 # hose
---| 2 # electric_cable
---| 4 # suspension_cable
---| 6 # fishing_line

-- Spawns a vehicle that is in an addon
---@param matrix SWMatrix The matrix the vehicle should be spawned at
---@param addon_index number The index of the addon as it is found in the missions folder. There is no set order and it may not be the same next execution.
---@param component_id number NOT THE COMPONENT_INDEX. The component_id can be found using getLocationComponentData
---@return number primary_vehicle_id, boolean is_success, table<integer, integer> vehicle_ids, number group_id
function server.spawnAddonVehicle(matrix, addon_index, component_id) end

-- Spawns a vehicle from your vehicle save folder. NOTE: will spawn an "empty" vehicle if a vehicle file cannot be found. It is impossible to distinguish from an actual vehicle server-wise.
---@param matrix SWMatrix The matrix the vehicle should be spawned at
---@param save_name string The name of the save file to spawn
---@return number primary_vehicle_id, boolean is_success, table<integer, integer> vehicle_ids, number group_id
function server.spawnVehicle(matrix, save_name) end

---@deprecated
server.spawnVehicleSavefile = server.spawnVehicle

-- Despawns a vehicle from the world
---@param vehicle_id number The unique id of the vehicle
---@param is_instant boolean If the vehicle should be despawned instantly (true) or when no one is near (false)
---@return boolean is_success
function server.despawnVehicle(vehicle_id, is_instant) end

-- Returns if a location is clear of vehicles or not
---@param transform_matrix SWMatrix The position of the location to check
---@param size_x number The X size of the area to check
---@param size_y number The Y size of the area to check
---@param size_z number The Z size of the area to check
---@return boolean is_clear
function server.isLocationClear(transform_matrix, size_x, size_y, size_z) end

-- Returns the position of the vehicle as a matrix, If the specified voxel is part of a sub-body, it will properly apply the previous' sub-body positions (As of v1.8.5)
---@param vehicle_id number The unique id of the vehicle
---@param voxel_x number? 0 is the center of the vehicle (viewable with the move tool). Each "block" or 0.25m is a different voxel. 0.25 is one block right of the start point.
---@param voxel_y number? 0 is the center of the vehicle (viewable with the move tool). Each "block" or 0.25m is a different voxel. 0.25 is one block above the start point.
---@param voxel_z number? 0 is the center of the vehicle (viewable with the move tool). Each "block" or 0.25m is a different voxel. 0.25 is one block forwards of the start point.
---@return SWMatrix matrix, boolean is_success
function server.getVehiclePos(vehicle_id, voxel_x, voxel_y, voxel_z) end

-- Teleports a vehicle from it's current locaiton to the new matrix
---@param vehicle_id number The unique id of the vehicle
---@param matrix SWMatrix The matrix to be applied to the vehicle
function server.setVehiclePos(vehicle_id, matrix) end

-- Teleports a vehicle from it's current locaiton to the new matrix. The vehicle is displaced by other vehicles at the arrival point
---@param vehicle_id number The unique id of the vehicle
---@param matrix SWMatrix The matrix to be applied to the vehicle
---@return boolean is_success, SWMatrix result_matrix
function server.setVehiclePosSafe(vehicle_id, matrix) end

-- Reloads the vehicle as if spawning from a workbench - refreshing damage and inventories etc.
---@param vehicle_id number The unique id of the vehicle
function server.resetVehicleState(vehicle_id) end

-- Removes all vehicles from the world
function server.cleanVehicles() end

-- Cleans up fallout zones
function server.clearRadiation() end

-- Returns a vehicle's data
---@param vehicle_id number The unique id of the vehicle
---@return SWVehicleData vehicle_data, boolean is_success
function server.getVehicleData(vehicle_id) end

-- Returns all vehicles with a matching name
---@param name string The name to query
---@return table<integer, number> vehicle_ids, boolean is_success
function server.getVehiclesByName(name) end

-- Returns a vehicle's components
---@param vehicle_id number The unique id of the vehicle
---@return SWLoadedVehicleData vehicle_components, boolean is_success
function server.getVehicleComponents(vehicle_id) end

-- Returns a table of vehicle IDs that belong to the specified group
---@param group_id number The unique id of the group
---@return table<integer, integer> vehicle_ids, boolean is_success
function server.getVehicleGroup(group_id) end

-- Despawns all vehicles belonging to the specified group
---@param group_id number The unique id of the group
---@param is_instant boolean If the group should be despawned instantly (true) or when no one is near (false)
---@return boolean is_success
function server.despawnVehicleGroup(group_id, is_instant) end

-- Teleports a group
---@param group_id number The unique id of the group
---@param transform_matrix SWMatrix The position to teleport the group to
---@return boolean is_success
function server.setGroupPos(group_id, transform_matrix) end

-- Move a group. Doesn't unload then load the group vehicles
---@param group_id number The unique id of the group
---@param transform_matrix SWMatrix The position to move the group to
---@return boolean is_success
function server.moveGroup(group_id, transform_matrix) end

-- Moves a group, displacing the target position if a vehicle is blocking the destination
---@param group_id number The unique id of the group
---@param transform_matrix SWMatrix The position to move the group to
---@return boolean is_success, SWMatrix result_matrix
function server.moveGroupSafe(group_id, transform_matrix) end

-- Move a vehicle. Doesn't unload then load the vehicle
---@param vehicle_id number The unique id of the vehicle
---@param transform_matrix SWMatrix The position to move the vehicle to
---@return boolean is_success
function server.moveVehicle(vehicle_id, transform_matrix) end

-- Moves a vehicle, displacing the target position if a vehicle is blocking the destination
---@param vehicle_id number The unique id of the vehicle
---@param transform_matrix SWMatrix The position to move the vehicle to
---@return boolean is_success, SWMatrix result_matrix
function server.moveVehicleSafe(vehicle_id, transform_matrix) end

-- Teleports a group, displacing the target position if a vehicle is blocking the destination
---@param group_id number The unique id of the group
---@param transform_matrix SWMatrix The position to teleport the group to
---@return boolean is_success, SWMatrix result_matrix
function server.setGroupPosSafe(group_id, transform_matrix) end

-- Converts a world transform to an astronomy transform. Useful for navigating in space
---@param transform_matrix SWMatrix
---@return SWMatrix
function server.getAstroPos(transform_matrix) end

-- Returns the tank data
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The unique id of the vehicle
---@param tank_name string The name of the fuel tank as it appears on the vehicle. Editable using the select tool in the workbench
---@return SWVehicleTankData data, boolean is_success
function server.getVehicleTank(vehicle_id, tank_name) end

-- Gets a vehicle's sign data
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The unique ID of the vehicle to get the sign on
---@param sign_name string The name of the sign to get
---@return SWVehicleSignData data, boolean is_success
function server.getVehicleSign(vehicle_id, sign_name) end

-- Gets a vehicle's seat data
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The unique ID of the vehicle to get the seat on
---@param seat_name string The name of the seat to get
---@return SWVehicleSeatData data, boolean is_success
function server.getVehicleSeat(vehicle_id, seat_name) end

-- Returns the button data
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The unique id of the vehicle
---@param button_name string The name of the button as it appears on the vehicle. Editable using the select tool in the workbench
---@return SWVehicleButtonData data, boolean is_success
function server.getVehicleButton(vehicle_id, button_name) end

-- Returns the dial data
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The unique id of the vehicle
---@param dial_name string The name of the dial as it appears on the vehicle. Editable using the select tool in the workbench
---@return SWVehicleDialData value, boolean is_success
function server.getVehicleDial(vehicle_id, dial_name) end

-- Returns the battery data
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The unique id of the vehicle
---@param battery_name string The name of the battery as it appears on the vehicle. Editable using the select tool in the workbench
---@return SWVehicleBatteryData data, boolean is_success
function server.getVehicleBattery(vehicle_id, battery_name) end

-- Returns the hopper data
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The vehicle ID to get the hopper from
---@param hopper_name string The name of the hopper to get
---@return SWVehicleHopperData data, boolean is_success
function server.getVehicleHopper(vehicle_id, hopper_name) end

-- Returns the weapon vehicle data
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The unique id of the vehicle
---@param weapon_name string The name of the weapon as it appears on the vehicle. Editable using the select tool in the workbench
---@return SWVehicleWeaponData data, boolean is_success
function server.getVehicleWeapon(vehicle_id, weapon_name) end

-- Returns the vehicle's rope anchor data
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The unique id of the vehicle
---@param name string The name of the rope anchor as it appears on the vehicle. Editable using the select tool in the workbench
---@return SWVehicleRopeHookData data, boolean is_success
function server.getVehicleRopeHook(vehicle_id, name) end

-- Allows direct inputs to a chair from addon Lua
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number, axis_ws: number, axis_da: number, axis_ud: number, axis_rl: number, button_1: boolean, button_2: boolean, button_3: boolean, button_4: boolean, button_5: boolean, button_6: boolean, trigger: boolean)
---@param vehicle_id number The unique id of the vehicle
---@param seat_name string The name of the seat as it apears on the vehicle. Editable using the select tool in the workbench
---@param axis_ws number The W/S axis as it appears on the chair
---@param axis_da number The D/A axis as it appears on the chair
---@param axis_ud number The Up/Down axis as it appears on the chair
---@param axis_rl number The Right/Left axis as it appears on the chair
---@param button_1 boolean The chair button 1 state
---@param button_2 boolean The chair button 2 state
---@param button_3 boolean The chair button 3 state
---@param button_4 boolean The chair button 4 state
---@param button_5 boolean The chair button 5 state
---@param button_6 boolean The chair button 6 state
---@param trigger boolean The chair trigger state
function server.setVehicleSeat(vehicle_id, seat_name, axis_ws, axis_da, axis_ud, axis_rl, button_1, button_2, button_3, button_4, button_5, button_6, trigger) end

-- Presses a button on a vehicle. Warning, can cause massive lag. Also note: Static vehicles can output values even when not powered
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number)
---@param vehicle_id number The unique id of the vehicle
---@param button_name string The name of the button as it appears on the vehicle. Editable using the select tool in the workbench
function server.pressVehicleButton(vehicle_id, button_name) end

-- Sets a keypad's value
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number, value: number)
---@param vehicle_id number The unique id of the vehicle
---@param keypad_name string The name of the keypad as it appears on the vehicle. Editable using the select tool in the workbench
---@param value number The value you want to set the keypad to
function server.setVehicleKeypad(vehicle_id, keypad_name, value) end

-- Fills a fluid tank with the specified liquid
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number, amount: number, fluid_type: SWTankFluidTypeEnum)
---@param vehicle_id number The unique id of the vehicle
---@param tank_name string The name of the tank as it appears on the vehicle. Editable using the select tool in the workbench
---@param amount number The amount you want to fill the tank in litres
---@param fluid_type SWTankFluidTypeEnum The fluid type
function server.setVehicleTank(vehicle_id, tank_name, amount, fluid_type) end

-- Sets the charge level of the battery
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number, amount: number)
---@param vehicle_id number The unique id of the vehicle
---@param battery_name string The name of the battery as it appears on the vehicle. Editable using the select tool in the workbench
---@param amount number The amount you want to fill the battery to
function server.setVehicleBattery(vehicle_id, battery_name, amount) end

-- Sets the number of coal objects inside a hopper
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number, amount: number, RESOURCE_TYPE: SWResourceTypeEnum)
---@param vehicle_id number The vehicle ID to set the hopper on
---@param hopper_name string The name of the hopper to set
---@param amount number The amount to set the hopper to
---@param RESOURCE_TYPE SWResourceTypeEnum The resource type to set inside the hopper
function server.setVehicleHopper(vehicle_id, hopper_name, amount, RESOURCE_TYPE) end

-- Sets the charge level of the weapon
---@overload fun(vehicle_id: number, voxel_x: number, voxel_y: number, voxel_z: number, amount: number)
---@param vehicle_id number The unique id of the vehicle
---@param weapon_name string The name of the weapon as it appears on the vehicle. Editable using the select tool in the workbench
---@param amount number The amount you want to fill the ammo to
function server.setVehicleWeapon(vehicle_id, weapon_name, amount) end

-- Spawns a rope of the specified type between two rope anchors specified on the vehicles at their specified voxel position
---@param vehicle_id_1 number the first vehicle's id
---@param voxel_x_1 number the x position of the first vehicle's rope anchor
---@param voxel_y_1 number the y position of the first vehicle's rope anchor
---@param voxel_z_1 number the z position of the first vehicle's rope anchor
---@param vehicle_id_2 number the second vehicle's id
---@param voxel_x_2 number the x position of the second vehicle's rope anchor
---@param voxel_y_2 number the y position of the second vehicle's rope anchor
---@param voxel_z_2 number the z position of the second vehicle's rope anchor
---@param length number the length of the rope
---@param rope_type SWRopeTypeEnum the type of the rope
function server.spawnVehicleRope(vehicle_id_1, voxel_x_1, voxel_y_1, voxel_z_1, vehicle_id_2, voxel_x_2, voxel_y_2, voxel_z_2, length, rope_type) end

-- Returns the amount of surfaces that are on fire
---@param vehicle_id number The unique id of the vehicle
---@return number surface_count, boolean is_success
function server.getVehicleFireCount(vehicle_id) end

-- Shows the text when looked directly at. Blocks with unique tooltips such as buttons will override this tooltip
-- <br>*Only works on vehicles where "show on map" is off. (needs confirmation)*
-- <br>**Use of `<` or `>` may result in the string not being parsed properly**
---@param vehicle_id number The unique id of the vehicle
---@param text string The text that will appear in the tooltip
---@return boolean is_success
function server.setVehicleTooltip(vehicle_id, text) end

-- Applies impact damage to a vehicle at the specified voxel location
-- <br>Negative values repair the vehicles instead of damaging it
---@param vehicle_id number The ID of the vehicle to apply damage to
---@param amount number The amount of damage to apply (0-100)
---@param voxel_x number The voxel's X position to apply damage to
---@param voxel_y number The voxel's Y position to apply damage to
---@param voxel_z number The voxel's Z position to apply damage to
---@param radius number the radius to apply the damage over, in metres.
---@return boolean is_success
function server.addDamage(vehicle_id, amount, voxel_x, voxel_y, voxel_z, radius) end

-- Returns whether the specified vehicle has finished loading and is simulating.
---@param vehicle_id number The unique id of the vehicle
---@return boolean is_simulating, boolean is_success
function server.getVehicleSimulating(vehicle_id) end

-- Returns whether the specified vehicle is loading, simulating or unloading
---@param vehicle_id number The unique id of the vehicle
---@return string is_local, boolean is_success
function server.getVehicleLocal(vehicle_id) end

-- Will set the vehicle's transponder state. If a transponder does not exist on the vehicle, an invisible one will be created.
---@param vehicle_id number The unique id of the vehicle
---@param is_active boolean Turns the transponder on/off
---@return boolean is_success
function server.setVehicleTransponder(vehicle_id, is_active) end

-- Allows a vehicle to be edited. NOTE: the vehicle will only be editable when next to a workbench. You can see it on the map but cannot teleport or remove it.
---@param vehicle_id number The unique id of the vehicle
---@param is_editable boolean Sets whether or not the vehicle is able to be edited
---@return boolean is_success
function server.setVehicleEditable(vehicle_id, is_editable) end

-- Sets a vehicle to invulnerable
---@param vehicle_id number The unique id of the vehicle
---@param is_invulnerable boolean Sets whether or not the vehicle is immune to damage
---@return boolean is_success
function server.setVehicleInvulnerable(vehicle_id, is_invulnerable) end

-- Sets a vehicle to show on the map
---@param vehicle_id number The ID of the vehicle to show/hide on map
---@param is_show_on_map boolean Whether to show/hide the vehicle on the map
---@return boolean is_success
function server.setVehicleShowOnMap(vehicle_id, is_show_on_map) end

-------------------
-- AI
-------------------

---@class SWTileData
---@field name string The name of the tile (ex. ...)
---@field sea_floor number The depth to the sea floor
---@field cost number The cost of the tile if it's purchaseable
---@field purchased boolean Whether the tile has been purchased

---@class SWPathFindPoint
---@field x number The X coordinate of the pathfinding point
---@field z number The Z coordinate of the pathfinding point

---@class SWTargetData
---@field character number target object id
---@field vehicle number target vehicle id
---@field x number target_x
---@field y number target_y
---@field z number target_z

---@alias SWAITeamEnum
---| 0 # Default
---| 1 # Player Team
---| 2 # Enemy AI
---| 3 # Unoccupied. Can be used as a custom team
---| 4 # Unoccupied. Can be used as a custom team
---| 5 # Unoccupied. Can be used as a custom team
---| 6 # Unoccupied. Can be used as a custom team
---| 7 # Unoccupied. Can be used as a custom team
---| 8 # Unoccupied. Can be used as a custom team
---| 9 # Unoccupied. Can be used as a custom team
---| 10 # Unoccupied. Can be used as a custom team
---| 11 # Unoccupied. Can be used as a custom team
---| 12 # Unoccupied. Can be used as a custom team
---| 13 # Unoccupied. Can be used as a custom team
---| 14 # Unoccupied. Can be used as a custom team
---| 15 # Unoccupied. Can be used as a custom team
---| 16 # Unoccupied. Can be used as a custom team
---| 17 # Unoccupied. Can be used as a custom team
---| 18 # Unoccupied. Can be used as a custom team
---| 19 # Unoccupied. Can be used as a custom team
---| 20 # Unoccupied. Can be used as a custom team
---| 21 # Unoccupied. Can be used as a custom team
---| 22 # Unoccupied. Can be used as a custom team
---| 23 # Unoccupied. Can be used as a custom team
---| 24 # Unoccupied. Can be used as a custom team
---| 25 # Unoccupied. Can be used as a custom team
---| 26 # Unoccupied. Can be used as a custom team
---| 27 # Zombies
---| 28 # Predator Creatures
---| 29 # Prey Creatures

-- Sets the AI state of a character
---@param object_id number The unique id of the character
---@param AI_STATE number **Ship Pilot**: 0 = none, 1 = path to destination<br>**Heli Pilot**: 0 = None, 1 = path to destination, 2 = path to destination (accurate), 3 = gun run<br>**Plane Pilot**: 0 = none, 1 = path to destination, 2 = gun run<br>**Gunner**: 0 = none, 1 = fire at target<br>**Designator**: 0 = none, 1 = aim at target
function server.setAIState(object_id, AI_STATE) end

-- Sets the target destination for the AI
---@param object_id number The unique id of the character
---@param matrix_destination SWMatrix|nil The matrix that the AI will try to reach, set nil to clear its target
function server.setAITarget(object_id, matrix_destination) end

-- Gets the target destination for an AI
---@param object_id number The unique ID of the character object ID
---@return SWTargetData|nil data the data of the AI target, returns nil if fails.
function server.getAITarget(object_id) end

-- Sets the target charcter for an AI. Different AIs use this data for their unique tasks
---@param object_id number The unique id of the character
---@param target_object_id number|nil target object_id to go target, set nil to clear its target
function server.setAITargetCharacter(object_id, target_object_id) end

-- Sets the target vehicle for an AI. Different AIs use this data for their unique tasks
---@param object_id number The unique id of the character
---@param target_vehicle_id number|nil target vehicle id to go target, set nil to clear its target
function server.setAITargetVehicle(object_id, target_vehicle_id) end

-- Sets the team of a character. Team cannot be lower than 0 or higher than 29
-- Teams: 0 = Default, 29 = Prey Creatures, 28 = Predator Creatures, 27 = Zombies, 1 = Player Team, 2 = Enemy AI
---@param object_id integer The unique id of the character
---@param team SWAITeamEnum The team to set the character to
function server.setAICharacterTeam(object_id, team) end

-- Sets the team of a vehicle. Team cannot be lower than 0 or higher than 29
-- Teams: 0 = Default, 29 = Prey Creatures, 28 = Predator Creatures, 27 = Zombies, 1 = Player Team, 2 = Enemy AI
---@param vehicle_id integer The unique id of the vehicle
---@param team SWAITeamEnum The team to set the vehicle to
function server.setAIVehicleTeam(vehicle_id, team) end

-- Sets if a character should target the provided team
---@param object_id integer The unique id of the character
---@param team SWAITeamEnum The team to set the character to target
---@param is_target boolean Whether the character should target the team or not
function server.setAICharacterTargetTeam(object_id, team, is_target) end

-------------------
-- Game
-------------------

---@class SWGameSettings
---@field photo_mode boolean
---@field map_show_players boolean
---@field sharks boolean
---@field infinite_fuel boolean
---@field lightning boolean
---@field show_name_plates boolean
---@field override_weather boolean
---@field megalodon boolean
---@field infinite_money boolean
---@field day_length number
---@field fast_travel boolean
---@field cleanup_vehicle boolean
---@field settings_menu boolean
---@field settings_menu_lock boolean
---@field rogue_mode boolean
---@field ceasefire boolean
---@field vehicle_damage boolean
---@field vehicle_spawning boolean
---@field engine_overheating boolean
---@field third_person_vehicle boolean
---@field infinite_ammo boolean
---@field no_clip boolean
---@field unlock_all_components boolean
---@field player_damage boolean
---@field map_show_vehicles boolean
---@field despawn_on_leave boolean
---@field third_person boolean
---@field infinite_batteries boolean
---@field teleport_vehicle boolean
---@field clear_fow boolean
---@field npc_damage boolean
---@field show_3d_waypoints boolean
---@field map_teleport boolean
---@field respawning boolean
---@field unlock_all_islands boolean

---@class SWVolcano
---@field x number
---@field y number
---@field z number
---@field tile_x number
---@field tile_y number

---@class SWTime
---@field hour             number
---@field minute           number
---@field daylight_factor  number  modday factor 0->1
---@field percent          number  day cycle percent 0->1

---@class SWWeather
---@field fog number  0->1
---@field rain number 0->1
---@field snow number 0->1
---@field wind number 0->1
---@field temp number 0->1

---@class SWStartTile
---@field name string tile name
---@field x number tile x
---@field y number tile y
---@field z number tile z

---@alias SWAudioMoodEnum
---| 0 # none (cannot be set)
---| 1 # main_menu (cannot be set)
---| 2 # mood_normal
---| 3 # mood_mission_mid
---| 4 # mood_mission_high

---@class SWOilDepositData
---@field x number the x position of the oil deposit in world space
---@field y number the y position of the oil deposit in world space
---@field z number the z position of the oil deposit in world space
---@field r number the radius of the oil deposit
---@field oil number the amount of oil contained in this oil deposit

---@class SWFishData
---@field name string the name of the fish
---@field price number the price of the fish
---@field resource_type SWResourceTypeEnum the resource type of the fish
---@field equipment_type SWEquipmentTypeEnum the equipment type of the fish
---@field is_net_catchable boolean true if the fish is catchable via fish nets

---@class SWFishHotSpotData
---@field x number the x position of the fish hotspot in world space
---@field y number the y position of the fish hotspot in world space
---@field z number the z position of the fish hotspot in world space
---@field resource_type SWResourceTypeEnum the resource type of the fish hotspot
---@field r number the radius of the fish hotspot

-- Get fish data
---@return table<SWResourceTypeEnum, SWFishData>
function server.getFishData() end

-- Get fish hotspot data
---@return table<integer, SWFishHotSpotData>
function server.getFishHotspots() end

-- Spawns a tsunami
---@param transform_matrix SWMatrix
---@param magnitude number magnitude 0->1
---@return boolean is_success
function server.spawnTsunami(transform_matrix, magnitude) end

-- Spawns a whirlpool
---@param transform_matrix SWMatrix
---@param magnitude number magnitude 0->1
---@return boolean is_success
function server.spawnWhirlpool(transform_matrix, magnitude) end

-- Cancels the current gerstner wave even (tsunami or whirlpool)
function server.cancelGerstner() end

-- Spawns a tornado
---@param transform_matrix SWMatrix
---@return boolean is_success
function server.spawnTornado(transform_matrix) end

-- Spawns a meteor
---@param transform_matrix SWMatrix
---@param magnitude number magnitude 0->1
---@param is_spawn_tsunami boolean
---@return boolean is_success
function server.spawnMeteor(transform_matrix, magnitude, is_spawn_tsunami) end

-- Spawns a meteor shower
---@param transform_matrix SWMatrix
---@param magnitude number magnitude 0->1
---@param is_spawn_tsunami boolean
---@return boolean is_success
function server.spawnMeteorShower(transform_matrix, magnitude, is_spawn_tsunami) end

-- Spawns a volcano
---@param transform_matrix SWMatrix
---@return boolean is_success
function server.spawnVolcano(transform_matrix) end

-- Gets all volcanos
---@return table<number, SWVolcano> volcanos
function server.getVolcanos() end

-- Gets the blended oil amount at the target location.
---@param transform_matrix SWMatrix the position where you want to get the oil amount at
---@return number oil_amount the amount of oil at the specified matrix.
function server.getOilSpill(transform_matrix) end

-- Sets the oil spill amount at the target location. The amount is blended across nearby tiles.
---@param transform_matrix SWMatrix the position where you want to set the oil amount at.
---@param amount number the amount of oil you want to set at the specified position.
function server.setOilSpill(transform_matrix, amount) end

-- Clear all oil spills in the world
function server.clearOilSpill() end

-- Requires Weapons DLC
---@param transform_matrix SWMatrix
---@param magnitude number 0->1
function server.spawnExplosion(transform_matrix, magnitude) end

-- Used to set game settings
---@param game_setting SWGameSettingEnum
---@param value boolean The game setting state. True or False
function server.setGameSetting(game_setting, value) end

-- Returns a table of the game settings indexed by the GAME_SETTING string, this can be accessed inline eg. server.getGameSettings().third_person
---@return SWGameSettings game_settings
function server.getGameSettings() end

-- Used to set the money and research points for the player
---@param money number How much money the player will have
---@param research_points number How many research points the player will have
function server.setCurrency(money, research_points) end

-- Returns how much money the player has
---@return number money
function server.getCurrency() end

-- Returns how many research points the player has
---@return number research_points
function server.getResearchPoints() end

-- Returns how many days the player has survived
---@return number days_survived
function server.getDateValue() end

-- Gets the current game date
---@return number d, number m, number y
function server.getDate() end

-- Returns the current game time
---@return SWTime clock
function server.getTime() end

-- Returns the current weather
---@param transform_matrix SWMatrix
---@return SWWeather weather
function server.getWeather(transform_matrix) end

-- Sets the custom weather override values (0-1).
---@param fog number the amount of global fog (0-1)
---@param rain number the amount of global rain (0-1)
---@param wind number the amount of global wind (0-1)
function server.setWeather(fog, rain, wind) end

-- Sets the target audio mood. Mood naturally decreases over time
---@param peer_id integer the target peer, -1 for all peers
---@param AUDIO_MOOD SWAudioMoodEnum the selected audio mood (Going below 0 or above 4 will cause CTD)
function server.setAudioMood(peer_id, AUDIO_MOOD) end

-- Returns the world position of a random ocean tile within the selected search range
---@param matrix SWMatrix The matrix to start the search at
---@param min_search_range number The mininum search range relative to the provided matrix. In meters
---@param max_search_range number The maximum search range relative to the provided matrix. In meters
---@return SWMatrix matrix, boolean is_success
function server.getOceanTransform(matrix, min_search_range, max_search_range) end

-- Gets the ocean floor level of the tile on that matrix, does not include mesh height (eg: land)
-- <br>Example return value: `-375`
---@param transform_matrix SWMatrix the position to get the ocean floor of
---@return number height the ocean floor of the tile at the provided matrix.
function server.getOceanFloor(transform_matrix) end

-- Returns the world position of a random tile of type tile_name closest to the supplied location
---@param transform_matrix SWMatrix The matrix to find the tile near
---@param tile_name string The name of the tile to find
---@param search_radius number|nil The radius in which to find the tile. Max is 50000
---@return SWMatrix transform_matrix, boolean is_success
function server.getTileTransform(transform_matrix, tile_name, search_radius) end

-- Returns the data for the tile at the specified location
---@param transform SWMatrix The matrix to get the tile data for
---@return SWTileData tile_data, boolean is_success
function server.getTile(transform) end

-- Returns the data for the tile selected at the start of the game
---@return SWStartTile tile_data, boolean is_success
function server.getStartTile() end

---@deprecated
server.getStartIsland = server.getStartTile

-- Returns whether the tile at the given world coordinates is player owned
---@param matrix SWMatrix The matrix the tile can be found at. Doesn't have to be exact, just has to be within the tile.
---@return boolean is_purchased
function server.getTilePurchased(matrix) end

-- Returns the current inventory amounts for the tile resource depot.
---@param matrix SWMatrix the matrix of the target tile to get the inventory of
---@return number coal the amount of coal in this tile's inventory
---@return number uranium the amount of uranium in this tile's inventory
---@return number diesel the amount of diesel in this tile's inventory
---@return number jet_fuel the amount of jet_fuel in this tile's inventory
---@return number solid_propellant the amount of solid_propellant in this tile's inventory
function server.getTileInventory(matrix) end

-- Sets the inventory amounts for the tile resource depot.
---@param matrix SWMatrix the matrix of the target tile to set the inventory of
---@param coal number the amount of coal to set in this tile's inventory
---@param uranium number the amount of uranium to set in this tile's inventory
---@param diesel number the amount of diesel to set in this tile's inventory
---@param jet_fuel number the amount of jet_fuel to set in this tile's inventory
---@param solid_propellant number the amount of solid_propellant to set in this tile's inventory
function server.setTileInventory(matrix, coal, uranium, diesel, jet_fuel, solid_propellant) end


-- Returns whether the object transform is within a custom zone of the selected size
---@param matrix_object SWMatrix The matrix of the object
---@param matrix_zone SWMatrix The matrix of the zone to search within
---@param zone_size_x number The size of the zone. Refer to World Space
---@param zone_size_y number The size of the zone. Refer to World Space
---@param zone_size_z number The size of the zone. Refer to World Space
---@return boolean is_in_area
function server.isInTransformArea(matrix_object, matrix_zone, zone_size_x, zone_size_y, zone_size_z) end

-- Returns a table of waypoints that form a path from start to end, tags should be seperated by commas with no spaces.
---@param matrix_start SWMatrix The starting point of the path. Refer to World Space
---@param matrix_end SWMatrix The ending point of the path. Refer to World Space
---@param required_tags string The tags a graph node must have to be used.
---@param avoided_tags string The tags it will avoid if a graph node has it. (To omit provide a empty string "")
---@return table<number, SWPathFindPoint> position_list
function server.pathfind(matrix_start, matrix_end, required_tags, avoided_tags) end

-- Returns a table of waypoints tagged with ocean_path, that form a path from start to end. This functions the same as passing "ocean_path" as a required tag to server.pathfind().
---@param matrix_start SWMatrix The starting point of the path. World Space
---@param matrix_end SWMatrix The ending point of the path. World Space
---@return table<number, SWPathFindPoint> position_list
function server.pathfindOcean(matrix_start, matrix_end) end

-- Returns a table of all of the oil deposits in the world.
---@return table<integer, SWOilDepositData> oil_deposits the oil deposits in this world.
function server.getOilDeposits() end

-------------------
-- Misc
-------------------

---@alias SWEventIDEnum
---| 0 # NONE
---| 1 # Halloween
---| 2 # Christmas

-- Adds a checkbox to the settings of the addon NOTE: to default true with a setting below, this must be declared as a variable outside of any function, and the default_value param must be "true", and then later stored in g_savedata in onCreate(is_world_create).
---@param text string The text to show on the checkbox. NOTE: cannot contain commas, and will not work with variables.
---@param default_value boolean|string The default value of the checkbox. NOTE: will not work with variables.
---@return boolean value
function property.checkbox(text, default_value) end

-- Adds a slider to the settings of the addon
---@param text string The text to show on the checkbox. NOTE: cannot contain commas, and will not work with variables.
---@param min number The min value of the slider. NOTE: will not work with variables.
---@param max number The max value of the slider. NOTE: will not work with variables.
---@param increment number The increment of the slider (step size). NOTE: will not work with variables.
---@param default_value number The default value of the slider. NOTE: will not work with variables.
---@return number value
function property.slider(text, min, max, increment, default_value) end

-- Limited to one request per 2 ticks (32 requests/s). Any additional requests will be queued, (requests to port 0 will result in a return to all addons, with the request sent, on the next tick.)
---@param port number The port you are making the request on
---@param request string The URL to make the request to. (4082 chars maximum)
function server.httpGet(port, request) end

-- Bans a player from your server. There is no way to unban players from that save, choose wisely! A new save will have to be created before a banned player can rejoin.
---@param peer_id number The peer id of the affected player
function server.banPlayer(peer_id) end

-- Kicks a player from your server. They can rejoin
---@param peer_id number The peer id of the affected player. Kicking -1 will kick the host, closing the server.
function server.kickPlayer(peer_id) end

-- Makes a player an admin. (Able to kick, ban, auth)
---@param peer_id number The peer id of the affected player
function server.addAdmin(peer_id) end

-- Removes the admin permissions from a player
---@param peer_id number The peer id of the affected player
function server.removeAdmin(peer_id) end

-- Gives a player the ability to spawn in vehicles and edit unlocked game settings
---@param peer_id number The peer id of the affected player
function server.addAuth(peer_id) end

-- Remove the auth permissions from a player
---@param peer_id number The peer id of the affected player
function server.removeAuth(peer_id) end

-- Send a save command for a dedicated server, with an optional save name parameter
---@param save_name string Name to give the save
function server.save(save_name) end

-- For random seeding
---@return number system_time milliseconds - may not be reliable sync between different machines
function server.getTimeMillisec() end

-- Get whether the game considers the tutorial active (Default missions check this before they spawn)
---@return boolean tutorial_completed
function server.getTutorial() end

-- Sets whether the game considers the tutorial active (useful if you are making your own tutorial)
function server.setTutorial() end

-- Returns whether or not the user has been informed of the video tutorials that are on the main menu and pause screen.
---@return boolean user_notified
function server.getVideoTutorial() end

-- Returns true of the host player is a developer of the game.
---@return boolean is_dev
function server.isDev() end

-- Returns true if the server has the Search and Destroy DLC active.
---@return boolean is_enabled
function server.dlcWeapons() end

-- Returns true if the server has the Industrial Frontier DLC active.
---@return boolean is_enabled
function server.dlcArid() end

-- Returns true if the server has the Space DLC active.
---@return boolean is_enabled
function server.dlcSpace() end

-- Returns the ID of the currently active seasonal event.
---@return SWEventIDEnum event_id the id of the current event.
function server.getSeasonalEvent() end

-- Log a message to DebugView.
-- Requires [DebugView](https://learn.microsoft.com/en-us/sysinternals/downloads/debugview) to see the logs,
-- although a more modern version like [DebugView++](https://github.com/CobaltFusion/DebugViewPP) is recommended.
---@param message string The string to log
function debug.log(message) end