TextDrawUseBox

Tags: textdraw

Description

Toggle whether a textdraw uses a box or not.

Name Description
text The ID of the text textdraw to toggle the box of.
use 1 to show a box or 0 to not show a box.

Returns

1: The function executed successfully.

0: The function failed to execute. This means the textdraw specified does not exist.

Examples

new Text:MyTextdraw;

public OnGameModeInit()
{
    MyTextDraw = TextDrawCreate(100.0, 33.0, "Example TextDraw");
    TextDrawUseBox(MyTextDraw, 1); // Toggle box ON
    return 1;
}

Notes

TIP

If the textdraw is already shown, it must be re-shown (TextDrawShowForAll/TextDrawShowForPlayer) to show the changes of this function.

  • TextDrawCreate: Create a textdraw.
  • TextDrawDestroy: Destroy a textdraw.
  • TextDrawColor: Set the color of the text in a textdraw.
  • TextDrawBoxColor: Set the color of the box in a textdraw.
  • TextDrawBackgroundColor: Set the background color of a textdraw.
  • TextDrawAlignment: Set the alignment of a textdraw.
  • TextDrawFont: Set the font of a textdraw.
  • TextDrawLetterSize: Set the letter size of the text in a textdraw.
  • TextDrawTextSize: Set the size of a textdraw box.
  • TextDrawSetOutline: Choose whether the text has an outline.
  • TextDrawSetShadow: Toggle shadows on a textdraw.
  • TextDrawSetProportional: Scale the text spacing in a textdraw to a proportional ratio.
  • TextDrawSetString: Set the text in an existing textdraw.
  • TextDrawShowForPlayer: Show a textdraw for a certain player.
  • TextDrawHideForPlayer: Hide a textdraw for a certain player.
  • TextDrawShowForAll: Show a textdraw for all players.
  • TextDrawHideForAll: Hide a textdraw for all players.