CreatePlayerTextDraw

From SA-MP Wiki

This feature (player-textdraws) was added in SA-MP 0.3e and will not work in earlier versions!

Description:

Return Values:

Example Usage:

// This variable is used to store the id of the textdraw
// so that we can use it throught the script
new PlayerText:welcomeText[MAX_PLAYERS];
 
public OnPlayerConnect(playerid)
{
    // First, create the textdraw
    welcomeText[playerid] = CreatePlayerTextDraw(playerid, 320.0, 240.0, "Welcome to my SA-MP server");
 
    // Now show it
    PlayerTextDrawShow(playerid, welcomeText[playerid]);
}

Important Notes

If you choose values for y that are less than 1, the first text row will be invisible and only the shadow is visible. text[] must NOT be empty or the server will crash! If you need a textdraw that shows nothing, use " " (a space) or _ (underscore) If the last character in the text is a space (" "), the text will all be blank. If part of the text is off-screen, the color of the text will not show, only the shadow (if enabled) will.

Important Notes

This applies ONLY to sa-mp versions before 0.3z: Maximum length of textdraw is 800 characters. Longer text will crash the client in older versions. If you use color codes (such as ~R~ ~G~) beyond 255th character the client will crash trying to display the textdraw.

Important Note

Keyboard key mapping codes (such as ~k~~VEHICLE_ENTER_EXIT~ Doesn't work beyond 255th character.

Notes

The x,y coordinate is the top left coordinate for the text draw area based on a 640x448 "canvas" (irrespective of screen resolution). If you plan on using TextDrawAlignment with alignment 3 (right), the x,y coordinate is the top right coordinate for the text draw. This function merely CREATES the textdraw, you must use PlayerTextDrawShow to show it to a player. It is recommended to use WHOLE numbers instead of decimal positions when creating player textdraws to ensure resolution friendly design.

Note	Player-textdraws are automatically destroyed when a player disconnects.

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• PlayerTextDrawDestroy: Destroy 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.

• 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.