get_properties

Reads properties from any instance in the DataModel.

What it does

get_properties returns a key-value map of properties from an instance. You can ask for specific properties by name, or omit the list and get a curated set of commonly-used properties for that instance's class. The result includes the instance's Name, ClassName, Parent, child names, and the requested properties.

Revix uses this as the safer alternative to execute_command when it just needs to see values rather than run logic. Reads are short and cheap, and the response is structured rather than free-form output, so the agent can act on specific fields without parsing print logs.

Parameters

NameTypeRequiredDescription
`path`stringyesDataModel path to the instance (e.g. `Workspace/SpawnLocation`).
`properties`string[]noSpecific property names to read. If omitted, returns common properties for the class.

When Revix uses it

  • Checking the current Size, Position, or CFrame of a part before adjusting it
  • Inspecting a RemoteEvent's Parent to confirm wiring
  • Reading UI properties like AnchorPoint, Size, and Position before tweaking layout
  • Verifying a recent set_properties call landed

Example

text
Workspace/SpawnLocation:
  Name: SpawnLocation
  Class: SpawnLocation
  Parent: Workspace
  Position: [0, 5, 0]
  Anchored: true
  Material: "Enum.Material.SmoothPlastic"

Troubleshooting

If a property comes back as null or unexpected, the property may not exist on that class or may be a runtime-only value. Use execute_command for cases that require live evaluation.