DgsSetSystemFont: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function creates a dx font element that can be used in dgsSetFont. Successful font creation is not guaranteed, and may fail due to hard...")
 
(DGS OOP Syntax changing)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function creates a dx font element that can be used in [[dgsSetFont]].
This function creates a dx font element as default font stored in dgs.


Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.
Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.
Line 10: Line 10:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsSetSystemFont ( string filepath [, int size=9, bool bold=false, string quality="proof" ] )
element dgsSetSystemFont ( string filepath [, int size=9, bool bold=false, string quality="proof" ] )
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP|
    Method = '''dgsRootInstance''':setSystemFont|
    Counterpart = dgsGetSystemFont
}}


===Required Arguments===  
===Required Arguments===  
*'''filepath:''' the name of the file containing the font. Or built-in fonts are available:
*'''filepath:''' the name of the file containing the font. Or built-in fonts are available (see here [[Standard_DGS_Font_Names]]):
**default
**default
**default-bold
**default-bold
Line 41: Line 45:
==Example==  
==Example==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Display a dgs label
DGS = exports.dgs
local myLabel = dgsCreateLabel( 100, 300, 400, 50, "DGS label", false )
 
DGS:dgsSetSystemFont("example.ttf")
</syntaxhighlight>
 
 
<syntaxhighlight lang="lua">
DGS = exports.dgs


-- Use 'toggle' command to switch custom font on and off
DGS:dgsSetSystemFont("default-bold")
addCommandHandler( "toggle",
    function()
        if not myFont then
            myFont = dgsCreateFont( "segoeui.ttf", 20 )  -- Create DGS custom font
            dgsSetFont( myLabel, myFont )                -- Apply font to a widget
        else       
            destroyElement( myFont )                    -- Destroy custom font
            myFont = nil
        end
    end
)
</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:22, 3 May 2021

This function creates a dx font element as default font stored 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

element dgsSetSystemFont ( string filepath [, int size=9, bool bold=false, string quality="proof" ] )

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

Method: dgsRootInstance:setSystemFont(...)
Counterpart: dgsGetSystemFont

Required Arguments

  • filepath: the name of the file containing the font. Or built-in fonts are available (see here Standard_DGS_Font_Names):
    • 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 a true if successful, false otherwise.

Example

DGS = exports.dgs

DGS:dgsSetSystemFont("example.ttf")



DGS = exports.dgs

DGS:dgsSetSystemFont("default-bold")

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSetSystemFont?oldid=71013"