DxGetFontHeight: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}  
{{Client function}}  
This function retrieves the theoretical height of a certain piece of text, if it were to be drawn using [[dxDrawText]].


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
 
bool dxGetFontHeight ( [float scale=1,string font="default"] )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===  
===Required Arguments===  
'''None'''


==Optional Arguments==
{{OptionalArg}}
* '''scale:''' The size of the text
* '''font:''' The font of the text


===Returns===
===Returns===
 
Returns a true if the operation was successful, false otherwise.


==Example==  
==Example==  
Line 20: Line 26:
==See Also==
==See Also==
{{Drawing_functions}}
{{Drawing_functions}}
[[Category:Needs_Example]]

Revision as of 19:16, 2 March 2008

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

Syntax

bool 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 a true if the operation was successful, false otherwise.

Example

--TODO

See Also