Note
Studio's property groups and the scripting component API are different. A label shown in the Properties panel is not automatically a component name or a Luau field.
UIRect¶
UIRect is a (case-sensitive) built-in component name that stores a UI element's rectangle and sizing behavior.
You can use it with game.World.Query,
Query:With, Query:Without, game.World.Each,
and the Instance component methods.
Script access¶
While this component can be used as a filter in Queries, it currently does not expose any of its fields to Queries. There is no other way to access this component in scripts.
Inspector fields are serialization/editor metadata and are not automatically available as Luau fields. See Components for that distinction and Instances for fixed property types and write scope.
Stored fields¶
Note
Currently, these fields are not directly available as editable Luau. As such, they are reported as the types they are stored as in the engine itself instead of Luau types.
| Field | Stored type | Notes |
|---|---|---|
position.x.scale |
f32 |
|
position.x.offset |
f32 |
|
position.y.scale |
f32 |
|
position.y.offset |
f32 |
|
size.x.scale |
f32 |
|
size.x.offset |
f32 |
|
size.y.scale |
f32 |
|
size.y.offset |
f32 |
|
max.x.scale |
f32 |
|
max.x.offset |
f32 |
|
max.y.scale |
f32 |
|
max.y.offset |
f32 |
|
anchor_x |
f32 |
|
anchor_y |
f32 |
|
size_mode[0] |
u8 |
X-axis enum |
size_mode[1] |
u8 |
Y-axis enum |