Skip to main content

TextDrawBackgroundColour

warning

This function was added in omp v1.1.0.2612 and will not work in earlier versions!

Description​

Adjusts the text draw area background colour (the outline/shadow - NOT the box. For box colour, see TextDrawBoxColour).

NameDescription
Text:textidThe ID of the textdraw to set the background colour of
backgroundColourThe colour that the textdraw should be set to.

Returns​

This function does not return any specific values.

Examples​

new Text:gMyTextdraw;

public OnGameModeInit()
{
    gMyTextdraw = TextDrawCreate(320.0, 425.0, "This is an example textdraw");
    TextDrawUseBox(gMyTextdraw, true);
    TextDrawBackgroundColour(gMyTextdraw, 0xFFFFFFFF); // Set the background colour of gMyTextdraw to white
    return 1;
}

Notes​

tip

If TextDrawSetOutline is used with size > 0, the outline colour will match the colour used in TextDrawBackgroundColour. Changing the value of colour seems to alter the colour used in TextDrawColour.

tip

If you want to change the background colour of a textdraw that is already shown, you don't have to recreate it. Simply use TextDrawShowForPlayer/TextDrawShowForAll after modifying the textdraw and the change will be visible.