Stormworks: Build and Rescue 1.4.10

Feature - Fire surfaces now spread between vehicles upon physics contact
Feature - Game saves now compress vehicles (Smaller and faster saves)

Fix - Lag Issue after reloading a world with AI vehicles in waiting state
Fix - onCharacterSit not correctly returning object ID
Fix - PID Max Error not saved when returning a vehicles

Rework - Added Max error value setting for the PID block (set to zero to disable clamping)

Fix - Quit button disabled for multiplayer clients
Fix - Quit button disabled while incapacitated
Fix - Stormworks not responding while saving
Fix - SetVehiclePos() not correctly updating vehicle physics positions
Fix - Updated AI vehicles script to remove unused objects that were causing errors

Full API Changes
=================

object_id, is_success = server.spawnFire(matrix, size, magnitude, is_lit, is_initialized, is_explosive, parent_vehicle_id, explosion_magnitude)

server.addMapObject(peer_id, ui_id, POSITION_TYPE, MARKER_TYPE, x, y, z, parent_local_x, parent_local_y, parent_local_z, vehicle_id, object_id, label, vehicle_parent_id, radius, hover_label)

server.addMapLabel(peer_id, ui_id, LABEL_TYPE, name, x, y, z))

PLAYER_LIST = server.getPlayers()
PLAYER_LIST |
{ [peer_index] = { ["id"] = peer_id, ["name"] = name, ["admin"] = is_admin, ["auth"] = is_auth, ["steam_id"] = steam_id }}

is_on = server.getVehicleButton(vehicle_id, button_name)

server.setVehicleSeat(vehicle_id, seat_name, axis_w, axis_d, axis_up, axis_right, button1, button2, button3, button4, button5, button6)

server.teleportPlayer(peer_id, matrix) is_success = server.setPlayerPos(peer_id, matrix)

server.teleportVehicle(matrix, vehicle_id) is_success = server.setVehiclePos(vehicle_id, matrix)

is_success = server.setObjectPos(object_id)

EQUIPMENT_ID, is_success= server.getCharacterItem(object_id, SLOT_NUMBER)

name, is_success = server.getPlayerName(peer_id)
matrix, is_success = server.getPlayerPos(peer_id)
x, y, z , is_success = server.getPlayerLookDirection(peer_id)
object_id, is_success = server.spawnObject(matrix, OBJECT_TYPE)
object_id , is_success = server.spawnCharacter(matrix, (OUTFIT_TYPE))
object_id, is_success = server.spawnAnimal(matrix, ANIMAL_TYPE, size_multiplier)
matrix, is_success = server.getObjectPos(object_id)
vehicle_id, is_success = server.spawnVehicle(matrix, playlist_index, component_id)
vehicle_id, is_success = server.spawnVehicleSavefile(matrix, save_name)
matrix, is_success = server.getVehiclePos(vehicle_id, voxel_x = 0, voxel_y = 0, voxel_z = 0)
name, is_success = server.getVehicleName(vehicle_id)
matrix, is_success= server.spawnMissionLocation(matrix, playlist_index, location_index)
is_success = server.spawnThisPlaylistMissionLocation(name)
matrix, is_success = server.getOceanTransform(matrix, min_search_range, max_search_range)

server.createPopup(peer_id, ui_id)
server.setPopup(peer_id, ui_id, name, is_show, text, x, y, z, is_worldspace, render_distance)
server.setPopupScreen(peer_id, ui_id, name, is_show, text, horizontal_offset, vertical_offset)

object_id, is_success = server.getPlayerCharacterID(peer_id)

The following functions were reworked to be more general for player and non-player characters, this functions gives you a player's object_id

server.killPlayer(peer_id) server.killCharacter(object_id)

server.reviveCharacter(object_id)

server.setSeated(peer_id, vehicle_id, seat_name) server.setCharacterSeated(object_id, vehicle_id, seat_name)

Can now set non-player characters to be seated

server.despawnCharacter(object_id, is_instant)
server.despawnMissionObject(object_id, is_instant)

[i]These functions performed the exact same task as server.despawnObject(object_id, is_instant)

hp, matrix, is_incapacitated, is_dead, is_interactable = server.getCharacterData(object_id)
Character position can be obtained with server.getObjectPos(object_id)

Mission objects have been renamed to components to avoid confusion with game objects

LOCATION_DATA, is_success = server.getLocationData(playlist_index, location_index)
LOCATION_DATA |
{ ["name"] = name, ["tile"] = tile_filename, ["env_spawn_count"] = spawn_count, ["env_mod"] = is_env_mod, ["object_count"] = object_count ["component_count"] = component_count })");

COMPONENT_DATA, is_success = server.getLocationComponentData(playlist_index, location_index, *component_index*)
COMPONENT_DATA |
{ ["name"] = name, ["display_name"] = display_name, ["type"] = TYPE_STRING, ["id"] = component_id, ["dynamic_object_type"] = OBJECT_TYPE, ["tags"] = { [i] = tag }, ["transform"] = matrix, ["character_outfit_type"] = OUTFIT_TYPE }

OBJECT = server.spawnMissionObject(matrix, playlist_index, location_index, object_index)
COMPONENT, is_success = server.spawnMissionComponent(matrix, playlist_index, location_index, component_index)
COMPONENT |
{ ["name"] = name, ["display_name"] = display_name, ["type"] = TYPE_STRING, ["x"] = x, ["y"] = y, ["z"] = z, ["transform"] = matrix, ["id"] = object_id/vehicle_id}

function onSpawnMissionObject(object_id/vehicle_id, name, TYPE_STRING, playlist_index)
function onSpawnMissionComponent(object_id/vehicle_id, component_name, TYPE_STRING, playlist_index)

function onVehicleSpawn(vehicle_id, peer_id, x, y, z, cost)
Cost is currently only calculated for player spawned vehicles

function onChatMessage(peer_id, sender_name, message)

is_success = server.despawnObject(object_id, is_instant)
is_success = server.despawnVehicle(vehicle_id, is_instant)

playlist_index, is_success = server.getPlaylistIndexByName(name)
location_index, is_success = server.getLocationIndexByName(playlist_index, name)
path, is_success = server.getPlaylistPath(playlist_name, is_rom)

server.onCharacterSit(object_id, vehicle_id, seat_name)

Quick info for updating old scripts
===================================

Removed Functions:
despawnCharacter [i]did the same thing as despawnObject
despawnMissionObject [i]did the same thing as despawnObject

Renamed Functions:
-teleportPlayer(peer_id, matrix) -> setPlayerPos(peer_id, matrix)
-teleportVehicle(matrix, vehicle_id) -> setVehiclePos(vehicle_id, matrix)
Please note the teleportVehicle arguments are swapped to be the same as other functions
-onSpawnMissionObject -> onSpawnMissionComponent
-spawnMissionObject -> spawnMissionComponent
-setSeated(peer_id, vehicle_id, seat_name) -> setCharacterSeated(object_id, vehicle_id, seat_name)
As seen above setCharacterSeated (and other character based functions) now use an object_id. To get a player's object id a new function has been added: getPlayerCharacterID(peer_id)

Functions that now return an is_success value will requre an extra set of brackets if used as arguemnts as lua will attempt to pass all return values unless the function is evaluated
old `local x, y, z = matrix.position(server.getPlayerPos(player_object.id))`
new `local x, y, z = matrix.position((server.getPlayerPos(player_object.id)))`

Rework - Cargo container design rework (Toggle buttons for connectors)
Rework - Added voice audio volume boost
Rework - Slightly increased player ground collider radius to aid getting stuck in small gaps
Rework - Added key type support for lua data saving (Now supports string(default) and unsigned)

Fix - CTD when returning a vehicle on fire via the map
Fix - Dedicated server ?save always saving to autosave
Fix - Vehicle editor currency display not apperaing after toggling infinite money
Fix - Playlist Lua callbacks errors are now cleared (Callbacks are not blocked after they error)
Fix - Script duplication when reloading scripts
Fix - onPlayerDie event resending when dropping a dead body
Fix - Client character objects not updating their internal peer_id when reconnecting to a server (Wrong peer_id Lua bug)
Fix - Several crashes from playlist Lua
Fix - Missing notification for loot crates
Fix - CTD with out of range outfit for spawnCharacter
Fix - CTD with out of range item for setCharacterItem
Fix - onPlayerSit now only triggers for player characters
Fix - Unable to place blocks on certain sides of doors
Fix - spawnFire() rejecting correct number of arguments
Fix - CTD on Lua failing to find vehicle data
Fix - Dev Train Junction MC showing in inventory

Feature - New Tow / Transport Vehicle missions

Experimental Feature - New Modular Engine Air/Fuel Stoichiometry
(Check out the experimental branch through Steam!)

Rework - Added network event to sync fully extinguished vehicle fires
Rework - Locating a rescue mission grants 30 mins more mission time
Rework - Decreased radius of locate zone objective so it should always be in view when completed
Rework - Mission UI is rebuilt when the map is opened
Rework - Rewards for deliver objectives now scale with distance
Rework - Doubled playlist script max characters

Fix - Remote Control not working fully for MP clients
Fix - ontoggleMap callback not getting called
Fix - CTD when teleporting vehicle with NPC to workbench
Fix - CTD when rescuing character to the edge of a Hospital zone
Fix - Cargo script spawn count error with odd number of spawn locations
Fix - ?save not saving in certain situations
Fix - Playlist Lua getTilePurchased() requiring tile to be loaded
Fix - Screen fade not reversing if revived with <5 seconds left
Fix - Winches not saving correctly (Weird state when reloading them)
Fix - Gimbal Cameras not saving orientation correctly
Fix - CTD from monitor render target
Fix - Internal character peer_id not updating when relogging into a server (Playlist Lua looking for wrong peer_id)
Fix - Camera clipping into emissive player outfits
Fix - Z fighting on emissive player outfits
Fix - Seasonal outfit visual issues
Fix - Seasonal main menu camera clipping into trees

Lua Documentation updates:
Added section listing built in commands
Added section for API general info
Several small fixes

Feature - Seat audio nodes and toggleable headset property

Rework - Removed cargo zone merging
Rework - Scripts are now only ticked when the game is simulating
Rework - Allow dead/incapacitated characters to be placed in beds/stretchers
Rework - Survivors no longer exit seats when vehicles unload
Rework - Water particle extinguish rate now based on distance to fire

Fix - Chatbox covering sound setting sliders
Fix - Laser distance sensor values persisting when toggled off
Fix - Gimbal camera mirrored editor arrows
Fix - Gimbal camera laser rendering flipping in y-axis
Fix - Player charged for auto-refuel when loading a save
Fix - Carried/Seated characters not updating submerged state when NPC damage is enabled
Fix - Player rendering when zoomed in with binoculars
Fix - MP clients falling through floor when teleporting
Fix - MP clients falling through floor when connecting
Fix - MP clients falling through floor when disconnecting
Fix - Buying/selling fuel when auto-refuel is disabled
Fix - Rail junctions not saving their state
Fix - Seat back voxels not being raycastable (Hard to get in seats)
Fix - Button state inverting when cutting power whilst overriding the node
Fix - CTD extinguishing forest fires on DS
Fix - Forest fires not extinguishing correctly by fire extinguisher on DS
Fix - Camera inputs not clearing when toggling photo/noclip mode
Fix - PTT being disabled when scrolling over hotbar radio equipment
Fix - Winch ropes added in vehicle editor snapping to 10m when winch extended/retracted
Fix - Prevent mission fires re-igniting on unload/load
Fix - Active tool staying active when collecting equipment
Fix - Classic career now applies research filters to the vehicle editor hotbar
Fix - Added missing mission location names
Fix - onVehicleDamaged lua callback

Feature - Electrical Cable Anchors and Fluid Hose Anchors

These new rope logic blocks only allow one link, but can transfer Data/Electric/Fluid over the link.

Rework - Changed rope logic node colour to black
Rework - Accessibility palettes now use high contrast font colours for logic types
Rework - Several small aesthetic changes for rope logic in the vehicle editor
Rework - Reduced number of vertices on logic links (tiny performance boost in editor)

Fix - Moved Rope Anchor to the Specialised category (from Blocks)