GuiSetFont: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiSetFont ( element guiElement, string font )
bool guiSetFont ( element guiElement, mixed font )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===
===Required Arguments===
*'''guiElement:''' The GUI element you wish to change the font of
*'''guiElement:''' The GUI element you wish to change the font of
*'''font:''' The font name. See [[Standard GUI Font Names]]
*'''font:''' Either a custom [[GUI font]] element or the name of a built-in GUI font. See [[Standard GUI Font Names]]
{{New feature|3.0110|1.1|
*'''font:''' can also be a custom [[GUI font]] element created with [[guiCreateFont]].
}}
===Returns===
===Returns===
Returns ''true'' if the font has been successfully set on the gui element, ''false'' otherwise.
Returns ''true'' if the font has been successfully set on the gui element, ''false'' otherwise.

Revision as of 12:22, 1 September 2011

This function sets the font of a GUI element to be used when drawing text.

Syntax

bool guiSetFont ( element guiElement, mixed font )

Required Arguments

  • guiElement: The GUI element you wish to change the font of
  • font: Either a custom GUI font element or the name of a built-in GUI font. See Standard GUI Font Names

Returns

Returns true if the font has been successfully set on the gui element, false otherwise.

Example

This example sets and gets the font of a pre-made gui element and outputs it to chat box.

-- We create a dummy gui label to get text of
local dummyGUIElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
guiSetFont ( dummyGUIElement, "sa-gothic" )
-- Output the font of the label to chat box
outputChatBox ( "Font used in the GUI label: " .. guiGetFont ( dummyGuiElement ) )

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows