Handles

#Block:get(name: string): number|boolean?

One setting's value, or nil.

#Block:push(force: vec3, impulse?: boolean)

Pushes the moving part this block is on. Server scripts only; the creation must be simulating.

block:push(vec3(0, 9.81 * mass, 0))

#Block:set(name: string, value: any)

Changes one of the block's settings, exactly as its panel would. Client scripts, on creations you own; the server checks both.

for _, b in ipairs(building.selection()) do
  b:set("Force", 2500000)
end

#Block:settings(): table?

The block's mechanism settings as { name = { value, min, max } }, or nil when it has none.

#Block:trySet(name: string, value: any): boolean, string?

Like Block:set, but a refusal returns false and the reason instead of raising an error. Wrong arguments, side and permission errors still raise.

Returns true and the result on success; false and the reason on a refusal.

for _, b in ipairs(building.selection()) do
  b:set("Force", 2500000)
end

#BuildTool:setActive(active: boolean)

Shows the tool as switched on or off.

#Effect:destroy()

Removes the effect at once.

#Effect:emit(count?: integer): Effect

Emits a number of particles at once.

#Effect:follow(target: Object, offset?: vec3): Effect

Makes the effect follow one of your objects.

#Effect:play(): Effect

Starts emitting again after :stop().

#Effect:stop(): Effect

Stops emitting; particles already in the air finish their flight.

#Gear:destroy()

Removes the teeth, and every mesh they were in.

#Gear:meshes(): GearMesh[]

The meshes it is part of.

#Gear:setShaft(shaft?: Shaft)

Moves it onto a shaft (it turns with it), or with nil fixes it to its block's part.

#GearMesh:destroy()

Removes the mesh.

#HttpRequest:cancel()

Stops the request. The callback runs with ok = false and error = "cancelled".

#KeyBinding:off()

Stops listening. Safe to call more than once.

#Material:setColor(property: string, value: color): Material

Sets a colour on the material.

glow:setColor("_EmissionColor", color("#40c0ff"))

#Material:setNumber(property: string, value: number): Material

Sets a number on the material.

#Material:setTexture(property: string, texture: Texture): Material

Sets a picture on the material.

#Material:setVector(property: string, value: vec3, w?: number): Material

Sets a direction or a set of four numbers on the material.

#Model:bounds(): any

The size of the model in metres, as { min = vec3, max = vec3, size = vec3 }.

#Model:materialNames(): string[]

The names of the materials the model uses.

#Object:addLight(options?: any): Object

Adds a light to the object.

lamp:addLight{ color = color("#ffd070"), range = 12, intensity = 3 }

#Object:destroy()

Removes the object from the world for good.

#Object:follow(other: Object, offset?: vec3, matchRotation?: boolean): Object

Makes the object follow another of your objects.

#Object:followPlayer(player: Player, offset?: vec3, faceCamera?: boolean): Object

Makes the object follow a player, keeping an offset in the player's own directions.

marker:followPlayer(host, vec3(0, 2.4, 0))

#Object:lookAt(target: vec3): Object

Points the object at a place.

marker:lookAt(player.position)

#Object:setColor(color: color): Object

Tints every part of the object.

marker:setColor(color("#40c0ff"))

#Object:setMaterial(material: Material): Object

Draws every part of the object with one of your materials.

local glow = assets.material{ color = color("#40c0ff"), emissive = color("#40c0ff") }
shell:setMaterial(glow)

#Object:unfollow(): Object

Stops the object following anything.

#Player:clearHighlight()

Removes your highlight from a player.

#Player:highlight(look: any)

Highlights a player with a colour, which draws a soft glow, or with one of your materials, drawn over the player. Only you see it.

players.host():highlight(color("#ffcc40"))
players.host():highlight(assets.material{ emissive = color("#40c0ff"), alpha = "blend" })

#Player:isHost(): boolean

True for the player hosting the session.

#Player:isLocal(): boolean

True for this machine's own player.

#Player:position(): vec3

Where the player is.

#Player:rotation(): quat

Which way the player faces.

#Player:teleport(position: vec3, rotation?: quat?)

Moves the player. Server scripts only.

for _, p in ipairs(players.all()) do p:teleport(players.host():position() + vec3(2, 0, 0)) end

#Shaft:add(block: Block)

Makes another block turn with it (it must be on the same part). Its spinning meshes are drawn turning.

#Shaft:blocks(): Block[]

The blocks turning with it.

#Shaft:brake(torque: number)

Holds it still with up to torque N·m.

#Shaft:destroy()

Removes the shaft. Gears on it stay, fixed to their blocks' parts.

#Shaft:free()

Lets it turn freely: only its gears and friction act on it.

#Shaft:motor(rpm: number, torque: number)

Drives it as a motor: towards rpm (signed), with at most torque N·m.

shaft:motor(120, 800)

#Shaft:remove(block: Block)

Stops a block turning with it.

#Shaft:servo(degrees: number, rpm: number, torque: number)

Turns it to an angle (degrees since built, not wrapped) at up to rpm, then holds it with at most torque N·m.

#Shaft:setFriction(friction: number, damping?: number)

Bearing friction (constant torque against turning, N·m) and damping (N·m per rad/s).

#Shaft:setInertia(inertia: number)

Adds inertia to it (a flywheel), kg·m², on top of what its blocks have.

#Sound:fadeOut(seconds?: number)

Fades the sound out over a number of seconds, then stops it.

#Sound:isPlaying(): boolean

True while the sound is playing.

#Sound:stop()

Stops the sound and frees it. Safe to call more than once.

#Sound:time(): number

How far through the sound is, in seconds.

#Subscription:off()

Stops the subscription; the handler will not run again, not even for an event raised a moment ago that has not been delivered yet. Safe to call more than once.

#Task:cancel()

Stops the task before its next step. Safe to call more than once.

#Task:isRunning(): boolean

True until the task finishes, fails or is cancelled.

#Timer:cancel()

Stops the timer. Safe to call more than once.

#Timer:remaining(): number

Seconds until the timer next fires.

#UiElement:add(child: UiElement): UiElement

Puts another element inside this one.

panel:add(ui.element("Button", { text = "Apply" }))

#UiElement:addClass(name: string): UiElement

Adds a style class, the same names a .uss file uses.

#UiElement:addNew(kind: string, options?: any): UiElement

Creates an element and puts it inside this one, in one step.

local apply = panel:addNew("Button", { text = "Apply", class = "primary" })

#UiElement:children(): UiElement[]

The elements directly inside this one.

#UiElement:destroy()

Removes the element and everything in it for good. Only for elements this mod made.

#UiElement:find(selector: string): UiElement

The first element under this one matching a selector, or nil.

local power = panel:find("#power")

#UiElement:findAll(selector: string, limit?: integer): UiElement[]

Every element under this one matching a selector.

#UiElement:focus(): UiElement

Gives the element keyboard focus.

#UiElement:get(property: string): any

Reads a property: "value", "label", "tooltip", "enabled", "visible", "choices" …

#UiElement:hasClass(name: string): boolean

Whether the element has a style class.

#UiElement:hide(): UiElement

Hides the element without removing it. The layout closes up around it.

#UiElement:on(what: string, handler: function): UiSubscription

Runs a function when something happens: "click", "change", "input", "focus", "blur", "enter", "leave".

apply:on("click", function() applySettings() end)
slider:on("change", function(value) preview(value) end)

#UiElement:parent(): UiElement?

The element this one is inside, or nil.

#UiElement:remove()

Takes the element out of the interface. A game element is put back when the mod stops.

#UiElement:removeClass(name: string): UiElement

Removes a style class.

#UiElement:set(property: string, value: any): UiElement

Sets a property: "value", "label", "tooltip", "enabled", "choices", "index".

slider:set("value", 42)

#UiElement:setText(text: string): UiElement

Sets the element's text.

title:setText("Thrusters")

#UiElement:show(): UiElement

Shows an element that was hidden.

#UiElement:style(styles: any): UiElement

Sets styles, written the same way as in a .uss file.

panel:style{ width = "320px", ["background-color"] = "#202024e0" }

#UiElement:text(): string?

The element's text, or nil when it has none.

#Video:isPlaying(): boolean

True while the video is playing.

#Video:onEnd(fn: function): Video

Calls fn each time the video reaches its end (every loop, when looping).

intro:onEnd(function() intro:stop() panel:destroy() end)

#Video:pause(): Video

Pauses the video.

#Video:resume(): Video

Carries on after :pause().

#Video:stop()

Stops the video and frees it. Safe to call more than once.