DrawingImmediate.
Draw text with a separately colored outline. Text and outline have independent opacity values. Use it for a readable label over a background that changes color. A dark outline can separate light text from the image behind it.
Luau
DrawingImmediate.OutlinedText(
position: Vector2,
font: number | DrawFont | DrawingObject,
size: number,
color: Color3,
opacity: number,
outlineColor: Color3,
outlineOpacity: number,
text: string,
center: boolean
) -> ()Parameters
| Parameter | Type | Description |
|---|---|---|
position | Vector2 | Upper-left anchor in screen pixels; centered text uses this as its horizontal center. |
font | number | DrawFont | DrawingObject | Font identifier, registered DrawFont, or DrawingObject Font variant. |
size | number | Font size for this text submission in pixels. |
color | Color3 | Color3 used for the primitive or text. |
opacity | number | Opacity from 0 (invisible) to 1 (opaque). |
outlineColor | Color3 | Color of the text outline. |
outlineOpacity | number | Outline opacity from 0 (invisible) to 1 (opaque). |
text | string | Text to render. |
center | boolean | Whether to center the text. |
Returns
()This function returns no values.
Usage notes
Immediate drawings last for one paint cycle. Call this function again from a GetPaint listener to keep the drawing visible; there is no object handle to update or remove.
Example
Luau
local color = Color3.fromRGB(240, 150, 190)
local paint = DrawingImmediate.GetPaint()
local connection = paint:Connect(function()
DrawingImmediate.OutlinedText(Vector2.new(40, 40), Drawing.Fonts.UI, 18, color, 1, Color3.new(0, 0, 0), 1, "Example label", false)
end)
task.wait(3)
connection:Disconnect() -- stop drawing this example