DxGetTextWidth: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dxGetTextWidth ( string text, [float scale=1,string font="default"] )
float dxGetTextWidth ( string text, [float scale=1,string font="default"] )
</syntaxhighlight>
</syntaxhighlight>


Line 18: Line 18:


===Returns===
===Returns===
Returns a true if the operation was successful, false otherwise.  
Returns the float of the width of the text.  


==Example==  
==Example==  

Revision as of 19:25, 2 March 2008

This function retrieves the theoretical width of a certain piece of text, if it were to be drawn using dxDrawText.

Syntax

float dxGetTextWidth ( string text, [float scale=1,string font="default"] )

Required Arguments

  • text: A string representing the text for which you wish to retrieve with width for.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • scale: The size of the text.
  • font: The dx font for the text.
    • "default": Tahoma
    • "default-bold": Tahoma Bold
    • "clear": Verdana
    • "arial": Arial
    • "sans": Microsoft Sans Serif
    • "pricedown": Pricedown (GTA's theme text)
    • "bankgothic": Bank Gothic Medium
    • "diploma": Diploma Regular
    • "beckett": Beckett Regular
    • "unifont": Unifont

Returns

Returns the float of the width of the text.

Example

--TODO

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/DxGetTextWidth?oldid=16032"