Switch to Dark Mode

Poly Bridge 3 Lua API

Unofficial API documentation for the official Poly Bridge 3 Lua API. Automatically generated from the Lua code library.

Bridge functions

BreakEdge

nil BreakEdge(id: string)

GetBridgeEdgeAngle

number GetBridgeEdgeAngle(id: string)

Returns the angle of the edge

GetBridgeEdgeIds

string[] GetBridgeEdgeIds()

Returns a list of id strings for all currently active bridge edges(List)

GetBridgeEdgeIdsSelected

string[] GetBridgeEdgeIdsSelected()

Returns a list of id strings for all edges that are currently selected(List)

GetBridgeEdgeIsBroken

boolean GetBridgeEdgeIsBroken(id: string)

Returns true if the edge is broken, or false if it isn't

GetBridgeEdgeIsPrebuilt

boolean GetBridgeEdgeIsPrebuilt(id: string)

Returns true if the edge is prebuilt, or false if it isn't

GetBridgeEdgeJoints

string[] GetBridgeEdgeJoints(id: string)

Returns a list of id strings representing the two joints this edge is connected to (List)

GetBridgeEdgeLength

number GetBridgeEdgeLength(id: string)

Returns the length of the edge

GetBridgeEdgeMaterial

string GetBridgeEdgeMaterial(id: string)

Returns the material name of the edge, see appendix for valid material names

GetBridgeEdgePosition

Vec3 GetBridgeEdgePosition(id: string)

Returns the current game world position of the bridge edge as a float list of length 3 (corresponding to x, y, and z position) (List)

GetBridgeEdgeStressNormalized

number GetBridgeEdgeStressNormalized(id: string)

Returns the current normalized stress of the edge (float)

GetBridgeEdgeStressSigned

number GetBridgeEdgeStressSigned(id: string)

Returns the current unsigned normalized stress of the edge (float). 0 to +1 is compression, and 0 to -1 is tension.

GetFoundationIds

string[] GetFoundationIds()

Returns a list of id strings for all currently active foundations (List)

GetFoundationIdsSelected

string[] GetFoundationIdsSelected()

Returns a list of id strings for all foundations that are currently selected(List)

GetJointEdges

string[] GetJointEdges(id: string)

Returns list of id strings representing all edges attached to this joint (List)

GetJointIds

string[] GetJointIds()

Returns a list of id strings for all currently active joints (List)

GetJointIdsSelected

string[] GetJointIdsSelected()

Returns a list of id strings for all joints that are currently selected(List)

GetJointIsAnchor

boolean GetJointIsAnchor(id: string)

Returns true if the joint is an anchor, returns false if it isn't

GetJointIsPrebuilt

boolean GetJointIsPrebuilt(id: string)

Returns true if the edge is prebuilt, or false if it isn't

GetJointIsSplit

boolean GetJointIsSplit(id: string)

Returns true if the joint is a split joint, returns false if it isn't

GetJointIsUnbuildable

boolean GetJointIsUnbuildable(id: string)

Returns true if the joint is unbuildable

GetJointPosition

Vec3 GetJointPosition(id: string)

Returns the current game world position of the joint as a float list of length 3 (corresponding to x, y, and z position)

GetOverrideEdgeColor

string GetOverrideEdgeColor(id: string)

Returns the override color string of this edge, returns empty string if uncolored

GetPermanentEdgeColor

string GetPermanentEdgeColor(id: string)

Returns the permanent color string of this edge, returns empty string if uncolored

IgnoreEdgePlacementRestrictions

nil IgnoreEdgePlacementRestrictions(value: boolean)

PlaceEdgeJointToJoint

string PlaceEdgeJointToJoint(materialName: string, jointIdA: string, jointIdB: string)

Attempts to place an edge between two joints, respecting all placement restrictions to only place edges legally. Can only be used in BUILD or SANDBOX modes. Returns “SUCCESS” on success, or an error message on failure.

PlaceEdgeJointToJointCheat

string PlaceEdgeJointToJointCheat(materialName: string, jointIdA: string, jointIdB: string)

PlaceEdgeJointToPos

string PlaceEdgeJointToPos(materialName: string, jointIdA: string, posB: Vec3)

Attempts to place an edge starting at the given joint and ending at the given position, respecting all placement restrictions to only place edges legally. Can only be used in BUILD or SANDBOX modes. Returns “SUCCESS” on success, or an error message on failure.

PlaceEdgeJointToPosCheat

string PlaceEdgeJointToPosCheat(materialName: string, jointIdA: string, posB: Vec3)

PlaceEdgePosToPos

string PlaceEdgePosToPos(materialName: string, posA: Vec3, posB: Vec3)

Attempts to place an edge starting at posA and ending at posB, respecting all placement restrictions to only place edges legally. Can only be used in BUILD or SANDBOX modes. Returns “SUCCESS” on success, or an error message on failure.

PlaceEdgePosToPosCheat

string PlaceEdgePosToPosCheat(materialName: string, posA: Vec3, posB: Vec3)

SetJointIsSplit

nil SetJointIsSplit(id: string, isSplit: boolean)

Sets joint split state. NOTE: joints can only be split in Build mode on levels with hydraulic phases

SetJointLegalPosition

nil SetJointLegalPosition(id: string, targetPosition: Vec3)

Attempts to set a joint’s position to the target position, following all normal joint movement restrictions

SetJointPosition

nil SetJointPosition(id: string, position: Vec3)

SetOverrideEdgeColor

nil SetOverrideEdgeColor(id: string, overrideColor: string)

Set the color of this edge, overriding the normal texture and stress color visualization

SetPermanentEdgeColor

nil SetPermanentEdgeColor(id: string, overrideColor: string)

Set the color of this edge, overriding the normal texture and stress color visualization. This color will persist when switching between build mode and sim mode, as well as persist through save/load. Note that SetOverrideEdgeColor takes priority over the permanent color if it is used.

Camera functions

GetCameraFOV

number GetCameraFOV()

returns the Field Of View value of the camera (float)

GetCameraOrthographic

boolean GetCameraOrthographic()

Returns true if the camera is set to Orthographic, otherwise returns false

GetCameraOrthographicSize

number GetCameraOrthographicSize()

Returns the Orthographic Size value of the camera (float)

GetCameraPosition

Vec3 GetCameraPosition()

Returns the current game world position of the camera as a float list of length 3 (corresponding to x, y, and z position)

GetCameraRotation

Vec3 GetCameraRotation()

Returns the current game world rotation of the camera as a float list of length 3 (corresponding to x, y, and z euler angles)

SetCameraFOV

nil SetCameraFOV(value: number)

Sets the Field Of View value of the camera to the desired value

SetCameraLookAtObject

nil SetCameraLookAtObject(objectId: string)

Sets the camera's rotation so that it looks at the desired object, note this will only work correctly if Orthographic is set to false

SetCameraOrthographic

nil SetCameraOrthographic(value: boolean)

Sets the Orthographic setting of the camera to the desired value

SetCameraOrthographicSize

nil SetCameraOrthographicSize(value: number)

Sets the Orthographic Size value of the camera to the desired value

SetCameraPosition

nil SetCameraPosition(position: Vec3)

Sets the current game world position of the camera

SetCameraRotation

nil SetCameraRotation(rotation: Vec3)

Sets the current game world rotation of the camera

Debug functions

AddDebugConsoleCommand

Example:

-- OnModLoad.lua:
EnableDebugConsole()
AddDebugConsoleCommand("set_material_cost", "usage: set_material_cost <material_name> <cost_value>", 2)
-- ConsoleCommands.lua:
function set_material_cost(args)
  materialName = args[1]
  costValue = tonumber(args[2])
  SetMaterialCost(materialName, costValue)
end

nil AddDebugConsoleCommand(commandName: string, helpText: string, numParameters: integer)

Adds a console command that calls a named function from ConsoleCommands.lua

EnableDebugConsole

nil EnableDebugConsole()

Unlocks the debug console, allowing it to be opened using the ~ key

EnableLevelNavArrows

nil EnableLevelNavArrows()

Enables buttons in the top bar for navigation forward and backwards through campaign levels.

ShowLevelID

nil ShowLevelID()

Shows the current level ID in the level info panel

Game State functions

EndLevelFail

boolean EndLevelFail(failReasonText: string)

If you are in sim mode and the simulation has started, immediately end the simulation and go to level failed screen, showing failReason text. returns true if successful.

EndLevelSuccess

boolean EndLevelSuccess()

GetCurrentLevelID

string GetCurrentLevelID()

Returns the current level ID (string)

GetDefaultSimSpeed

number GetDefaultSimSpeed()

Returns the default normalized sim speed (float)

GetSimSpeed

number GetSimSpeed()

Returns the current normalized sim speed (float)

IsSimulating

boolean IsSimulating()

Returns true if you are in sim mode and the simulation has started, otherwise returns false.

IsSimulatingWithoutPassOrFail

boolean IsSimulatingWithoutPassOrFail()

Returns true or false based on if the game is currently simulating but pass/fail has yet to be determined

SetSimSpeed

nil SetSimSpeed(speed: number)

Sets the current sim speed to the desired value, note that the desired value must be a valid sim speed in the current sim speed list. Default valid sim speeds are {0.1, 0.2, 0.5, 1, 2, 3, 5}

SimulationEnd

boolean SimulationEnd()

Ends simulation if you are in sim mode and the simulation has started. returns true if successful.

SimulationPause

boolean SimulationPause()

Pauses simulation if you are in sim mode and the simulation has started. returns true if successful.

SimulationStart

boolean SimulationStart()

Starts simulation if you are in build mode, or resumes simulating if you are in a paused simulation. returns true if successful.

SimulationTogglePause

boolean SimulationTogglePause()

Toggles pause state of simulation if you are in sim mode and the simulation has started. returns true if successful.

SimulationUnpause

boolean SimulationUnpause()

Unpauses simulation if you are in sim mode and the simulation has started. returns true if successful.

Generic functions

GetVehiclePhysicsVelocity

nil GetVehiclePhysicsVelocity(undefined)

OpenLevel

nil OpenLevel(undefined)

OpenWorkshopLevel

nil OpenWorkshopLevel(undefined)

SetRoadEdgeTint

nil SetRoadEdgeTint(undefined)

SetVehiclePhysicsVelocity

nil SetVehiclePhysicsVelocity(undefined)

SetVehiclePosition

nil SetVehiclePosition(undefined)

SetVehicleRotation

nil SetVehicleRotation(undefined)

SetVehicleSpeed

nil SetVehicleSpeed(undefined)

Language functions

AddLanguageCSV

nil AddLanguageCSV(filename: string)

Add a translation for the game UI. A template for this file can be created on the Workshop -> Created panel.

Material functions

GetHydraulicsBaseTint

string GetHydraulicsBaseTint()

Returns the tint color string for hydraulics base texture

GetMaterialCost

number GetMaterialCost(materialName: string)

Returns the cost per meter of the given material

GetMaterialMaxLength

number GetMaterialMaxLength(materialName: string)

Returns the max length of the given material

GetMaterialStrength

number GetMaterialStrength(materialName: string)

Returns the strength of the given material

GetMaterialTint

string GetMaterialTint(materialName: string)

Returns the tint color string for this material

GetRoadEdgeTint

string GetRoadEdgeTint()

Returns the tint color string for road edge texture

SetHydraulicsBaseTint

nil SetHydraulicsBaseTint(tintColor: string)

Permanently tints the texture of the base of the hydraulic. Note that the extending/contracting part of the hydraulic can be tinted using SetMaterialTint()

SetMaterialCost

nil SetMaterialCost(materialName: string, value: number)

SetMaterialMaxLength

nil SetMaterialMaxLength(materialName: string, value: number)

SetMaterialStrength

nil SetMaterialStrength(materialName: string, value: number)

SetMaterialTint

nil SetMaterialTint(materialName: string, tintColor: string)

Permanently tints the texture of the given material. Note that Hydraulics and Roads use a secondary texture, which can be tinted using SetHydraulicsBaseTint and SetRoadEdgeTint respectively

Sandbox functions

AddCustomShape

nil AddCustomShape(folderName: string)

Add custom shape(s) to be used in sandbox

AddCustomShapeTexture

nil AddCustomShapeTexture(filename: string, textureName: string, id: string)

Adds a texture to be used in custom shapes in sandbox

DisableRandomVehicleSpawn

nil DisableRandomVehicleSpawn()

Disables the random vehicle spawning that occurs when a new Sandbox is created

Screen UI functions

CreateButtonObject

nil CreateButtonObject(buttonId: string, callback: string, width: integer, height: integer)

Creates a new button object NOTE: Please make your callback function name as unique as possible. If multiple callbacks across different mods share the same name, the one loaded last will overwrite the others.

CreateSpriteObject

nil CreateSpriteObject(spriteId: string, imagePath: string, width: integer, height: integer)

Creates a new sprite object

CreateTextObject

nil CreateTextObject(objectId: string, width: integer, height: integer)

Creates a new text object

DestroyButtonObject

nil DestroyButtonObject(buttonId: string)

Destroys a button by id

DestroySpriteObject

nil DestroySpriteObject(spriteId: string)

Destroys a sprite object

DestroyTextObject

nil DestroyTextObject(objectId: string)

Destroys a previously created text object with the given id

UpdateButtonAddHoverScale

nil UpdateButtonAddHoverScale(buttonId: string)

Adds a scale-up effect when the button is hovered

UpdateButtonCallback

nil UpdateButtonCallback(buttonId: string, callback: string)

Sets the button callback to a named global function name NOTE: Please make your callback function name as unique as possible. If multiple callbacks across different mods share the same name, the one loaded last will overwrite the others.

UpdateButtonColor

nil UpdateButtonColor(buttonId: string, normalColorStr: string, hoverColorStr: string)

Sets the background color of a button

UpdateButtonImage

nil UpdateButtonImage(buttonId: string, imagePath: string)

Sets the image of a button

UpdateButtonPivot

nil UpdateButtonPivot(buttonId: string, xPivot: number, yPivot: number)

sets the pivot point of a button

UpdateButtonScreenPos

nil UpdateButtonScreenPos(buttonId: string, xScreenPos: number, yScreenPos: number)

Sets the screen position of a button

UpdateButtonSetInteractable

nil UpdateButtonSetInteractable(buttonId: string, interactable: boolean)

Enables or disables a button

UpdateButtonSetOutlineActive

nil UpdateButtonSetOutlineActive(buttonId: string, outlineActive: boolean)

Enables the outline of a button

UpdateButtonText

nil UpdateButtonText(buttonId: string, buttonText: string)

Sets the text of a button

UpdateButtonTextColor

nil UpdateButtonTextColor(buttonId: string, colorStr: string)

Sets the text color of a button

UpdateButtonTooltipText

nil UpdateButtonTooltipText(buttonId: string, tooltipText: string)

Sets the hover tooltip of a button

UpdateSpriteColor

nil UpdateSpriteColor(spriteId: string, colorString: string)

Sets the color filter of a sprite object. For example a 1x1 solid white image with a 50% transparent red color (#FF000080) will draw a 50% transparent red sprite.

UpdateSpriteImage

nil UpdateSpriteImage(spriteId: string, imagePath: string)

Sets the image of a sprite object

UpdateSpritePivot

nil UpdateSpritePivot(spriteId: string, xPivot: number, yPivot: number)

Sets the pivot point of a sprite object

UpdateSpriteScreenPos

nil UpdateSpriteScreenPos(spriteId: string, xScreenPos: number, yScreenPos: number)

Sets the screen position of a sprite object

UpdateTextAlignment

nil UpdateTextAlignment(objectId: string, horizontalAlign: string, verticalAlign: string)

Sets the alignment of a text object

UpdateTextColor

nil UpdateTextColor(objectId: string, colorString: string)

Sets the color of a text object

UpdateTextFontSize

nil UpdateTextFontSize(objectId: string, fontSize: integer)

Sets the font size of a text object

UpdateTextMaxWidth

nil UpdateTextMaxWidth(objectId: string, maxWidth: integer)

Sets the maximum width of a text object

UpdateTextPivot

nil UpdateTextPivot(objectId: string, xPivot: number, yPivot: number)

Sets the pivot point of a text object

UpdateTextScreenPos

nil UpdateTextScreenPos(objectId: string, xScreenPos: number, yScreenPos: number)

Sets the screen position of a text object

UpdateTextSetBackgroundActive

nil UpdateTextSetBackgroundActive(objectId: string, bgActive: boolean)

Enables the background of a text object NOTE: the background auto-scales to the display size of the text, which will prevent the text pivot and alignment from working as expected

UpdateTextSetBackgroundColor

nil UpdateTextSetBackgroundColor(objectId: string, bgColorString: string, outlineColorString: string)

Sets the background color of a text object

UpdateTextString

nil UpdateTextString(objectId: string, textString: string)

Sets the text in a text object

Theme functions

SetThemeSky

Example:

SetThemeSky("rocks", "#FF0000", "#00FF00", "#0000FF", "0.5")

nil SetThemeSky(themeName: string, topColor: string, midColor: string, botColor: string, offset: number)

Sets the sky color in different level themes

UGC functions

AddAssetBoat

nil AddAssetBoat(iconFilename: string, boatName: string, prefabAddress: string, mass: number)

Loads a z-axis boat asset from an addressable prefab to be used in sandbox and workshop. See the UGC Pipeline section of the documentation for more info.

AddAssetDecor

nil AddAssetDecor(iconFilename: string, decorName: string, prefabAddress: string)

Loads a decor asset from an addressable prefab to be used in sandbox and workshop. See the UGC Pipeline section of the documentation for more info.

AddAssetPlane

nil AddAssetPlane(iconFilename: string, planeName: string, prefabAddress: string, mass: number)

Loads a z-axis plane asset from an addressable prefab to be used in sandbox and workshop. See the UGC Pipeline section of the documentation for more info.

AddAssetVehicle

nil AddAssetVehicle(iconFilename: string, vehicleName: string, prefabAddress: string, mass: number)

Loads a vehicle asset from an addressable prefab to be used in sandbox and workshop. See the UGC Pipeline section of the documentation for more info.

UI functions

IsMenuOpen

boolean IsMenuOpen()

Returns true if any menu is open, otherwise returns false

IsStressVisibilityEnabled

boolean IsStressVisibilityEnabled()

Returns true if stress visibility is enabled, otherwise returns false

SetDefaultSimSpeed

nil SetDefaultSimSpeed(speed: integer)

Sets the default sim speed from the available speeds. If speed does not exist in list of simulation speeds, then value is ignored

SetSimSpeeds

nil SetSimSpeeds(speeds: integer[])

Sets the available simulation speeds to use in game as table of integers where 1000=1.0x. Default: {100, 200, 500, 1000, 2000, 3000, 5000}

ShowMessage

nil ShowMessage(text: string)

Shows an information popup message in the center of the screen with an OK button

Utils functions

ConsoleLog

nil ConsoleLog(message: string)

Log a message to the consoles

GetFrameCount

number GetFrameCount()

Returns the total number of frames since the start of the game (int)

GetGameState

string GetGameState()

Returns the current game state (string). Valid values include: MAIN_MENU, BUILD, SANDBOX, SIM.

GetGameTime

number GetGameTime()

Returns the time in seconds since the start of the game (float)

GetKeycodeDown

boolean GetKeycodeDown(keycodeNumber: integer)

Returns true if the key is currently held down, otherwise returns false

GetKeycodeJustPressed

boolean GetKeycodeJustPressed(keycodeNumber: integer)

Returns true if the key was just pressed this frame, otherwise returns false

GetKeyDown

boolean GetKeyDown(keycodeString: string)

Returns true if the key is currently held down, otherwise returns false

GetKeyJustPressed

boolean GetKeyJustPressed(keycodeString: string)

Returns true if the key was just pressed this frame, otherwise returns false

GetMouseButtonDown

boolean GetMouseButtonDown(mouseButton: integer)

Returns true if the button is currently held down, otherwise returns false

GetMouseButtonJustPressed

boolean GetMouseButtonJustPressed(mouseButton: integer)

Returns true if the button was just pressed this frame, otherwise returns false

GetMousePosition

Vec2 GetMousePosition()

Returns the current x,y position of the mouse in pixels (List)

GetMouseScreenPosition

Vec2 GetMouseScreenPosition()

Returns the current x,y position of the mouse normalized to screen position, where 0,0 is the bottom left and 1,1 is the top right (List)

GetMouseWorldPosition

Vec3 GetMouseWorldPosition()

Returns the world position of the mouse (List)

GetNameOfKeyDownThisFrame

string GetNameOfKeyDownThisFrame()

Returns the name (string) of the first detected key pressed this frame

GetScreenResolution

Vec2 GetScreenResolution()

Returns the current screen resolution as a float list of length 2 (corresponding to width and height) (List)

GetUnscaledDeltaTime

number GetUnscaledDeltaTime()

Returns the interval in seconds from the last frame to the current one (float)

GetVar_Float

number GetVar_Float(varName: string)

Returns the value of the variable (float)

GetVar_FloatList

number[] GetVar_FloatList(varName: string)

Returns the value of the variable (List)

GetVar_Int

integer GetVar_Int(varName: string)

Returns the value of the variable (int)

GetVar_IntList

integer[] GetVar_IntList(varName: string)

Returns the value of the variable (List)

GetVar_String

string GetVar_String(varName: string)

Returns the value of the variable (string)

GetVar_StringList

string[] GetVar_StringList(varName: string)

Returns the value of the variable (List)

RunLuaDelayed

nil RunLuaDelayed(luaString: string, delaySeconds: number)

Evaluates and runs the given lua string after a delay NOTE: the given lua string must be formatted exactly as it would be written in a lua script, so you may need to use escape characters.

SetGameInputActive

nil SetGameInputActive(isActive: boolean)

Enables or disables normal game input completely

SetIgnoreGameInputKey

nil SetIgnoreGameInputKey(keycodeString: string)

After being set, holding down this key will cause normal game input to be ignored

SetIgnoreGameInputKeycode

nil SetIgnoreGameInputKeycode(keycodeNumber: integer)

After being set, holding down this key will cause normal game input to be ignored

SetVar_Float

nil SetVar_Float(varName: string, floatValue: number)

SetVar_FloatList

nil SetVar_FloatList(varName: string, listValue: number[])

SetVar_Int

nil SetVar_Int(varName: string, intValue: integer)

SetVar_IntList

nil SetVar_IntList(varName: string, listValue: integer[])

SetVar_String

nil SetVar_String(varName: string, stringValue: string)

SetVar_StringList

nil SetVar_StringList(varName: string, listValue: string[])

WorldToScreenPos

Vec3 WorldToScreenPos(worldPos: Vec3)

Returns the screen position as a float list of length 3 (corresponding to x, y, and z position) representing the position on screen (List)

Vehicle functions

AddVehicleSkin

nil AddVehicleSkin(vehicleAddressableName: string, filename: string, displayName: string, flagColor: string, id: string)

Adds a skin for a vanilla vehicle

GetVehicleAcceleration

number GetVehicleAcceleration(id: string)

Returns the acceleration of the vehicle (float)

GetVehicleBrakingForce

number GetVehicleBrakingForce(id: string)

Returns the braking force of the vehicle (float)

GetVehicleFlippedDirection

boolean GetVehicleFlippedDirection(id: string)

Returns true if the vehicle is flipped (facing left), otherwise returns false

GetVehicleGameState

string GetVehicleGameState(id: string)

Returns string representing vehicle game state: "REACHED_FLAG", "UNDERWATER", "DRIVING", "WAITING_START", "WAITING_CHECKPOINT", or "WAITING_BUILD_MODE"

GetVehicleHorsepower

number GetVehicleHorsepower(id: string)

Returns the horsepower of the vehicle (float)

GetVehicleIdleDownhill

boolean GetVehicleIdleDownhill(id: string)

Returns true if the idle downhill setting is true on the vehicle, otherwise returns false

GetVehicleIds

integer[] GetVehicleIds()

Returns a list of id strings for all currently active vehicles (List)

GetVehicleMass

number GetVehicleMass(id: string)

Returns the mass of the vehicle (float)

GetVehiclePosition

Vec3 GetVehiclePosition(id: string)

Returns the current game world position of the vehicle as a float list of length 3 (corresponding to x, y, and z position) (List)

GetVehicleRotation

Vec3 GetVehicleRotation(id: string)

Returns the current game world rotation of the vehicle as a float list of length 3 (corresponding to x, y, and z euler angles) (List)

GetVehicleSpeed

number GetVehicleSpeed(id: string)

Returns the current speed of the vehicle (float)

GetVehicleTargetSpeed

number GetVehicleTargetSpeed(id: string)

Returns the target speed of the vehicle (float)

SetVehicleAcceleration

nil SetVehicleAcceleration(id: string, value: number)

SetVehicleBrakingForce

nil SetVehicleBrakingForce(id: string, value: number)

SetVehicleFlippedDirection

nil SetVehicleFlippedDirection(id: string, value: boolean)

SetVehicleHorsepower

nil SetVehicleHorsepower(id: string, value: number)

SetVehicleIdleDownhill

nil SetVehicleIdleDownhill(id: string, value: boolean)

SetVehicleMass

nil SetVehicleMass(id: string, value: number)

SetVehicleTargetSpeed

nil SetVehicleTargetSpeed(id: string, value: number)

Workshop Campaign functions

WorkshopCampaignAddLevelToWorld

nil WorkshopCampaignAddLevelToWorld(worldName: string, levelId: string)

Adds the given level to the given world.

WorkshopCampaignAddTutorialLevelToWorld

nil WorkshopCampaignAddTutorialLevelToWorld(worldName: string, levelId: string)

Adds the given level to the given world, and puts a T in front of the name to indicate it is a tutorial.

WorkshopCampaignCreate

nil WorkshopCampaignCreate(winMessage: string)

Creates a workshop campaign, must happen before WorkshopCampaignCreateWorld or WorkshopCampaignAddLevelToWorld.

WorkshopCampaignCreateWorld

nil WorkshopCampaignCreateWorld(worldName: string, prefix: string, subtitle: string, worldDifficulty: integer)

Creates a world for a workshop campaign, must happen after WorkshopCampaignCreate

WorkshopCampaignSetWorldIcon

nil WorkshopCampaignSetWorldIcon(worldName: string, iconSpritePath: string, selectedIconSpritePath: string)

Sets the icon of the created world to the given sprites.

WorkshopCampaignSetWorldIconByPrefix

nil WorkshopCampaignSetWorldIconByPrefix(worldName: string, prefix: string)

Sets the icon of the created world to the icon from the normal campaign mode world that matches the prefix.

WorkshopCampaignSetWorldIconPosition

nil WorkshopCampaignSetWorldIconPosition(worldName: string, iconPositionX: number, iconPositionY: number)

Sets the position of the icon for the given world. Note that the X value is clamped between -125 and 125, and the Y value is clamped between -210 and 210.