DgsGetFont: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (DGS OOP Syntax changing)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function is used to get the current font that is used to draw text in GUI elements.
This function is used to get the current font that is used to draw text in DGS elements.


==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 18: Line 23:
This example sets and gets the font of a pre-made dgs element and outputs it to chat box.
This example sets and gets the font of a pre-made dgs element and outputs it to chat box.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- We create a dummy gui label to get text of
DGS = exports.dgs
local dummyGUIElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
-- We create a dummy dgs label to get text of
guiSetFont ( dummyGUIElement, "sa-gothic" )
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
-- Output the font of the label to chat box
outputChatBox ( "Font used in the GUI label: " .. guiGetFont ( 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

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsGetFont?oldid=71001"