set_properties

Sets one or more properties on an instance in a single call.

What it does

set_properties writes a batch of properties to an instance. It understands the common Roblox data types and accepts them as JSON-friendly values: arrays for Vector3 and CFrame, hex strings or RGB objects for Color3, structured objects for UDim2, and Enum.X.Y strings for enums. Booleans, numbers, and strings pass through directly.

Revix uses this after create_instance to configure the new instance, and any time existing instances need their properties adjusted. It is the right tool for renaming (Name), resizing (Size), recoloring (Color, BrickColor), repositioning (Position, CFrame), and toggling flags (Anchored, CanCollide).

Parameters

NameTypeRequiredDescription
`path`stringyesDataModel path to the instance.
`properties`objectyesKey-value map of properties to set.

Supported value formats

Roblox typeFormat
`Vector3``[x, y, z]`
`CFrame``{ "Position": [x,y,z] }` or `[x, y, z]`
`Color3``"#FF0000"`, `[r,g,b]` (0-1), or `{ "R": 255, "G": 0, "B": 0 }`
`BrickColor``"Bright red"`
`UDim2``{ "XScale": 0, "XOffset": 100, "YScale": 0, "YOffset": 50 }`
`UDim``{ "Scale": 0.5, "Offset": 0 }`
`Enum``"Enum.Font.GothamBold"`, `"Enum.Material.SmoothPlastic"`
Bool / Number / Stringdirect values

When Revix uses it

  • Configuring a freshly created part's Size, Anchored, Color
  • Renaming instances by setting Name
  • Adjusting UI properties like Size, Position, AnchorPoint, BackgroundColor3
  • Toggling script behavior via Disabled

Example

json
{
  "Size": [10, 1, 10],
  "Anchored": true,
  "Color": "#3B82F6",
  "Material": "Enum.Material.SmoothPlastic"
}

Troubleshooting

If a property does not stick, the value format may not match what Studio expects for that type. See building instances for the full type reference.