UIStroke¶
Not yet Class
Applies an outline to text or a UI border.
Not implemented yet
Outlines need an extra GUI pass.
Workaround: Use a slightly larger frame behind the content, or a 9-slice border image.
0 Nova members · 16 modern Roblox members not implemented yet
Description¶
UIStroke applies an outline to text or a UI border. Some properties may require enabling the Improved UIStrokes beta.
Key features include:
- Adjust the Color and Thickness of the stroke outline.
- Change the stroke Transparency independently from the text or UI object.
- Choose the LineJoinMode of the stroke (round, bevel, or miter).
- Specify the BorderStrokePosition on its parent's border and/or an additional BorderOffset to the stroke's position.
- Add a gradient to the stroke via the UIGradient instance.
- Use rich text tags to add stroke to inline text segments.
For more details on the UIStroke object, see Appearance Modifiers.
Inheritance¶
Object → Instance → UIBase → UIComponent → UIStroke
Properties¶
| Member | Signature | Summary |
|---|---|---|
ApplyStrokeMode |
ApplyStrokeMode: ApplyStrokeMode |
Determines whether to apply the stroke to the object's border instead of the text itself. |
BorderOffset |
BorderOffset: UDim |
Specifies an additional offset to the stroke's position, relative to the parent's minimum height or width. |
BorderStrokePosition |
BorderStrokePosition: BorderStrokePosition |
Determines the stroke's position on its parent's border. |
Color |
Color: Color3 |
Determines the stroke color. |
Enabled |
Enabled: bool |
Determines whether the stroke in visible. |
LineJoinMode |
LineJoinMode: LineJoinMode |
Determines how corners are interpreted. |
StrokeSizingMode |
StrokeSizingMode: StrokeSizingMode |
Determines whether the stroke's Thickness will be measured in pixels or be relative to the parent. |
Thickness |
Thickness: float |
Determines the stroke's thickness. |
Transparency |
Transparency: float |
Sets the stroke opacity independently of the parent object's BackgroundTransparency or [TextTransparency](TextLabel.md#texttranspa… |
ZIndex |
ZIndex: int |
Determines the order in which the stroke renders relative to sibling UIStroke instances. |
Roblox reference: UIStroke
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.