note Help Needed

This wiki is the result of an ongoing community effort — thank you all for helping!

If you want to provide changes to this page then please click here.

PlayerTextDrawIsBox

warning

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

Description

Checks if a player-textdraw is box.

Parameters

Name	Description
playerid	The ID of the player.
Text:textid	The ID of the player-textdraw to check.

Return Values

Returns true if the player-textdraw is box, otherwise false.

Example Usage

new PlayerText:welcomeText[MAX_PLAYERS];

public OnPlayerConnect(playerid)
{
    welcomeText[playerid] = CreatePlayerTextDraw(playerid, 40.0, 140.0, "_~N~Welcome!~N~_");
    PlayerTextDrawUseBox(playerid, welcomeText[playerid], true); // Toggle box ON
    PlayerTextDrawBoxColor(playerid, welcomeText[playerid], 0x00000066); // Set the box color to a semi-transparent black
    PlayerTextDrawShow(playerid, welcomeText[playerid]);

    if (PlayerTextDrawIsBox(playerid, welcomeText[playerid]))
    {
        // Player-Textdraw is box
    }
    else
    {
        // Player-Textdraw is not box
    }
    return 1;
}

Related Functions

PlayerTextDrawCreate: Create a player-textdraw.
PlayerTextDrawDestroy: Destroy a player-textdraw.
PlayerTextDrawUseBox: Toggle the box on a player-textdraw.
PlayerTextDrawColor: Set the color of the text in a player-textdraw.
PlayerTextDrawBoxColor: Set the color of a player-textdraw's box.
PlayerTextDrawBackgroundColor: Set the background color of a player-textdraw.
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.
PlayerTextDrawSetString: Set the text of a player-textdraw.
PlayerTextDrawShow: Show a player-textdraw.
PlayerTextDrawHide: Hide a player-textdraw.
IsPlayerTextDrawVisible: Checks if a player-textdraw is shown for the player.
IsValidPlayerTextDraw: Checks if a player-textdraw is valid.