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
| Name | Type | Required | Description |
|---|---|---|---|
| `path` | string | yes | DataModel path to the instance (e.g. `Workspace/SpawnLocation`). |
| `properties` | string[] | no | Specific property names to read. If omitted, returns common properties for the class. |
When Revix uses it
- Checking the current
Size,Position, orCFrameof a part before adjusting it - Inspecting a
RemoteEvent'sParentto confirm wiring - Reading UI properties like
AnchorPoint,Size, andPositionbefore tweaking layout - Verifying a recent
set_propertiescall landed
Example
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.