TextDrawLetterSize

From SA-MP Wiki

(Difference between revisions)
Jump to: navigation, search
Revision as of 23:44, 18 August 2013
Drebin (Talk | contribs)
(General cleanup, added tip.)
← Previous diff
Current revision
OstGot (Talk | contribs)

Line 1: Line 1:
{{Scripting}} {{Scripting}}
-{{Title}} 
{{Description|Sets the width and height of the letters.}} {{Description|Sets the width and height of the letters.}}
Line 6: Line 5:
{{Parameters|Text:text, Float:x, Float:y}} {{Parameters|Text:text, Float:x, Float:y}}
{{Param|text|The TextDraw to change}} {{Param|text|The TextDraw to change}}
-{{Param|x|Width of a char.}}+{{Param|Float:x|Width of a char.}}
-{{Param|y|Height of a char.}}+{{Param|Float:y|Height of a char.}}
-{{NoReturn}}+{{ReturnsSuccess||This means the textdraw specified does not exist.}}
 +{{Example}}
<pawn> <pawn>
new Text:MyTextdraw; new Text:MyTextdraw;
Line 22: Line 22:
</pawn> </pawn>
-{{note|When using this function purely for the benefit of affecting the TextDraw box, multiply 'Y' by 0.135 to convert to TextDrawTextSize-like measurements}}+{{note|When using this function purely for the benefit of affecting the TextDraw box, multiply 'Y' by 0.135 to convert to TextDrawTextSize-like measurements. '''Hint''': it is easier and extremely precise to use ''' ''LD_SPAC:white'' ''' sprite for box-only textdraws, [[TextDrawTextSize]] will have regular offsets.}}
-{{tip|If you want to change the letter size of a textdraw that is already shown, you don't have to recreate it. Simply use [[TextDrawShowForPlayer|TextDrawShowForPlayer]]/[[TextDrawShowForAll|TextDrawShowForAll]] after modifying the textdraw and the change will be visible.}}+{{tips|
 +* If you want to change the letter size of a textdraw that is already shown, you don't have to recreate it. Simply use [[TextDrawShowForPlayer|TextDrawShowForPlayer]]/[[TextDrawShowForAll|TextDrawShowForAll]] after modifying the textdraw and the change will be visible.
 +* Fonts appear to look the best with an X to Y ratio of 1 to 4 (e.g. if x is 0.5 then y should be 2).}}
{{RelatedFunctions}} {{RelatedFunctions}}
Line 47: Line 49:
[[Category:Scripting Functions]] [[Category:Scripting Functions]]
 +[[Category:Textdraw|LetterSize]]

Current revision



Description:

Sets the width and height of the letters.


Parameters:
(Text:text, Float:x, Float:y)
textThe TextDraw to change
Float:xWidth of a char.
Float:yHeight of a char.


Return Values:

  • 1: The function was executed successfully.
  • 0: The function failed to execute. This means the textdraw specified does not exist.


Example Usage:

new Text:MyTextdraw;
 
public OnGameModeInit()
{
    MyTextDraw = TextDrawCreate(100.0, 33.0,"Example TextDraw");
    TextDrawLetterSize(MyTextDraw, 3.2 ,5.1);
    return 1;
}
Image:32px-Ambox_warning_orange.png

Note

When using this function purely for the benefit of affecting the TextDraw box, multiply 'Y' by 0.135 to convert to TextDrawTextSize-like measurements. Hint: it is easier and extremely precise to use LD_SPAC:white sprite for box-only textdraws, TextDrawTextSize will have regular offsets.


Tips

Image:Light_bulb_icon.png

  • If you want to change the letter size of a textdraw that is already shown, you don't have to recreate it. Simply use TextDrawShowForPlayer/TextDrawShowForAll after modifying the textdraw and the change will be visible.
  • Fonts appear to look the best with an X to Y ratio of 1 to 4 (e.g. if x is 0.5 then y should be 2).


Related Functions

The following functions may be helpful as they relate to this function in one way or another.


Personal tools