DxGetFontHeight: 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">
int dxGetFontHeight ( [float scale=1,string font="default"] )
int dxGetFontHeight ( [float scale=1, string font="default"] )
</syntaxhighlight>
</syntaxhighlight>


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


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


===Returns===
===Returns===

Revision as of 14:11, 5 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.
    • "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 an integer of the height of the text.

Example

--TODO

See Also