Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
StyleQuery
Inherits from: Instance → Object
StyleQuery is an instance used to set conditions like "MaxSize" and "PreferredInput" for a StyleRule. If the conditions are true, the rule's @ selector is enabled. This is helpful to author styling with dynamic container sizes and cross-platform UI.
Inherits from: Instance
Memory category: Instances
Properties
| Name | Type / Returns | Description |
|---|---|---|
| StyleQuery.IsActive | boolean | A boolean that determines whether a StyleRule.Selector of @ will match the StyleQuery name. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
StyleQuery.IsActive
A boolean that determines whether a StyleRule.Selector of @ will match the StyleQuery name. For example, if a StyleQuery named SmGamepad has conditions set for UserInputService.PreferredInput of Gamepad and GuiService.ViewportDisplaySize of Small and both of these conditions are true (player is playing on a small display size and using a gamepad), the parent of the StyleQuery will match any StyleRule.Selector @SmGamepad.
Conditions
| Condition | Type | Description |
|---|---|---|
AspectRatioRange | Datatype.NumberRange | Evaluates to true if the parent width-to-height ratio of Class.GuiBase2d.AbsoluteSize is greater than or equal to AspectRatioRange.Min and less than AspectRatioRange.Max. |
MaxSize | Datatype.Vector2 | Evaluates to true if the parent Class.GuiBase2d.AbsoluteSize is less than MaxSize. |
MinSize | Datatype.Vector2 | Evaluates to true if the parent Class.GuiBase2d.AbsoluteSize is greater than or equal to MinSize. |
PreferredInput | Enum.PreferredInput | Evaluates to true if PreferredInput matches Class.UserInputService.PreferredInput. |
PreferredTextSize | Enum.PreferredTextSize | Evaluates to true if PreferredTextSize matches Class.GuiService.PreferredTextSize. |
ReducedMotionEnabled | boolean | Evaluates to true if ReducedMotionEnabled matches Class.GuiService.ReducedMotionEnabled. |
ViewportDisplaySize | Enum.DisplaySize | Evaluates to true if ViewportDisplaySize matches Class.GuiService.ViewportDisplaySize. |
| Field | Value |
|---|---|
| type | boolean |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Behavior |
| serialization | {"can_load":false,"can_save":true} |
| capabilities | ["UI"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| StyleQuery:GetCondition | Variant | Returns the value of a specific condition in the StyleQuery. |
| StyleQuery:GetConditions | Dictionary | Returns a dictionary of key-value pairs describing the conditoins set on the StyleQuery. |
| StyleQuery:SetCondition | () | Sets a new condition (or modifies an existing condition) for the StyleQuery. The name parameter should be a valid condition of StyleQuery, and the assigned value should match the condition's value type, for example Vector2 for MaxSize or PreferredInput for PreferredInput. Attempts to assign invalid condition names such as "Size" or "Input" will silently fail. Type mismatches such as UDim2 for MaxSize or string for ReducedMotionEnabled will also fail. To set multiple conditions for a StyleQuery at once, see SetConditions(). |
| StyleQuery:SetConditions | () | Lets you declare and set multiple conditions of the StyleQuery at once. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
StyleQuery:GetCondition
Returns the value of a specific condition in the StyleQuery.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | String name of the condition, for example "MaxSize" or "ViewportDisplaySize". |
Returns
| Type | Description |
|---|---|
| Variant | Value of the condition. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
StyleQuery:GetConditions
Returns a dictionary of key-value pairs describing the conditoins set on the StyleQuery.
Returns
| Type | Description |
|---|---|
| Dictionary | Dictionary of key-value pairs describing the conditions set on the StyleQuery. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
StyleQuery:SetCondition
Sets a new condition (or modifies an existing condition) for the StyleQuery. The name parameter should be a valid condition of StyleQuery, and the assigned value should match the condition's value type, for example Vector2 for MaxSize or PreferredInput for PreferredInput.
Attempts to assign invalid condition names such as "Size" or "Input" will silently fail. Type mismatches such as UDim2 for MaxSize or string for ReducedMotionEnabled will also fail.
To set multiple conditions for a StyleQuery at once, see SetConditions().
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | Condition name to set, for example "MinSize". | |
| value | Variant | Condition value to set, for example Vector2.new(100, 0). |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (StyleQuery-SetCondition).
StyleQuery:SetConditions
Similar to SetCondition() but lets you declare and set multiple conditions of the StyleQuery at once. Each name parameter should be a valid condition of StyleQuery, and the assigned value should match the condition's value type, for example Vector2 for MaxSize or PreferredInput for PreferredInput.
Attempts to assign invalid condition names such as "Size" or "Input" will silently fail. Type mismatches such as UDim2 for MaxSize or string for ReducedMotionEnabled will also fail.
To set/update just one condition of a StyleQuery, see SetCondition().
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| conditions | Dictionary | Dictionary of key-value pairs defining the conditions to set. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (StyleQuery-SetConditions).
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |