DxGetFontHeight: Difference between revisions

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


Line 17: Line 17:


===Returns===
===Returns===
Returns a true if the operation was successful, false otherwise.
Returns an integer of the height of the text.


==Example==  
==Example==  

Revision as of 19:26, 2 March 2008

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

Syntax

int dxGetFontHeight ( [float scale=1,string font="default"] )

Required Arguments

None

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 font of the text

Returns

Returns an integer of the height of the text.

Example

--TODO

See Also