warning Not Translated

This page has not been translated into the language that your browser requested yet. The English content is being shown as a fallback.

If you want to contribute a translation for this page then please click here.

PlayerTextDrawBackgroundColour

warning

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

Description

Adjust the background colour of a player-textdraw.

Name	Description
playerid	The ID of the player whose player-textdraw to set the background colour of
PlayerText:textid	The ID of the player-textdraw to set the background colour of
backgroundColour	The colour that the textdraw should be set to.

Returns

This function does not return any specific values.

Examples

new PlayerText:gMyTextdraw[MAX_PLAYERS];

public OnPlayerConnect(playerid)
{
    gMyTextdraw[playerid] = CreatePlayerTextDraw(playerid, 320.0, 240.0, "Welcome to my OPEN.MP server");
    PlayerTextDrawUseBox(playerid, gMyTextdraw[playerid], true);
    PlayerTextDrawBackgroundColour(playerid, gMyTextdraw[playerid], 0xFFFFFFFF); // Set the background colour of gMyTextdraw to white
    return 1;
}

Notes

tip

If PlayerTextDrawSetOutline is used with size > 0, the outline colour will match the colour used in PlayerTextDrawBackgroundColour.
Changing the value of colour seems to alter the colour used in PlayerTextDrawColour.

Related Functions

CreatePlayerTextDraw: Create a player-textdraw.
PlayerTextDrawDestroy: Destroy a player-textdraw.
PlayerTextDrawColour: Set the colour of the text in a player-textdraw.
PlayerTextDrawBoxColour: Set the colour of a player-textdraw's box.
PlayerTextDrawAlignment: Set the alignment of a player-textdraw.
PlayerTextDrawFont: Set the font of a player-textdraw.
PlayerTextDrawLetterSize: Set the letter size of the text in a player-textdraw.
PlayerTextDrawTextSize: Set the size of a player-textdraw box (or clickable area for PlayerTextDrawSetSelectable).
PlayerTextDrawSetOutline: Toggle the outline on a player-textdraw.
PlayerTextDrawSetShadow: Set the shadow on a player-textdraw.
PlayerTextDrawSetProportional: Scale the text spacing in a player-textdraw to a proportional ratio.
PlayerTextDrawUseBox: Toggle the box on a player-textdraw.
PlayerTextDrawSetString: Set the text of a player-textdraw.
PlayerTextDrawShow: Show a player-textdraw.
PlayerTextDrawHide: Hide a player-textdraw.