DgsGetFont: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (DGS OOP Syntax changing)
 
(5 intermediate revisions by 3 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string/element dgsDxGUIGetFont ( element dgsElement )
string/element dgsGetFont ( element dgsElement )
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP|
    Method = DGSElement:getFont|
    Variable = font|
    Counterpart = dgsSetFont
}}


===Required Arguments===  
===Required Arguments===  
Line 20: Line 25:
DGS = exports.dgs
DGS = exports.dgs
-- We create a dummy dgs label to get text of
-- We create a dummy dgs label to get text of
local dummyGUIElement = DGS:dgsDxCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
local dummyGUIElement = DGS:dgsCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
DGS:dgsDxGUISetFont ( dummyGUIElement, "clear" )
DGS:dgsSetFont ( dummyGUIElement, "clear" )
-- Output the font of the label to chat box
-- Output the font of the label to chat box
outputChatBox ( "Font used in the GUI label: " .. DGS:dgsDxGUISetFont( dummyGuiElement ) )
outputChatBox ( "Font used in the GUI label: " .. DGS:dgsGetFont( dummyGuiElement ) )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
=See Also=
{{DGSFUNCTIONS}}
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
{{DGS General Functions}}
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
{{DGS Events/General}}

Latest revision as of 21:20, 3 May 2021

This function is used to get the current font that is used to draw text in DGS elements.

Syntax

string/element dgsGetFont ( element dgsElement )

DGS OOP Syntax Help! I don't understand this!

Method: DGSElement:getFont(...)
Variable: .font
Counterpart: dgsSetFont

Required Arguments

  • dgsElement: The DGS element you wish to get the font of.

Returns

  • string A string containing the name of the element's current font, or false if the dgs element passed to the function is invalid.
  • element The custom font that is used, or nil otherwise

Example

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

DGS = exports.dgs
-- We create a dummy dgs label to get text of
local dummyGUIElement = DGS:dgsCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
DGS:dgsSetFont ( dummyGUIElement, "clear" )
-- Output the font of the label to chat box
outputChatBox ( "Font used in the GUI label: " .. DGS:dgsGetFont( dummyGuiElement ) )

See Also

General Functions

General Events