PlayerTextDrawTextSize

From SA-MP Wiki

Jump to: navigation, search


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


Description:

Change the size of a player-textdraw (box if PlayerTextDrawUseBox is enabled and/or clickable area for use with PlayerTextDrawSetSelectable).


Parameters:
(playerid, PlayerText:text, Float:x, Float:y)
playeridThe ID of the player whose player-textdraw to set the size of
textThe ID of the player-textdraw to set the size of.
Float:xThe size on the X axis (left/right) following the same 640x480 grid as TextDrawCreate.
Float:yThe size on the Y axis (up/down) following the same 640x480 grid as TextDrawCreate.


Image:32px-Ambox_warning_orange.png

Notes

  • The x and y have different meanings with different PlayerTextDrawAlignment values:
    • 1 (left): they are the right-most corner of the box, absolute coordinates.
    • 2 (center): they need to inverted (switch the two) and the x value is the overall width of the box.
    • 3 (right): the x and y are the coordinates of the left-most corner of the box
  • Using font type 4 (sprite) and 5 (model preview) converts X and Y of this function from corner coordinates to WIDTH and HEIGHT (offsets).
  • The TextDraw box starts 10.0 units up and 5.0 to the left as the origin (TextDrawCreate coordinate).
  • This function defines the clickable area for use with PlayerTextDrawSetSelectable, whether a box is shown or not.


Return Values:

This function does not return any specific values.


Example Usage:

MyTextDraw = CreatePlayerTextDraw(playerid, 100.0, 33.0, "Example TextDraw");
PlayerTextDrawTextSize(playerid, MyTextDraw, 2.0, 3.6);

Related Functions

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