DgsGetSystemFont: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function gets the default dx font element in dgs. Successful font creation is not guaranteed, and may fail due to hardware or memory limita...")
 
(DGS OOP Syntax changing)
 
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This function gets the default dx font element in dgs.
This function gets the default dx font element in dgs.
Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.
'''This function will copy the font file into dgs folder and then load it'''


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsSetSystemFont ( string filepath [, int size=9, bool bold=false, string quality="proof" ] )
mixed dgsGetSystemFont ( )
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP|
    Method = '''dgsRootInstance''':getSystemFont|
    Counterpart = dgsSetSystemFont
}}


===Required Arguments===  
===Required Arguments===  
*'''filepath:''' the name of the file containing the font. Or built-in fonts are available:
None
**default
**default-bold
**clear
**arial
**sans
**pricedown
**bankgothic
**diploma
**beckett
 
===Optional Arguments===
*'''size:''' size of the font
*'''bold:''' flag to indicate if the font should be bold
*'''quality:''' the font quality
**"default": not the actual default
**"draft"
**"proof": the default
**"nonantialiased"
**"antialiased"
**"cleartype"
**"cleartype_natural"


===Returns===
===Returns===
Returns a true if successful, ''false'' otherwise.
Returns a string or an dx font element if successful, ''false'' otherwise.


==Example==  
==Example==  
Line 43: Line 22:
DGS = exports.dgs
DGS = exports.dgs


DGS:dgsSetSystemFont("example.ttf")
local font = DGS:dgsGetSystemFont()
outputChatBox(font) -- Default font is "default"
</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 22:23, 3 May 2021

This function gets the default dx font element in dgs.

Syntax

mixed dgsGetSystemFont ( )

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

Method: dgsRootInstance:getSystemFont(...)
Counterpart: dgsSetSystemFont

Required Arguments

None

Returns

Returns a string or an dx font element if successful, false otherwise.

Example

DGS = exports.dgs

local font = DGS:dgsGetSystemFont()
outputChatBox(font) -- Default font is "default"

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsGetSystemFont?oldid=71014"